ruvolt 0.5.0

An API wrapper for Revolt written in Rust.
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

//! A cache containing data received from the API.
//!
//! ## Why use cache?
//! Using caching reduces latency to access data and allows you to avoid requests to the API.

use {async_trait::async_trait, std::collections::HashMap, tokio::sync::RwLock};

use crate::{
    models::{events::ServerEvent, Channel, Id, Member, MemberId, Server, User},
    Context,
};

/// A cache containing data received from the API.
#[derive(Debug, Default)]
pub struct Cache {
    pub(crate) users: RwLock<HashMap<Id, User>>,
    pub(crate) channels: RwLock<HashMap<Id, Channel>>,
    pub(crate) servers: RwLock<HashMap<Id, Server>>,
    pub(crate) members: RwLock<HashMap<MemberId, Member>>,
}

impl Cache {
    pub(crate) async fn update(cx: &Context, event: &ServerEvent) {
        match event {
            ServerEvent::Ready(event) => event.update(cx).await,
            ServerEvent::Message(event) => event.update(cx).await,
            ServerEvent::ChannelCreate(event) => event.update(cx).await,
            ServerEvent::ChannelUpdate(event) => event.update(cx).await,
            ServerEvent::ChannelDelete(event) => event.update(cx).await,
            ServerEvent::ChannelGroupJoin(event) => event.update(cx).await,
            ServerEvent::ChannelGroupLeave(event) => event.update(cx).await,
            ServerEvent::ServerUpdate(event) => event.update(cx).await,
            ServerEvent::ServerDelete(event) => event.update(cx).await,
            ServerEvent::ServerMemberUpdate(event) => event.update(cx).await,
            ServerEvent::ServerMemberJoin(event) => event.update(cx).await,
            ServerEvent::ServerMemberLeave(event) => event.update(cx).await,
            ServerEvent::UserUpdate(event) => event.update(cx).await,
            _ => return,
        }
    }

    /// Get a user from cache.
    pub async fn user(&self, id: &Id) -> Option<User> {
        self.users.read().await.get(id).cloned()
    }

    /// Get all users in cache.
    pub async fn users(&self) -> HashMap<Id, User> {
        self.users.read().await.clone()
    }

    /// Filter users in cache.
    pub async fn filter_users(&self, filter: impl Fn(&User) -> bool) -> Vec<User> {
        self.users
            .read()
            .await
            .iter()
            .filter_map(|(_, user)| {
                if filter(user) {
                    return Some(user);
                }

                None
            })
            .cloned()
            .collect()
    }

    /// Get a channel from cache.
    pub async fn channel(&self, id: &Id) -> Option<Channel> {
        self.channels.read().await.get(id).cloned()
    }

    /// Get all channels in cache.
    pub async fn channels(&self) -> HashMap<Id, Channel> {
        self.channels.read().await.clone()
    }

    /// Filter channels in cache.
    pub async fn filter_channels(&self, filter: impl Fn(&Channel) -> bool) -> Vec<Channel> {
        self.channels
            .read()
            .await
            .iter()
            .filter_map(|(_, channel)| {
                if filter(channel) {
                    return Some(channel);
                }

                None
            })
            .cloned()
            .collect()
    }

    /// Get a server from cache.
    pub async fn server(&self, id: &Id) -> Option<Server> {
        self.servers.read().await.get(id).cloned()
    }

    /// Get all servers in cache.
    pub async fn servers(&self) -> HashMap<Id, Server> {
        self.servers.read().await.clone()
    }

    /// Filter servers in cache.
    pub async fn filter_servers(&self, filter: impl Fn(&Server) -> bool) -> Vec<Server> {
        self.servers
            .read()
            .await
            .iter()
            .filter_map(|(_, server)| {
                if filter(server) {
                    return Some(server);
                }

                None
            })
            .cloned()
            .collect()
    }

    /// Returns the number of servers in cache.
    pub async fn servers_count(&self) -> usize {
        self.servers.read().await.len()
    }

    /// Get a member from cache.
    pub async fn member(&self, id: &MemberId) -> Option<Member> {
        self.members.read().await.get(id).cloned()
    }

    /// Get all members in cache.
    pub async fn members(&self) -> HashMap<MemberId, Member> {
        self.members.read().await.clone()
    }

    /// Filter members in cache.
    pub async fn filter_members(&self, filter: impl Fn(&Member) -> bool) -> Vec<Member> {
        self.members
            .read()
            .await
            .iter()
            .filter_map(|(_, member)| {
                if filter(member) {
                    return Some(member);
                }

                None
            })
            .cloned()
            .collect()
    }
}

#[async_trait]
pub(crate) trait UpdateCache {
    async fn update(&self, cx: &Context);
}