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 flag is required to use the components v2 components.
40        const IS_COMPONENTS_V2 = 1 << 15;
41    }
42}
43
44impl<'de> Deserialize<'de> for MessageFlags {
45    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
46        Ok(Self::from_bits_truncate(u64::deserialize(deserializer)?))
47    }
48}
49
50impl Serialize for MessageFlags {
51    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
52    where
53        S: Serializer,
54    {
55        serializer.serialize_u64(self.bits())
56    }
57}
58
59#[cfg(test)]
60mod tests {
61    use super::MessageFlags;
62    use serde::{Deserialize, Serialize};
63    use serde_test::Token;
64    use static_assertions::{assert_impl_all, const_assert_eq};
65    use std::{
66        fmt::{Binary, Debug, LowerHex, Octal, UpperHex},
67        hash::Hash,
68        ops::{
69            BitAnd, BitAndAssign, BitOr, BitOrAssign, BitXor, BitXorAssign, Not, Sub, SubAssign,
70        },
71    };
72
73    assert_impl_all!(
74        MessageFlags: Binary,
75        BitAnd,
76        BitAndAssign,
77        BitOr,
78        BitOrAssign,
79        BitXor,
80        BitXorAssign,
81        Clone,
82        Copy,
83        Debug,
84        Deserialize<'static>,
85        Eq,
86        Extend<MessageFlags>,
87        FromIterator<MessageFlags>,
88        Hash,
89        LowerHex,
90        Not,
91        Octal,
92        PartialEq,
93        Send,
94        Serialize,
95        Sub,
96        SubAssign,
97        Sync,
98        UpperHex
99    );
100    const_assert_eq!(MessageFlags::CROSSPOSTED.bits(), 1);
101    const_assert_eq!(MessageFlags::IS_CROSSPOST.bits(), 1 << 1);
102    const_assert_eq!(MessageFlags::SUPPRESS_EMBEDS.bits(), 1 << 2);
103    const_assert_eq!(MessageFlags::SOURCE_MESSAGE_DELETED.bits(), 1 << 3);
104    const_assert_eq!(MessageFlags::URGENT.bits(), 1 << 4);
105    const_assert_eq!(MessageFlags::HAS_THREAD.bits(), 1 << 5);
106    const_assert_eq!(MessageFlags::EPHEMERAL.bits(), 1 << 6);
107    const_assert_eq!(MessageFlags::LOADING.bits(), 1 << 7);
108    const_assert_eq!(
109        MessageFlags::FAILED_TO_MENTION_SOME_ROLES_IN_THREAD.bits(),
110        1 << 8
111    );
112    const_assert_eq!(MessageFlags::SUPPRESS_NOTIFICATIONS.bits(), 1 << 12);
113
114    #[test]
115    fn serde() {
116        serde_test::assert_tokens(
117            &MessageFlags::CROSSPOSTED,
118            &[Token::U64(MessageFlags::CROSSPOSTED.bits())],
119        );
120        // Deserialization truncates unknown bits.
121        serde_test::assert_de_tokens(&MessageFlags::empty(), &[Token::U64(1 << 63)]);
122    }
123}
twilight_model/channel/message/flags.rs

twilight_model/channel/message/
flags.rs
