twilight_model/gateway/connection_info/
bot_connection_info.rs

1use crate::gateway::SessionStartLimit;
2use serde::{Deserialize, Serialize};
3
4/// Gateway information containing the recommended shard count and session
5/// availability.
6#[derive(Clone, Debug, Deserialize, Eq, Hash, PartialEq, Serialize)]
7pub struct BotConnectionInfo {
8    /// Current session availability and session connection concurrency limits.
9    pub session_start_limit: SessionStartLimit,
10    /// Recommended shard count to use.
11    pub shards: u32,
12    /// URL to the gateway.
13    pub url: String,
14}
15
16#[cfg(test)]
17mod tests {
18    use super::{BotConnectionInfo, SessionStartLimit};
19    use serde_test::Token;
20
21    #[test]
22    fn connection_info() {
23        let value = BotConnectionInfo {
24            session_start_limit: SessionStartLimit {
25                max_concurrency: 16,
26                remaining: 998,
27                reset_after: 84_686_789,
28                total: 1000,
29            },
30            shards: 3,
31            url: "wss://gateway.discord.gg".to_owned(),
32        };
33
34        serde_test::assert_tokens(
35            &value,
36            &[
37                Token::Struct {
38                    name: "BotConnectionInfo",
39                    len: 3,
40                },
41                Token::Str("session_start_limit"),
42                Token::Struct {
43                    name: "SessionStartLimit",
44                    len: 4,
45                },
46                Token::Str("max_concurrency"),
47                Token::U16(16),
48                Token::Str("remaining"),
49                Token::U32(998),
50                Token::Str("reset_after"),
51                Token::U64(84_686_789),
52                Token::Str("total"),
53                Token::U32(1000),
54                Token::StructEnd,
55                Token::Str("shards"),
56                Token::U32(3),
57                Token::Str("url"),
58                Token::Str("wss://gateway.discord.gg"),
59                Token::StructEnd,
60            ],
61        );
62    }
63}