twilight_cache_inmemory/
config.rs

1use bitflags::bitflags;
2
3bitflags! {
4    /// A set of bitflags which can be used to specify what resource to process
5    /// into the cache.
6    ///
7    /// For example, specifying [`CHANNEL`] but not [`MESSAGE`] will cache
8    /// created channels, channel updates, and channel deletes, but not their
9    /// messages.
10    #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
11    pub struct ResourceType: u64 {
12        /// Information relating to channels.
13        const CHANNEL = 1;
14        /// Information relating to emojis.
15        const EMOJI = 1 << 1;
16        /// Information relating to guilds.
17        const GUILD = 1 << 2;
18        /// Information relating to members.
19        const MEMBER = 1 << 3;
20        /// Information relating to messages.
21        const MESSAGE = 1 << 4;
22        /// Information relating to presences.
23        const PRESENCE = 1 << 5;
24        /// Information relating to reactions.
25        const REACTION = 1 << 6;
26        /// Information relating to roles.
27        const ROLE = 1 << 7;
28        /// Information relating the current user.
29        const USER_CURRENT = 1 << 8;
30        /// Information relating to users.
31        const USER = 1 << 9;
32        /// Information relating to voice states.
33        const VOICE_STATE = 1 << 10;
34        /// Information relating to stage instances.
35        const STAGE_INSTANCE = 1 << 11;
36        /// Information relating to guild integrations.
37        const INTEGRATION = 1 << 12;
38        /// Information relating to guild stickers.
39        const STICKER = 1 << 13;
40        /// Information relating to guild scheduled events.
41        const GUILD_SCHEDULED_EVENT = 1 << 14;
42    }
43}
44
45/// Configuration for an [`InMemoryCache`].
46///
47/// [`InMemoryCache`]: crate::InMemoryCache
48#[derive(Clone, Debug, Eq, PartialEq)]
49pub struct Config {
50    pub(super) resource_types: ResourceType,
51    pub(super) message_cache_size: usize,
52}
53
54impl Config {
55    /// Create a new default configuration.
56    ///
57    /// Refer to individual getters for their defaults.
58    pub const fn new() -> Self {
59        Self {
60            resource_types: ResourceType::all(),
61            message_cache_size: 100,
62        }
63    }
64
65    /// Returns an immutable reference to the message cache size.
66    ///
67    /// Defaults to 100.
68    pub const fn message_cache_size(&self) -> usize {
69        self.message_cache_size
70    }
71
72    /// Returns a mutable reference to the message cache size.
73    pub fn message_cache_size_mut(&mut self) -> &mut usize {
74        &mut self.message_cache_size
75    }
76    /// Returns an immutable reference to the resource types enabled.
77    ///
78    /// Defaults to all resource types.
79    pub const fn resource_types(&self) -> ResourceType {
80        self.resource_types
81    }
82
83    /// Returns a mutable reference to the resource types enabled.
84    pub fn resource_types_mut(&mut self) -> &mut ResourceType {
85        &mut self.resource_types
86    }
87}
88
89impl Default for Config {
90    fn default() -> Self {
91        Self::new()
92    }
93}
94
95#[cfg(test)]
96mod tests {
97    use super::{Config, ResourceType};
98    use static_assertions::assert_fields;
99
100    assert_fields!(Config: resource_types, message_cache_size);
101
102    #[test]
103    fn defaults() {
104        let conf = Config {
105            resource_types: ResourceType::all(),
106            message_cache_size: 100,
107        };
108        let default = Config::default();
109        assert_eq!(conf.resource_types, default.resource_types);
110        assert_eq!(conf.message_cache_size, default.message_cache_size);
111    }
112}
twilight_cache_inmemory/config.rs

twilight_cache_inmemory/
config.rs
