Nostrum.Store.UnavailableGuild.ETS (nostrum v0.11.0-dev)

View Source

Stores guilds that are currently unavailable using :ets.

If programmatic access to the ETS table is needed, please use the table/0 function.

Please do not use this module directly, apart from special functions such as tabname/0. Use Nostrum.Store.UnavailableGuild to call the configured mapping instead.

Summary

Functions

Returns a specification to start this module under a supervisor.

Create the given guild as an unavailable guild.

Set up the store's ETS table.

Return whether the given guild is unavailable.

Start the supervisor.

Retrieve the ETS table reference 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(opts)

(since 0.8.0)

Set up the store's ETS table.

is?(guild_id)

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

Return whether the given guild is unavailable.

start_link(opts)

(since 0.8.0)

Start the supervisor.

table()

(since 0.8.0)
@spec table() :: :ets.table()

Retrieve the ETS table reference used for the store.