twilight-cache-inmemory 0.16.0

In-process-memory based cache for the Twilight ecosystem.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

use crate::{traits::CacheableChannel, CacheableModels, InMemoryCache, ResourceType, UpdateCache};
use twilight_model::{
    channel::Channel,
    gateway::payload::incoming::{ChannelCreate, ChannelDelete, ChannelPinsUpdate, ChannelUpdate},
    id::{marker::ChannelMarker, Id},
};

impl<CacheModels: CacheableModels> InMemoryCache<CacheModels> {
    pub(crate) fn cache_channels(&self, channels: impl IntoIterator<Item = Channel>) {
        for channel in channels {
            self.cache_channel(channel);
        }
    }

    pub(crate) fn cache_channel(&self, channel: Channel) {
        if let Some(guild_id) = channel.guild_id {
            self.guild_channels
                .entry(guild_id)
                .or_default()
                .insert(channel.id);
        }

        self.channels
            .insert(channel.id, CacheModels::Channel::from(channel));
    }

    /// Delete a guild channel from the cache.
    ///
    /// The guild channel data itself and the channel entry in its guild's list
    /// of channels will be deleted.
    pub(crate) fn delete_channel(&self, channel_id: Id<ChannelMarker>) {
        if let Some((_, channel)) = self.channels.remove(&channel_id) {
            if let Some(guild_id) = channel.guild_id() {
                let maybe_channels = self.guild_channels.get_mut(&guild_id);

                if let Some(mut channels) = maybe_channels {
                    channels.remove(&channel_id);
                }
            }
        }
    }
}

impl<CacheModels: CacheableModels> UpdateCache<CacheModels> for ChannelCreate {
    fn update(&self, cache: &InMemoryCache<CacheModels>) {
        if !cache.wants(ResourceType::CHANNEL) {
            return;
        }

        cache.cache_channel(self.0.clone());
    }
}

impl<CacheModels: CacheableModels> UpdateCache<CacheModels> for ChannelDelete {
    fn update(&self, cache: &InMemoryCache<CacheModels>) {
        if !cache.wants(ResourceType::CHANNEL) {
            return;
        }

        cache.delete_channel(self.0.id);
    }
}

impl<CacheModels: CacheableModels> UpdateCache<CacheModels> for ChannelPinsUpdate {
    fn update(&self, cache: &InMemoryCache<CacheModels>) {
        if !cache.wants(ResourceType::CHANNEL) {
            return;
        }

        if let Some(mut channel) = cache.channels.get_mut(&self.channel_id) {
            channel.set_last_pin_timestamp(self.last_pin_timestamp);
        }
    }
}

impl<CacheModels: CacheableModels> UpdateCache<CacheModels> for ChannelUpdate {
    fn update(&self, cache: &InMemoryCache<CacheModels>) {
        if !cache.wants(ResourceType::CHANNEL) {
            return;
        }

        cache.cache_channel(self.0.clone());
    }
}

#[cfg(test)]
mod tests {
    use crate::{test, DefaultInMemoryCache};
    use twilight_model::gateway::{
        event::Event,
        payload::incoming::{ChannelDelete, ChannelUpdate},
    };

    #[test]
    fn channel_delete_guild() {
        let cache = DefaultInMemoryCache::new();
        let (guild_id, channel_id, channel) = test::guild_channel_text();

        cache.cache_channel(channel.clone());
        assert_eq!(1, cache.channels.len());
        assert!(cache
            .guild_channels
            .get(&guild_id)
            .unwrap()
            .contains(&channel_id));

        cache.update(&Event::ChannelDelete(Box::new(ChannelDelete(channel))));
        assert!(cache.channels.is_empty());
        assert!(cache.guild_channels.get(&guild_id).unwrap().is_empty());
    }

    #[test]
    fn channel_update_guild() {
        let cache = DefaultInMemoryCache::new();
        let (guild_id, channel_id, channel) = test::guild_channel_text();

        cache.update(&ChannelUpdate(channel));
        assert_eq!(1, cache.channels.len());
        assert!(cache
            .guild_channels
            .get(&guild_id)
            .unwrap()
            .contains(&channel_id));
    }
}