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

twilight_model/channel/message/
flags.rs
