Skip to main content

twilight_model/gateway/payload/incoming/
member_update.rs

1use crate::{
2    guild::MemberFlags,
3    id::{
4        Id,
5        marker::{GuildMarker, RoleMarker},
6    },
7    user::User,
8    util::{ImageHash, Timestamp},
9};
10use serde::{Deserialize, Serialize};
11
12#[derive(Clone, Debug, Deserialize, Eq, Hash, PartialEq, Serialize)]
13pub struct MemberUpdate {
14    /// Member's guild avatar.
15    pub avatar: Option<ImageHash>,
16    /// Member's guild banner.
17    pub banner: Option<ImageHash>,
18    pub communication_disabled_until: Option<Timestamp>,
19    pub guild_id: Id<GuildMarker>,
20    #[serde(skip_serializing_if = "Option::is_none")]
21    pub flags: Option<MemberFlags>,
22    pub deaf: Option<bool>,
23    pub joined_at: Option<Timestamp>,
24    pub mute: Option<bool>,
25    pub nick: Option<String>,
26    /// Whether the user has yet to pass the guild's [Membership Screening]
27    /// requirements.
28    ///
29    /// Note: This field is still under refactoring by Discord. For more info,
30    /// check this [issue] and [pull request].
31    ///
32    /// [Membership Screening]: https://support.discord.com/hc/en-us/articles/1500000466882
33    /// [issue]: https://github.com/discord/discord-api-docs/issues/2567
34    /// [pull request]: https://github.com/discord/discord-api-docs/pull/2547
35    #[serde(default)]
36    pub pending: bool,
37    pub premium_since: Option<Timestamp>,
38    pub roles: Vec<Id<RoleMarker>>,
39    pub user: User,
40}
41
42#[cfg(test)]
43mod tests {
44    use super::MemberUpdate;
45    use crate::{guild::MemberFlags, id::Id, test::image_hash, user::User, util::Timestamp};
46    use serde_test::Token;
47
48    #[test]
49    #[allow(clippy::too_many_lines)]
50    fn member_update() {
51        let joined_at = Some(Timestamp::from_micros(1_488_234_110_121_000).expect("non zero"));
52        let communication_disabled_until =
53            Timestamp::from_micros(1_641_027_600_000_000).expect("non zero");
54
55        let value = MemberUpdate {
56            avatar: None,
57            banner: None,
58            communication_disabled_until: Some(communication_disabled_until),
59            guild_id: Id::new(1_234),
60            flags: Some(MemberFlags::empty()),
61            deaf: Some(false),
62            joined_at,
63            mute: Some(false),
64            nick: Some("Twilight".to_string()),
65            pending: false,
66            premium_since: None,
67            roles: vec![],
68            user: User {
69                accent_color: None,
70                avatar_decoration: None,
71                avatar_decoration_data: None,
72                banner: None,
73                name: "Twilight Sparkle".to_string(),
74                id: Id::new(424_242),
75                discriminator: 1234,
76                avatar: Some(image_hash::AVATAR),
77                bot: false,
78                email: None,
79                flags: None,
80                global_name: Some("test".to_string()),
81                locale: None,
82                mfa_enabled: None,
83                premium_type: None,
84                primary_guild: None,
85                public_flags: None,
86                system: None,
87                verified: None,
88            },
89        };
90
91        serde_test::assert_tokens(
92            &value,
93            &[
94                Token::Struct {
95                    name: "MemberUpdate",
96                    len: 13,
97                },
98                Token::Str("avatar"),
99                Token::None,
100                Token::Str("banner"),
101                Token::None,
102                Token::Str("communication_disabled_until"),
103                Token::Some,
104                Token::Str("2022-01-01T09:00:00.000000+00:00"),
105                Token::Str("guild_id"),
106                Token::NewtypeStruct { name: "Id" },
107                Token::Str("1234"),
108                Token::Str("flags"),
109                Token::Some,
110                Token::U64(0),
111                Token::Str("deaf"),
112                Token::Some,
113                Token::Bool(false),
114                Token::Str("joined_at"),
115                Token::Some,
116                Token::Str("2017-02-27T22:21:50.121000+00:00"),
117                Token::Str("mute"),
118                Token::Some,
119                Token::Bool(false),
120                Token::Str("nick"),
121                Token::Some,
122                Token::Str("Twilight"),
123                Token::Str("pending"),
124                Token::Bool(false),
125                Token::Str("premium_since"),
126                Token::None,
127                Token::Str("roles"),
128                Token::Seq { len: Some(0) },
129                Token::SeqEnd,
130                Token::Str("user"),
131                Token::Struct {
132                    name: "User",
133                    len: 10,
134                },
135                Token::Str("accent_color"),
136                Token::None,
137                Token::Str("avatar"),
138                Token::Some,
139                Token::Str(image_hash::AVATAR_INPUT),
140                Token::Str("avatar_decoration"),
141                Token::None,
142                Token::Str("avatar_decoration_data"),
143                Token::None,
144                Token::Str("banner"),
145                Token::None,
146                Token::Str("bot"),
147                Token::Bool(false),
148                Token::Str("discriminator"),
149                Token::Str("1234"),
150                Token::Str("global_name"),
151                Token::Some,
152                Token::Str("test"),
153                Token::Str("id"),
154                Token::NewtypeStruct { name: "Id" },
155                Token::Str("424242"),
156                Token::Str("username"),
157                Token::Str("Twilight Sparkle"),
158                Token::StructEnd,
159                Token::StructEnd,
160            ],
161        )
162    }
163}