Nostrum.Cache.ChannelGuildMapping.Mnesia (nostrum v0.11.0-dev)

An Mnesia-based mapping between channel and guild IDs.

Please note that this module is only compiled if Mnesia is available on your system. See the Mnesia section of the State documentation for more information.

To retrieve the table name used by this cache, use table/0.

Summary

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

create(channel_id, guild_id)

Create a mapping of the given channel to the given guild.

delete(channel_id)

Remove any mapping associated with the given channel.

get(channel_id)

Retrieve the guild ID for the given channel ID, if present.

init(opts)

Set up the ETS table.

start_link(opts)

Start the supervisor.

table()

Retrieve the table used by this module.

teardown()

Drop the table used for caching.

Functions

child_spec(init_arg)

(since 0.8.0)

Returns a specification to start this module under a supervisor.

See Supervisor.

create(channel_id, guild_id)

(since 0.8.0)

@spec create(Nostrum.Struct.Channel.id(), Nostrum.Struct.Guild.id()) :: true

Create a mapping of the given channel to the given guild.

delete(channel_id)

(since 0.8.0)

@spec delete(Nostrum.Struct.Channel.id()) :: true

Remove any mapping associated with the given channel.

get(channel_id)

(since 0.8.0)

@spec get(Nostrum.Struct.Channel.id()) :: Nostrum.Struct.Guild.id() | nil

Retrieve the guild ID for the given channel ID, if present.

init(opts)

(since 0.8.0)

Set up the ETS table.

start_link(opts)

(since 0.8.0)

Start the supervisor.

table()

(since 0.8.0)

@spec table() :: atom()

Retrieve the table used by this module.

teardown()

(since 0.8.0)

@spec teardown() :: {:atomic, :ok} | {:aborted, term()}

Drop the table used for caching.