Nostrum.Cache.UserCache.ETS (nostrum v0.11.0-dev)

An ETS-based cache for users.

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

Summary

Bulk create a list of users from upstream data.

Returns a specification to start this module under a supervisor.

create(payload)

Create a user from upstream data.

get(id)

Retrieve a user from the cache.

init(opts)

Set up the ETS table.

start_link(opts)

Start the supervisor.

table()

Retrieve the ETS table reference used for the cache.

update(info)

Update a user from upstream data.

(since 0.5.0)

@spec bulk_create(Enum.t()) :: :ok

Bulk create a list of users from upstream data.

(since 0.5.0)

Returns a specification to start this module under a supervisor.

(since 0.5.0)

@spec create(map()) :: Nostrum.Struct.User.t()

Create a user from upstream data.

(since 0.5.0)

@spec get(Nostrum.Struct.User.id()) ::
  {:ok, Nostrum.Struct.User.t()} | {:error, :user_not_found}

Retrieve a user from the cache.

(since 0.5.0)

Set up the 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.User.t() | nil, Nostrum.Struct.User.t()}

Update a user from upstream data.