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

use serde::{Deserialize, Serialize};

/// Current gateway session utilization status.
///
/// Most bots have a `max_concurrency` of 1 and a `total` of 1000, but this is
/// increased for those with large bot sharding (in more than 150,000 guilds).
/// See [Discord Docs/Sharding for Large Bots].
///
/// [Discord Docs/Sharding for Large Bots]: https://discord.com/developers/docs/topics/gateway#sharding-for-large-bots
#[derive(Clone, Debug, Deserialize, Eq, Hash, PartialEq, Serialize)]
pub struct SessionStartLimit {
    /// Maximum number of session that may be started concurrently.
    pub max_concurrency: u16,
    /// Number of remaining sessions for a given time period.
    pub remaining: u32,
    /// Milliseconds until `remaining` resets back to `total`.
    pub reset_after: u64,
    /// Total number of sessions that can be started within the given time
    /// period.
    pub total: u32,
}

#[cfg(test)]
mod tests {
    use super::SessionStartLimit;
    use serde_test::Token;

    #[test]
    fn connection_info() {
        let value = SessionStartLimit {
            max_concurrency: 16,
            remaining: 998,
            reset_after: 84_686_789,
            total: 1_000,
        };

        serde_test::assert_tokens(
            &value,
            &[
                Token::Struct {
                    name: "SessionStartLimit",
                    len: 4,
                },
                Token::Str("max_concurrency"),
                Token::U16(16),
                Token::Str("remaining"),
                Token::U32(998),
                Token::Str("reset_after"),
                Token::U64(84_686_789),
                Token::Str("total"),
                Token::U32(1_000),
                Token::StructEnd,
            ],
        );
    }
}