twilight_model/channel/message/
flags.rs

1use bitflags::bitflags;
2use serde::{
3    de::{Deserialize, Deserializer},
4    ser::{Serialize, Serializer},
5};
6
7bitflags! {
8    /// Flags to signal state and modify the look of a message.
9    #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
10    pub struct MessageFlags: u64 {
11        /// Has been published to subscribed channels via Channel Following.
12        const CROSSPOSTED = 1;
13        /// Is a crosspost from another channel via Channel Following.
14        const IS_CROSSPOST = 1 << 1;
15        /// Do not include any embeds when serializing this message.
16        const SUPPRESS_EMBEDS = 1 << 2;
17        /// Source message for this message has been deleted via Channel
18        /// Following.
19        const SOURCE_MESSAGE_DELETED = 1 << 3;
20        /// Comes from the urgent message system.
21        const URGENT = 1 << 4;
22        /// A thread has been started from this message.
23        const HAS_THREAD = 1 << 5;
24        /// When used, only shows a message to the invoking user.
25        ///
26        /// Used when responding to an [`Interaction`].
27        ///
28        /// [`Interaction`]: crate::application::interaction::Interaction
29        const EPHEMERAL = 1 << 6;
30        /// This message is an Interaction Response, and the bot is "thinking".
31        const LOADING = 1 << 7;
32        /// This message failed to mention some roles in a thread, which
33        /// subsequently failed to add the role's members to the thread.
34        const FAILED_TO_MENTION_SOME_ROLES_IN_THREAD  = 1 << 8;
35        /// This message will not trigger push and desktop notifications.
36        const SUPPRESS_NOTIFICATIONS = 1 << 12;
37        /// This message is a voice message.
38        const IS_VOICE_MESSAGE = 1 << 13;
39        /// This message has a snapshot (via Message Forwarding).
40        const HAS_SNAPSHOT = 1 << 14;
41        /// This flag is required to use the components v2 components.
42        const IS_COMPONENTS_V2 = 1 << 15;
43    }
44}
45
46impl<'de> Deserialize<'de> for MessageFlags {
47    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
48        Ok(Self::from_bits_truncate(u64::deserialize(deserializer)?))
49    }
50}
51
52impl Serialize for MessageFlags {
53    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
54    where
55        S: Serializer,
56    {
57        serializer.serialize_u64(self.bits())
58    }
59}
60
61#[cfg(test)]
62mod tests {
63    use super::MessageFlags;
64    use serde::{Deserialize, Serialize};
65    use serde_test::Token;
66    use static_assertions::{assert_impl_all, const_assert_eq};
67    use std::{
68        fmt::{Binary, Debug, LowerHex, Octal, UpperHex},
69        hash::Hash,
70        ops::{
71            BitAnd, BitAndAssign, BitOr, BitOrAssign, BitXor, BitXorAssign, Not, Sub, SubAssign,
72        },
73    };
74
75    assert_impl_all!(
76        MessageFlags: Binary,
77        BitAnd,
78        BitAndAssign,
79        BitOr,
80        BitOrAssign,
81        BitXor,
82        BitXorAssign,
83        Clone,
84        Copy,
85        Debug,
86        Deserialize<'static>,
87        Eq,
88        Extend<MessageFlags>,
89        FromIterator<MessageFlags>,
90        Hash,
91        LowerHex,
92        Not,
93        Octal,
94        PartialEq,
95        Send,
96        Serialize,
97        Sub,
98        SubAssign,
99        Sync,
100        UpperHex
101    );
102    const_assert_eq!(MessageFlags::CROSSPOSTED.bits(), 1);
103    const_assert_eq!(MessageFlags::IS_CROSSPOST.bits(), 1 << 1);
104    const_assert_eq!(MessageFlags::SUPPRESS_EMBEDS.bits(), 1 << 2);
105    const_assert_eq!(MessageFlags::SOURCE_MESSAGE_DELETED.bits(), 1 << 3);
106    const_assert_eq!(MessageFlags::URGENT.bits(), 1 << 4);
107    const_assert_eq!(MessageFlags::HAS_THREAD.bits(), 1 << 5);
108    const_assert_eq!(MessageFlags::EPHEMERAL.bits(), 1 << 6);
109    const_assert_eq!(MessageFlags::LOADING.bits(), 1 << 7);
110    const_assert_eq!(
111        MessageFlags::FAILED_TO_MENTION_SOME_ROLES_IN_THREAD.bits(),
112        1 << 8
113    );
114    const_assert_eq!(MessageFlags::SUPPRESS_NOTIFICATIONS.bits(), 1 << 12);
115    const_assert_eq!(MessageFlags::IS_VOICE_MESSAGE.bits(), 1 << 13);
116    const_assert_eq!(MessageFlags::HAS_SNAPSHOT.bits(), 1 << 14);
117    const_assert_eq!(MessageFlags::IS_COMPONENTS_V2.bits(), 1 << 15);
118
119    #[test]
120    fn serde() {
121        serde_test::assert_tokens(
122            &MessageFlags::CROSSPOSTED,
123            &[Token::U64(MessageFlags::CROSSPOSTED.bits())],
124        );
125        // Deserialization truncates unknown bits.
126        serde_test::assert_de_tokens(&MessageFlags::empty(), &[Token::U64(1 << 63)]);
127    }
128}
twilight_model/channel/message/flags.rs

twilight_model/channel/message/
flags.rs
