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

Maintains a mapping of guild IDs to their shard numbers 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 table/0. Use Nostrum.Store.GuildShardMapping to call the configured mapping instead.

Summary

Returns a specification to start this module under a supervisor.

Create a new mapping for the given guild ID to the given shard ID.

delete(guild_id)

Delete any stored mapping for the given guild ID.

get(guild_id)

Get the shard number for the given guild ID.

init(opts)

Set up the store's ETS table.

start_link(opts)

Start the supervisor.

table()

Retrieve the ETS table reference used for the store.

(since 0.8.0)

Returns a specification to start this module under a supervisor.

(since 0.8.0)

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

Create a new mapping for the given guild ID to the given shard ID.

(since 0.8.0)

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

Delete any stored mapping for the given guild ID.

(since 0.8.0)

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

Get the shard number for the given guild ID.

(since 0.8.0)

Set up the store's ETS table.

(since 0.8.0)

Start the supervisor.

(since 0.8.0)

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

Retrieve the ETS table reference used for the store.