twilight_cache_inmemory/
stats.rs

1use twilight_model::id::{
2    marker::{ChannelMarker, GuildMarker},
3    Id,
4};
5
6use crate::{CacheableModels, DefaultCacheModels};
7
8use super::InMemoryCache;
9
10/// Retrieve statistics about the number of entities of each resource in the
11/// cache.
12///
13/// Statistics can be retrieved about the amount of resources on a cache-level
14/// via a method such as [`users`] or in a particular channel via a method
15/// such as [`channel_messages`].
16///
17/// # Examples
18///
19/// Retrieve the number of users stored in the cache:
20///
21/// ```no_run
22/// use twilight_cache_inmemory::DefaultInMemoryCache;
23///
24/// let cache = DefaultInMemoryCache::new();
25///
26/// // later on...
27/// println!("user count: {}", cache.stats().users());
28/// ```
29///
30/// [`channel_messages`]: Self::channel_messages
31/// [`users`]: Self::users
32#[allow(clippy::type_complexity)]
33#[derive(Clone, Debug)]
34pub struct InMemoryCacheStats<'a, CacheModels: CacheableModels = DefaultCacheModels>(
35    &'a InMemoryCache<CacheModels>,
36);
37
38impl<'a, CacheModels: CacheableModels> InMemoryCacheStats<'a, CacheModels> {
39    #[allow(clippy::type_complexity)]
40    pub(super) const fn new(cache: &'a InMemoryCache<CacheModels>) -> Self {
41        Self(cache)
42    }
43
44    /// Return an immutable reference to the underlying cache.
45    #[allow(clippy::type_complexity)]
46    pub const fn cache_ref(&'a self) -> &'a InMemoryCache<CacheModels> {
47        self.0
48    }
49
50    /// Consume the statistics interface, returning the underlying cache
51    /// reference.
52    #[allow(clippy::type_complexity)]
53    pub const fn into_cache(self) -> &'a InMemoryCache<CacheModels> {
54        self.0
55    }
56
57    /// Number of channels in the cache.
58    pub fn channels(&self) -> usize {
59        self.0.channels.len()
60    }
61
62    /// Number of messages in a given channel in the cache.
63    ///
64    /// Returns `None` if the channel hasn't yet been cached or there are no
65    /// messages in the channel. However, the provided number may still be 0
66    /// if some number is returned.
67    pub fn channel_messages(&self, channel_id: Id<ChannelMarker>) -> Option<usize> {
68        let channel = self.0.channel_messages.get(&channel_id)?;
69
70        Some(channel.len())
71    }
72
73    /// Number of voice states in a given channel in the cache.
74    ///
75    /// Returns `None` if the channel hasn't yet been cached or there are no
76    /// voice states in the channel. However, the provided number may still be 0
77    /// if some number is returned.
78    pub fn channel_voice_states(&self, channel_id: Id<ChannelMarker>) -> Option<usize> {
79        let channel = self.0.voice_state_channels.get(&channel_id)?;
80
81        Some(channel.len())
82    }
83
84    /// Number of emojis in the cache.
85    pub fn emojis(&self) -> usize {
86        self.0.emojis.len()
87    }
88
89    /// Number of guilds in the cache.
90    pub fn guilds(&self) -> usize {
91        self.0.guilds.len()
92    }
93
94    /// Number of channels in a given guild in the cache.
95    ///
96    /// Returns `None` if the guild hasn't yet been cached.
97    pub fn guild_channels(&self, guild_id: Id<GuildMarker>) -> Option<usize> {
98        let guild = self.0.guild_channels.get(&guild_id)?;
99
100        Some(guild.len())
101    }
102
103    /// Number of emojis in a given guild in the cache.
104    ///
105    /// Returns `None` if the guild hasn't yet been cached.
106    pub fn guild_emojis(&self, guild_id: Id<GuildMarker>) -> Option<usize> {
107        let guild = self.0.guild_emojis.get(&guild_id)?;
108
109        Some(guild.len())
110    }
111
112    /// Number of members in a given guild in the cache.
113    ///
114    /// Returns `None` if the guild hasn't yet been cached.
115    pub fn guild_members(&self, guild_id: Id<GuildMarker>) -> Option<usize> {
116        let guild = self.0.guild_members.get(&guild_id)?;
117
118        Some(guild.len())
119    }
120
121    /// Number of presences in a given guild in the cache.
122    ///
123    /// Returns `None` if the guild hasn't yet been cached.
124    pub fn guild_presences(&self, guild_id: Id<GuildMarker>) -> Option<usize> {
125        let guild = self.0.guild_presences.get(&guild_id)?;
126
127        Some(guild.len())
128    }
129
130    /// Number of roles in a given guild in the cache.
131    ///
132    /// Returns `None` if the guild hasn't yet been cached.
133    pub fn guild_roles(&self, guild_id: Id<GuildMarker>) -> Option<usize> {
134        let guild = self.0.guild_roles.get(&guild_id)?;
135
136        Some(guild.len())
137    }
138
139    /// Number of voice states in a given guild in the cache.
140    ///
141    /// Returns `None` if the guild hasn't yet been cached.
142    pub fn guild_voice_states(&self, guild_id: Id<GuildMarker>) -> Option<usize> {
143        let guild = self.0.voice_state_guilds.get(&guild_id)?;
144
145        Some(guild.len())
146    }
147
148    /// Number of members in the cache.
149    pub fn members(&self) -> usize {
150        self.0.members.len()
151    }
152
153    /// Number of presences in the cache.
154    pub fn presences(&self) -> usize {
155        self.0.presences.len()
156    }
157
158    /// Number of roles in the cache.
159    pub fn roles(&self) -> usize {
160        self.0.roles.len()
161    }
162
163    /// Number of unavailable guilds in the cache.
164    pub fn unavailable_guilds(&self) -> usize {
165        self.0.unavailable_guilds.len()
166    }
167
168    /// Number of users in the cache.
169    pub fn users(&self) -> usize {
170        self.0.users.len()
171    }
172
173    /// Number of voice states in the cache.
174    pub fn voice_states(&self) -> usize {
175        self.0.voice_states.len()
176    }
177}
178
179#[cfg(test)]
180mod tests {
181    use crate::InMemoryCacheStats;
182    use static_assertions::assert_impl_all;
183    use std::fmt::Debug;
184
185    assert_impl_all!(InMemoryCacheStats<'_>: Clone, Debug, Send, Sync);
186}
twilight_cache_inmemory/stats.rs

twilight_cache_inmemory/
stats.rs
