Struct InMemoryCacheStats

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

Retrieve statistics about the number of entities of each resource in the cache.

Statistics can be retrieved about the amount of resources on a cache-level via a method such as users or in a particular channel via a method such as channel_messages.

Examples

Retrieve the number of users stored in the cache:

use twilight_cache_inmemory::DefaultInMemoryCache;

let cache = DefaultInMemoryCache::new();

// later on...
println!("user count: {}", cache.stats().users());

Implementations

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

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

Return an immutable reference to the underlying cache.

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

Consume the statistics interface, returning the underlying cache reference.

pub fn channels(&self) -> usize

Number of channels in the cache.

pub fn channel_messages(&self, channel_id: Id<ChannelMarker>) -> Option<usize>

Number of messages in a given channel in the cache.

Returns None if the channel hasn’t yet been cached or there are no messages in the channel. However, the provided number may still be 0 if some number is returned.

pub fn channel_voice_states( &self, channel_id: Id<ChannelMarker>, ) -> Option<usize>

Number of voice states in a given channel in the cache.

Returns None if the channel hasn’t yet been cached or there are no voice states in the channel. However, the provided number may still be 0 if some number is returned.

pub fn emojis(&self) -> usize

Number of emojis in the cache.

pub fn guilds(&self) -> usize

Number of guilds in the cache.

pub fn guild_channels(&self, guild_id: Id<GuildMarker>) -> Option<usize>

Number of channels in a given guild in the cache.

Returns None if the guild hasn’t yet been cached.

pub fn guild_emojis(&self, guild_id: Id<GuildMarker>) -> Option<usize>

Number of emojis in a given guild in the cache.

Returns None if the guild hasn’t yet been cached.

pub fn guild_members(&self, guild_id: Id<GuildMarker>) -> Option<usize>

Number of members in a given guild in the cache.

Returns None if the guild hasn’t yet been cached.

pub fn guild_presences(&self, guild_id: Id<GuildMarker>) -> Option<usize>

Number of presences in a given guild in the cache.

Returns None if the guild hasn’t yet been cached.

pub fn guild_roles(&self, guild_id: Id<GuildMarker>) -> Option<usize>

Number of roles in a given guild in the cache.

Returns None if the guild hasn’t yet been cached.

pub fn guild_voice_states(&self, guild_id: Id<GuildMarker>) -> Option<usize>

Number of voice states in a given guild in the cache.

Returns None if the guild hasn’t yet been cached.

pub fn members(&self) -> usize

Number of members in the cache.

pub fn presences(&self) -> usize

Number of presences in the cache.

pub fn roles(&self) -> usize

Number of roles in the cache.

pub fn unavailable_guilds(&self) -> usize

Number of unavailable guilds in the cache.

pub fn users(&self) -> usize

Number of users in the cache.

pub fn voice_states(&self) -> usize

Number of voice states in the cache.

Trait Implementations

impl<'a, CacheModels: Clone + CacheableModels> Clone for InMemoryCacheStats<'a, CacheModels>

fn clone(&self) -> InMemoryCacheStats<'a, CacheModels>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.