Nostrum

View Source Nostrum.Cache.MemberCache.ETS (Nostrum v0.8.0)

An ETS-based cache for members.

If you need to get the table reference for the table used by this module, please use the table/0 function.

Link to this section Summary

Functions

bulk_create(guild_id, members)

Bulk create a chunk of members for the given guild in the cache.

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

clear()

Clear any objects in the cache.

create(guild_id, payload)

Add the given member to the given guild in the cache.

delete(guild_id, user_id)

Remove the given member from the given guild in the cache.

init(init_arg)

Set up the cache's ETS table.

query_handle()

Get a QLC query handle for the member cache.

start_link(init_arg)

Start the supervisor.

table()

Retrieve the ETS table reference used for the cache.

update(guild_id, payload)

Update the given member for the given guild in the cache.

wrap_qlc(fun)

Wrap QLC operations.

Link to this section Functions

Link to this function

bulk_create(guild_id, members)

View Source (since 0.7.0)

Bulk create a chunk of members for the given guild in the cache.

Link to this function

child_spec(init_arg)

View Source (since 0.7.0)

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

clear()

View Source (since 0.8.0) 
@spec clear() :: :ok

Clear any objects in the cache.

Link to this function

create(guild_id, payload)

View Source (since 0.7.0) 
@spec create(Nostrum.Struct.Guild.id(), map()) :: Nostrum.Struct.Guild.Member.t()

Add the given member to the given guild in the cache.

Link to this function

delete(guild_id, user_id)

View Source (since 0.7.0) 
@spec delete(Nostrum.Struct.Guild.id(), Nostrum.Struct.Guild.Member.user_id()) ::
  {Nostrum.Struct.Guild.id(), Nostrum.Struct.Guild.Member.t()} | :noop

Remove the given member from the given guild in the cache.

Link to this function

init(init_arg)

View Source (since 0.7.0)

Set up the cache's ETS table.

Link to this function

query_handle()

View Source (since 0.7.0) 
@spec query_handle() :: :qlc.query_handle()

Get a QLC query handle for the member cache.

Link to this function

start_link(init_arg)

View Source (since 0.7.0)

Start the supervisor.

Link to this function

table()

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

Retrieve the ETS table reference used for the cache.

Link to this function

update(guild_id, payload)

View Source (since 0.7.0) 
@spec update(Nostrum.Struct.Guild.id(), map()) ::
  {Nostrum.Struct.Guild.id(), Nostrum.Struct.Guild.Member.t() | nil,
   Nostrum.Struct.Guild.Member.t()}

Update the given member for the given guild in the cache.

Link to this function

wrap_qlc(fun)

View Source (since 0.8.0) 
@spec wrap_qlc((() -> qlc_result)) :: qlc_result when qlc_result: term()

Wrap QLC operations.

safety

 Safety

Any QLC operations are surrounded by :ets.safe_fixtable. It is therefore recommended to finish your read quickly.