twilight-model 0.17.1

Discord API models 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
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

use crate::{
    guild::MemberFlags,
    id::{
        Id,
        marker::{GuildMarker, RoleMarker},
    },
    user::User,
    util::{ImageHash, Timestamp},
};
use serde::{Deserialize, Serialize};

#[derive(Clone, Debug, Deserialize, Eq, Hash, PartialEq, Serialize)]
pub struct MemberUpdate {
    /// Member's guild avatar.
    pub avatar: Option<ImageHash>,
    pub communication_disabled_until: Option<Timestamp>,
    pub guild_id: Id<GuildMarker>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub flags: Option<MemberFlags>,
    pub deaf: Option<bool>,
    pub joined_at: Option<Timestamp>,
    pub mute: Option<bool>,
    pub nick: Option<String>,
    /// Whether the user has yet to pass the guild's [Membership Screening]
    /// requirements.
    ///
    /// Note: This field is still under refactoring by Discord. For more info,
    /// check this [issue] and [pull request].
    ///
    /// [Membership Screening]: https://support.discord.com/hc/en-us/articles/1500000466882
    /// [issue]: https://github.com/discord/discord-api-docs/issues/2567
    /// [pull request]: https://github.com/discord/discord-api-docs/pull/2547
    #[serde(default)]
    pub pending: bool,
    pub premium_since: Option<Timestamp>,
    pub roles: Vec<Id<RoleMarker>>,
    pub user: User,
}

#[cfg(test)]
mod tests {
    use super::MemberUpdate;
    use crate::{guild::MemberFlags, id::Id, test::image_hash, user::User, util::Timestamp};
    use serde_test::Token;

    #[test]
    #[allow(clippy::too_many_lines)]
    fn member_update() {
        let joined_at = Some(Timestamp::from_micros(1_488_234_110_121_000).expect("non zero"));
        let communication_disabled_until =
            Timestamp::from_micros(1_641_027_600_000_000).expect("non zero");

        let value = MemberUpdate {
            avatar: None,
            communication_disabled_until: Some(communication_disabled_until),
            guild_id: Id::new(1_234),
            flags: Some(MemberFlags::empty()),
            deaf: Some(false),
            joined_at,
            mute: Some(false),
            nick: Some("Twilight".to_string()),
            pending: false,
            premium_since: None,
            roles: vec![],
            user: User {
                accent_color: None,
                avatar_decoration: None,
                avatar_decoration_data: None,
                banner: None,
                name: "Twilight Sparkle".to_string(),
                id: Id::new(424_242),
                discriminator: 1234,
                avatar: Some(image_hash::AVATAR),
                bot: false,
                email: None,
                flags: None,
                global_name: Some("test".to_string()),
                locale: None,
                mfa_enabled: None,
                premium_type: None,
                primary_guild: None,
                public_flags: None,
                system: None,
                verified: None,
            },
        };

        serde_test::assert_tokens(
            &value,
            &[
                Token::Struct {
                    name: "MemberUpdate",
                    len: 12,
                },
                Token::Str("avatar"),
                Token::None,
                Token::Str("communication_disabled_until"),
                Token::Some,
                Token::Str("2022-01-01T09:00:00.000000+00:00"),
                Token::Str("guild_id"),
                Token::NewtypeStruct { name: "Id" },
                Token::Str("1234"),
                Token::Str("flags"),
                Token::Some,
                Token::U64(0),
                Token::Str("deaf"),
                Token::Some,
                Token::Bool(false),
                Token::Str("joined_at"),
                Token::Some,
                Token::Str("2017-02-27T22:21:50.121000+00:00"),
                Token::Str("mute"),
                Token::Some,
                Token::Bool(false),
                Token::Str("nick"),
                Token::Some,
                Token::Str("Twilight"),
                Token::Str("pending"),
                Token::Bool(false),
                Token::Str("premium_since"),
                Token::None,
                Token::Str("roles"),
                Token::Seq { len: Some(0) },
                Token::SeqEnd,
                Token::Str("user"),
                Token::Struct {
                    name: "User",
                    len: 10,
                },
                Token::Str("accent_color"),
                Token::None,
                Token::Str("avatar"),
                Token::Some,
                Token::Str(image_hash::AVATAR_INPUT),
                Token::Str("avatar_decoration"),
                Token::None,
                Token::Str("avatar_decoration_data"),
                Token::None,
                Token::Str("banner"),
                Token::None,
                Token::Str("bot"),
                Token::Bool(false),
                Token::Str("discriminator"),
                Token::Str("1234"),
                Token::Str("global_name"),
                Token::Some,
                Token::Str("test"),
                Token::Str("id"),
                Token::NewtypeStruct { name: "Id" },
                Token::Str("424242"),
                Token::Str("username"),
                Token::Str("Twilight Sparkle"),
                Token::StructEnd,
                Token::StructEnd,
            ],
        )
    }
}