View Source Nostrum.Cache.PresenceCache.ETS (Nostrum v0.10.0)

ETS-based cache for user presences.

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

Summary

Bulk create multiple presences in the cache.

Returns a specification to start this module under a supervisor.

create(presence)

Add the given presence data to the cache.

Retrieve a presence from the cache.

init(init_arg)

Set up the cache's ETS table.

Start the supervisor.

table()

Retrieve the ETS table reference used for the cache.

update(new)

Update the given presence data in the cache.

(since 0.5.0)

@spec bulk_create(Nostrum.Struct.Guild.id(), [map()]) :: :ok

Bulk create multiple presences in the cache.

(since 0.5.0)

Returns a specification to start this module under a supervisor.

(since 0.5.0)

@spec create(map()) :: :ok

Add the given presence data to the cache.

(since 0.5.0)

@spec get(Nostrum.Struct.Guild.id(), Nostrum.Struct.User.id()) ::
  {:ok, Nostrum.Cache.PresenceCache.presence()} | {:error, any()}

Retrieve a presence from the cache.

(since 0.5.0)

Set up the cache's ETS table.

(since 0.5.0)

Start the supervisor.

(since 0.8.0)

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

Retrieve the ETS table reference used for the cache.

(since 0.5.0)

@spec update(map()) :: {Nostrum.Struct.Guild.id(), presence | nil, presence} | :noop
when presence: Nostrum.Cache.PresenceCache.presence()

Update the given presence data in the cache.