View Source Nostrum.Cache.MemberCache behaviour (Nostrum v0.10.0)

Cache behaviour & dispatcher for guild members.

You can call the functions provided by this module independent of which cache is configured, and it will dispatch to the configured cache implementation.

By default, Elixir.Nostrum.Cache.MemberCache.ETS will be used for caching members. You can override this in the :caches option of the :nostrum application by setting the :members field to a different module implementing the behaviour defined by this module.

The user-facing functions of this module can be called with a custom cache as the final argument. This is mainly useful if you want to test the cache: by default, nostrum will use Elixir.Nostrum.Cache.MemberCache.ETS.

Summary

Callbacks

bulk_create(id, members)

Bulk create multiple members in the cache from upstream data.

by_guild(id)

Yield an enumerable of members associated with the given guild ID.

by_user(id)

Yield an enumerable of {guild_id, member} pairs associated with the given user ID.

child_spec(term)

Retrieve the child specification for starting this mapping under a supervisor.

create(id, member)

Add the member for the given guild from upstream data.

delete(id, user_id)

Remove the given user for the given guild.

get(id, user_id)

Retrieve a member from the cache by guild and user ID.

update(id, member)

Update the given member for the given guild from upstream data.

wrap_query(function)

A function that should wrap any long-running query operations.

Functions

by_guild(guild_id)

See Nostrum.Cache.MemberCache.ETS.by_guild/1.

by_user(user_id)

See Nostrum.Cache.MemberCache.ETS.by_user/1.

fold(acc, guild_id, member_reducer, cache \\ Nostrum.Cache.MemberCache.ETS)

Fold (reduce) over members for the given guild ID.

fold_by_user(acc, user_id, member_reducer, cache \\ Nostrum.Cache.MemberCache.ETS)

Reduce over all members cached for the given user ID.

fold_with_users(acc, guild_id, fun, cache \\ Nostrum.Cache.MemberCache.ETS)

Calls fun on each member and its user on the given guild ID, with the given accumulator.

get(guild_id, member_id)

Get a single member on the given guild ID.

get_with_user(guild_id, member_id, cache \\ Nostrum.Cache.MemberCache.ETS)

Return a member together with its user via the user cache.

wrap_query(cache \\ Nostrum.Cache.MemberCache.ETS, fun)

Call wrap_query/1 on the given cache, if implemented.

Callbacks

bulk_create(id, members)

(since 0.7.0)

@callback bulk_create(Nostrum.Struct.Guild.id(), members :: [member :: map()]) :: true

Bulk create multiple members in the cache from upstream data.

Return value is unused, as we currently do not dispatch a gateway for this.

by_guild(id)

(since 0.10.0)

@callback by_guild(Nostrum.Struct.Guild.id()) ::
  Enumerable.t(Nostrum.Struct.Guild.Member.t())

Yield an enumerable of members associated with the given guild ID.

by_user(id)

(since 0.10.0)

@callback by_user(Nostrum.Struct.User.id()) ::
  Enumerable.t({Nostrum.Struct.Guild.id(), Nostrum.Struct.Guild.Member.t()})

Yield an enumerable of {guild_id, member} pairs associated with the given user ID.

Since nostrum does not know when it can stop streaming you results, you have to wrap calls to this function in wrap_query/1.

child_spec(term)

(since 0.7.0)

@callback child_spec(term()) :: Supervisor.child_spec()

Retrieve the child specification for starting this mapping under a supervisor.

create(id, member)

(since 0.7.0)

@callback create(Nostrum.Struct.Guild.id(), member :: map()) ::
  Nostrum.Struct.Guild.Member.t()

Add the member for the given guild from upstream data.

Return the casted member structure.

delete(id, user_id)

(since 0.7.0)

@callback delete(Nostrum.Struct.Guild.id(), Nostrum.Struct.Guild.Member.user_id()) ::
  {Nostrum.Struct.Guild.id(), old_member :: Nostrum.Struct.Guild.Member.t()}
  | :noop

Remove the given user for the given guild.

Return the guild ID and old member if the member was cached. Otherwise, return :noop.

get(id, user_id)

(since 0.10.0)

@callback get(Nostrum.Struct.Guild.id(), Nostrum.Struct.Guild.Member.user_id()) ::
  {:ok, Nostrum.Struct.Guild.Member.t()} | {:error, atom()}

Retrieve a member from the cache by guild and user ID.

update(id, member)

(since 0.7.0)

@callback update(Nostrum.Struct.Guild.id(), member :: map()) ::
  {Nostrum.Struct.Guild.id(),
   old_member :: Nostrum.Struct.Guild.Member.t() | nil,
   updated_member :: Nostrum.Struct.Guild.Member.t()}

