Struct twilight_cache_inmemory::InMemoryCache

pub struct InMemoryCache { /* fields omitted */ }

An in-memory cache of Discord data.

This is an implementation of a cache designed to be used by only the current process.

Events will only be processed if they are properly expressed with Intents; refer to function-level documentation for more details.

Using the cache in multiple tasks

To use a cache instance in multiple tasks, consider wrapping it in an std::sync::Arc or std::rc::Rc.

Caution required

The cache uses a concurrent map for mutability of cached resources. Return types of methods are immutable references to those resources. If a resource is retrieved from the cache then care must be taken to only hold it for as long as necessary. If the cache needs to mutate a resource to update it and a reference to it is being held then calls to InMemoryCache::update may be blocked.

In order to avoid blocking of cache updates care must be taken to hold them for as little as possible. For example, consider dropping references during long-running tasks such as HTTP requests. Processing HTTP requests takes milliseconds to seconds; retrieving a new reference to a resource is on the scale of nanoseconds. If only a couple of small fields are necessary from a reference consider copying or cloning them.

Implementations

impl InMemoryCache

Implemented methods and types for the cache.

pub fn new() -> Self

Creates a new, empty cache.

Examples

Creating a new InMemoryCache with a custom configuration, limiting the message cache to 50 messages per channel:

use twilight_cache_inmemory::InMemoryCache;

let cache = InMemoryCache::builder().message_cache_size(50).build();

pub const fn builder() -> InMemoryCacheBuilder

Create a new builder to configure and construct an in-memory cache.

pub fn clear(&self)

Clear the state of the Cache.

This is equal to creating a new empty cache.

pub const fn config(&self) -> &Config

Returns a copy of the config cache.

pub const fn iter(&self) -> InMemoryCacheIter<'_>

Create an interface for iterating over the various resources in the cache.

Via the iterator interface many resource types can be iterated over including, but not limited to, emojis, guilds, presences, and users.

Examples

Iterate over every guild in the cache and print their IDs and names:

use twilight_cache_inmemory::InMemoryCache;

let cache = InMemoryCache::new();

// later in the application...
for guild in cache.iter().guilds() {
    println!("{}: {}", guild.id(), guild.name());
}

pub const fn stats(&self) -> InMemoryCacheStats<'_>

Create an interface for retrieving statistics about the cache.

Examples

Print the number of guilds in a cache:

use twilight_cache_inmemory::InMemoryCache;

let cache = InMemoryCache::new();

// later on...
let guilds = cache.stats().guilds();
println!("guild count: {}", guilds);

pub const fn permissions(&self) -> InMemoryCachePermissions<'_>

This is supported on crate feature permission-calculator only.

Create an interface for retrieving the permissions of a member in a guild or channel.

ResourceTypes must be configured for the permission interface to properly work; refer to the permission module-level documentation for more information.

Examples

Calculate the permissions of a member in a guild channel:

use twilight_cache_inmemory::{InMemoryCache, ResourceType};
use twilight_model::id::{ChannelId, UserId};

let resource_types = ResourceType::CHANNEL
    | ResourceType::MEMBER
    | ResourceType::ROLE;

let cache = InMemoryCache::builder()
    .resource_types(resource_types)
    .build();

let channel_id = ChannelId::new(4).expect("non zero");
let user_id = UserId::new(5).expect("non zero");

let permissions = cache.permissions().in_channel(user_id, channel_id)?;
println!("member has these permissions: {:?}", permissions);

pub fn update(&self, value: &impl UpdateCache)

Update the cache with an event from the gateway.

pub fn current_user(&self) -> Option<CurrentUser>

Gets the current user.

pub fn channel_messages(
    &self,
    channel_id: ChannelId
) -> Option<ChannelMessages<'_>>

Gets the set of messages in a channel.

This requires the DIRECT_MESSAGES or GUILD_MESSAGES intents.

Returns None if the channel is not cached.

Examples

Refer to ChannelMessages.

pub fn emoji(
    &self,
    emoji_id: EmojiId
) -> Option<Reference<'_, EmojiId, GuildResource<CachedEmoji>>>

Gets an emoji by ID.

This requires the GUILD_EMOJIS intent.

pub fn group(
    &self,
    channel_id: ChannelId
) -> Option<Reference<'_, ChannelId, Group>>

Gets a group by ID.

pub fn guild(
    &self,
    guild_id: GuildId
) -> Option<Reference<'_, GuildId, CachedGuild>>

Gets a guild by ID.

This requires the GUILDS intent.

pub fn guild_channel(
    &self,
    channel_id: ChannelId
) -> Option<Reference<'_, ChannelId, GuildResource<GuildChannel>>>

Gets a channel by ID.

This requires the GUILDS intent.

pub fn guild_channels(
    &self,
    guild_id: GuildId
) -> Option<Reference<'_, GuildId, HashSet<ChannelId>>>

Gets the set of channels in a guild.

