Struct InMemoryCacheIter

pub struct InMemoryCacheIter<'a, CacheModels: CacheableModels>(/* private fields */);

Interface to create iterators over various resources.

The created iterators will iterate over all entities of a resource across all channels and guilds.

The iteration order of all iterators are arbitrary.

Examples

Count the number of users in the cache whose username begins with “twi”:

use twilight_cache_inmemory::DefaultInMemoryCache;

let cache = DefaultInMemoryCache::new();

// later in the application...
let count = cache
    .iter()
    .users()
    .filter(|user| user.name.starts_with("twi"))
    .count();

println!("'twi' users: {count}");

Potential inefficiency

Resource iterators over the entire cache are inefficient when the goal is to iterate over a resource in a specific guild. For example, when performing a task such as iterating over the members of a specific guild, retrieving the list of members via InMemoryCache::guild_members and then calling InMemoryCache::member for each item is more efficient. That might look like:

use twilight_cache_inmemory::DefaultInMemoryCache;
use twilight_model::id::Id;

let cache = DefaultInMemoryCache::new();

// later in the application...
let guild_id = Id::new(1);
let maybe_guild_members = cache.guild_members(guild_id);

if let Some(guild_members) = maybe_guild_members {
    for user_id in guild_members.iter() {
        if let Some(member) = cache.member(guild_id, *user_id) {
            println!(
                "member id {}'s nickname: {:?}",
                member.user_id(),
                member.nick(),
            );
        }
    }
}

Implementations

impl<'a, CacheModels: CacheableModels> InMemoryCacheIter<'a, CacheModels>

pub const fn cache_ref(&'a self) -> &'a InMemoryCache<CacheModels>

Immutable reference to the underlying cache.

pub fn channels( &self, ) -> ResourceIter<'a, Id<ChannelMarker>, CacheModels::Channel>

Create an iterator over the channels in the cache.

pub fn emojis( &self, ) -> ResourceIter<'a, Id<EmojiMarker>, GuildResource<CacheModels::Emoji>>

Create an iterator over the emojis in the cache.

pub fn guilds(&self) -> ResourceIter<'a, Id<GuildMarker>, CacheModels::Guild>

Create an iterator over the guilds in the cache.

pub fn integrations( &self, ) -> ResourceIter<'a, (Id<GuildMarker>, Id<IntegrationMarker>), GuildResource<CacheModels::GuildIntegration>>

Create an iterator over the integrations in the cache.

pub fn members( &self, ) -> ResourceIter<'a, (Id<GuildMarker>, Id<UserMarker>), CacheModels::Member>

Create an iterator over the members across all guilds in the cache.

pub fn messages( &self, ) -> ResourceIter<'a, Id<MessageMarker>, CacheModels::Message>

Create an iterator over the messages in the cache.

pub fn presences( &self, ) -> ResourceIter<'a, (Id<GuildMarker>, Id<UserMarker>), CacheModels::Presence>

Create an iterator over the presences in the cache.

pub fn roles( &self, ) -> ResourceIter<'a, Id<RoleMarker>, GuildResource<CacheModels::Role>>

Create an iterator over the roles in the cache.

pub fn stage_instances( &self, ) -> ResourceIter<'a, Id<StageMarker>, GuildResource<CacheModels::StageInstance>>

Create an iterator over the stage instances in the cache.

pub fn stickers( &self, ) -> ResourceIter<'a, Id<StickerMarker>, GuildResource<CacheModels::Sticker>>

Create an iterator over the stickers in the cache.

pub fn users(&self) -> ResourceIter<'a, Id<UserMarker>, CacheModels::User>

Create an iterator over the users in the cache.

pub fn voice_states( &self, ) -> ResourceIter<'a, (Id<GuildMarker>, Id<UserMarker>), CacheModels::VoiceState>

Create an iterator over the voice states in the cache.

Trait Implementations

impl<'a, CacheModels: Debug + CacheableModels> Debug for InMemoryCacheIter<'a, CacheModels>

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

Formats the value using the given formatter.