Update the given member for the given guild from upstream data.

Return the guild ID that was updated, the old cached member (if the member was known to the cache), and the updated member.

Note regarding intents

Even if the required intents to receive GUILD_MEMBER_UPDATE events are disabled to a point where we do not receive guild creation events, it is still possible to receive the event for our own user. An example of this can be found in issue #293. Note that the issue predates the modern nostrum caching infrastructure.

wrap_query(function)

(optional) (since 0.10.0)

@callback wrap_query((-> result)) :: result when result: term()

A function that should wrap any long-running query operations.

If you implement a cache that is backed by a database and want to perform cleanup and teardown actions such as opening and closing connections, managing transactions and so on, you want to implement this function. nostrum will then effectively call wrap_query(fn -> ... end).

If your cache does not need any wrapping, you can omit this.

Functions

by_guild(guild_id)

(since 0.7.0)

See Nostrum.Cache.MemberCache.ETS.by_guild/1.

by_user(user_id)

(since 0.7.0)

See Nostrum.Cache.MemberCache.ETS.by_user/1.

fold(acc, guild_id, member_reducer, cache \\ Nostrum.Cache.MemberCache.ETS)

(since 0.8.0)

@spec fold(
  acc,
  Nostrum.Struct.Guild.id(),
  (Nostrum.Struct.Guild.Member.t(), acc -> acc),
  module()
) ::
  acc
when acc: term()

Fold (reduce) over members for the given guild ID.

Parameters

acc: The initial accumulator. Also returned if no guild members were found.
guild_id: The guild for which to reduce members.
member_reducer: Called for every element in the result. Takes a pair in the form (member, acc), and must return the updated accumulator.

Return value

Returns the resulting accumulator via fun. Returns acc unchanged if no results were found.

Raises

Fails when by_guild/1 of the selected cache returns an error.

fold_by_user(acc, user_id, member_reducer, cache \\ Nostrum.Cache.MemberCache.ETS)

(since 0.8.0)

@spec fold_by_user(
  acc,
  Nostrum.Struct.Guild.Member.user_id(),
  ({Nostrum.Struct.Guild.id(), Nostrum.Struct.Guild.Member.t()}, acc -> acc),
  module()
) :: acc
when acc: term()

Reduce over all members cached for the given user ID.

The members will be returned alongside their guild ID as a pair in the format {guild_id, member}.

Raises

Fails when by_user/1 of the selected cache returns an error.

fold_with_users(acc, guild_id, fun, cache \\ Nostrum.Cache.MemberCache.ETS)

(since 0.8.0)

@spec fold_with_users(
  acc,
  Nostrum.Struct.Guild.id(),
  ({Nostrum.Struct.Guild.Member.t(), Nostrum.Struct.User.t()}, acc -> acc),
  module()
) :: acc
when acc: term()

Calls fun on each member and its user on the given guild ID, with the given accumulator.

Parameters

acc (term()): The initial accumulator. Also returned if no guild members were found.
guild_id (Nostrum.Struct.Guild.id/0): The guild for which to reduce members.
fun (function()): Called for every element in the result. Takes a pair in the form ({member, user}, acc), and must return the updated accumulator.

Return value

Returns the resulting accumulator via fun. Returns acc unchanged if no results were found.

If the user for a guild member is not found, the member and user won't be present in the result. Barring a bug in nostrum's caching, this should never happen in practice.

Raises

Fails when by_guild/1 of the selected cache returns an error.

get(guild_id, member_id)

(since 0.7.0)

@spec get(Nostrum.Struct.Guild.id(), Nostrum.Struct.Guild.Member.user_id()) ::
  {:ok, Nostrum.Struct.Guild.Member.t()} | {:error, atom()}

Get a single member on the given guild ID.

get_with_user(guild_id, member_id, cache \\ Nostrum.Cache.MemberCache.ETS)

(since 0.7.0)

@spec get_with_user(
  Nostrum.Struct.Guild.id(),
  Nostrum.Struct.Guild.Member.user_id(),
  module()
) ::
  {Nostrum.Struct.Guild.Member.t(), Nostrum.Struct.User.t() | nil} | nil

Return a member together with its user via the user cache.

wrap_query(cache \\ Nostrum.Cache.MemberCache.ETS, fun)

(since 0.10.0)

@spec wrap_query(module(), (-> result)) :: result when result: term()

Call wrap_query/1 on the given cache, if implemented.

If no cache is given, calls out to the default cache.