This requires the GUILDS intent.

pub fn guild_emojis(
    &self,
    guild_id: GuildId
) -> Option<Reference<'_, GuildId, HashSet<EmojiId>>>

Gets the set of emojis in a guild.

This requires both the GUILDS and GUILD_EMOJIS intents.

pub fn guild_integrations(
    &self,
    guild_id: GuildId
) -> Option<Reference<'_, GuildId, HashSet<IntegrationId>>>

Gets the set of integrations in a guild.

This requires the GUILD_INTEGRATIONS intent. The ResourceType::INTEGRATION resource type must be enabled.

pub fn guild_members(
    &self,
    guild_id: GuildId
) -> Option<Reference<'_, GuildId, HashSet<UserId>>>

Gets the set of members in a guild.

This list may be incomplete if not all members have been cached.

This requires the GUILD_MEMBERS intent.

pub fn guild_presences(
    &self,
    guild_id: GuildId
) -> Option<Reference<'_, GuildId, HashSet<UserId>>>

Gets the set of presences in a guild.

This list may be incomplete if not all members have been cached.

This requires the GUILD_PRESENCES intent.

pub fn guild_roles(
    &self,
    guild_id: GuildId
) -> Option<Reference<'_, GuildId, HashSet<RoleId>>>

Gets the set of roles in a guild.

This requires the GUILDS intent.

pub fn guild_stage_instances(
    &self,
    guild_id: GuildId
) -> Option<Reference<'_, GuildId, HashSet<StageId>>>

Gets the set of stage instances in a guild.

This requires the GUILDS intent.

pub fn guild_stickers(
    &self,
    guild_id: GuildId
) -> Option<Reference<'_, GuildId, HashSet<StickerId>>>

Gets the set of the stickers in a guild.

This is an O(m) operation, where m is the amount of stickers in the guild. This requires the GUILDS intent and the STICKER resource type.

pub fn integration(
    &self,
    guild_id: GuildId,
    integration_id: IntegrationId
) -> Option<Reference<'_, (GuildId, IntegrationId), GuildResource<GuildIntegration>>>

Gets an integration by guild ID and integration ID.

This requires the GUILD_INTEGRATIONS intent. The ResourceType::INTEGRATION resource type must be enabled.

pub fn member(
    &self,
    guild_id: GuildId,
    user_id: UserId
) -> Option<Reference<'_, (GuildId, UserId), CachedMember>>

Gets a member by guild ID and user ID.

This requires the GUILD_MEMBERS intent.

pub fn message(
    &self,
    message_id: MessageId
) -> Option<Reference<'_, MessageId, CachedMessage>>

Gets a message by ID.

This requires one or both of the GUILD_MESSAGES or DIRECT_MESSAGES intents.

pub fn presence(
    &self,
    guild_id: GuildId,
    user_id: UserId
) -> Option<Reference<'_, (GuildId, UserId), CachedPresence>>

Gets a presence by, optionally, guild ID, and user ID.

This requires the GUILD_PRESENCES intent.

pub fn private_channel(
    &self,
    channel_id: ChannelId
) -> Option<Reference<'_, ChannelId, PrivateChannel>>

Gets a private channel by ID.

This requires the DIRECT_MESSAGES intent.

pub fn role(
    &self,
    role_id: RoleId
) -> Option<Reference<'_, RoleId, GuildResource<Role>>>

Gets a role by ID.

This requires the GUILDS intent.

pub fn stage_instance(
    &self,
    stage_id: StageId
) -> Option<Reference<'_, StageId, GuildResource<StageInstance>>>

Gets a stage instance by ID.

This requires the GUILDS intent.

pub fn sticker(
    &self,
    sticker_id: StickerId
) -> Option<Reference<'_, StickerId, GuildResource<CachedSticker>>>

Gets a sticker by ID.

This is the O(1) operation. This requires the GUILDS intent and the STICKER resource type.

pub fn user(&self, user_id: UserId) -> Option<Reference<'_, UserId, User>>

Gets a user by ID.

This requires the GUILD_MEMBERS intent.

pub fn voice_channel_states(
    &self,
    channel_id: ChannelId
) -> Option<VoiceChannelStates<'_>>

Gets the voice states within a voice channel.

This requires both the GUILDS and GUILD_VOICE_STATES intents.

pub fn voice_state(
    &self,
    user_id: UserId,
    guild_id: GuildId
) -> Option<Reference<'_, (GuildId, UserId), VoiceState>>

Gets a voice state by user ID and Guild ID.

This requires both the GUILDS and GUILD_VOICE_STATES intents.

pub fn member_highest_role(
    &self,
    guild_id: GuildId,
    user_id: UserId
) -> Option<RoleId>

Gets the highest role of a member.

This requires both the GUILDS and GUILD_MEMBERS intents.

Trait Implementations

impl Debug for InMemoryCache

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for InMemoryCache

fn default() -> InMemoryCache

Returns the “default value” for a type.