View Source Nostrum.Store.UnavailableGuild.Mnesia (Nostrum v0.10.0)

Keeps track of unavailable guilds.

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(guild_id)

Create the given guild as an unavailable guild.

init(init_arg)

Set up the store's Mnesia table.

is?(guild_id)

Return whether the given guild is unavailable.

start_link(init_arg)

Start the supervisor.

table()

Retrieve the Mnesia table name used for the store.

teardown()

Drop the table used for the store.

Functions

child_spec(init_arg)

(since 0.8.0)

Returns a specification to start this module under a supervisor.

See Supervisor.

create(guild_id)

(since 0.8.0)

@spec create(Nostrum.Struct.Guild.id()) :: :ok

Create the given guild as an unavailable guild.

init(init_arg)

(since 0.8.0)

Set up the store's Mnesia table.

is?(guild_id)

(since 0.8.0)

@spec is?(Nostrum.Struct.Guild.id()) :: boolean()

Return whether the given guild is unavailable.

start_link(init_arg)

(since 0.8.0)

Start the supervisor.

table()

(since 0.8.0)

@spec table() :: atom()

Retrieve the Mnesia table name used for the store.

teardown()

(since 0.8.0)

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

Drop the table used for the store.