twilight_model/channel/
flags.rs

1use bitflags::bitflags;
2use serde::{
3    de::{Deserialize, Deserializer},
4    ser::{Serialize, Serializer},
5};
6
7bitflags! {
8    #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
9    pub struct ChannelFlags: u64 {
10        /// Channel is pinned in a forum.
11        const PINNED = 1 << 1;
12        /// New threads in a forum channel require a tag.
13        const REQUIRE_TAG = 1 << 4;
14        /// Hide the download options for this post in a media channel.
15        const HIDE_MEDIA_DOWNLOAD_OPTIONS = 1 << 15;
16        /// This channel's metadata has been obfuscated because the current user
17        /// cannot view it.
18        ///
19        /// Only ever set on channels received over the Gateway; the HTTP API
20        /// never sets this flag.
21        const CHANNEL_OBFUSCATED = 1 << 17;
22    }
23}
24
25impl<'de> Deserialize<'de> for ChannelFlags {
26    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
27        Ok(Self::from_bits_truncate(u64::deserialize(deserializer)?))
28    }
29}
30
31impl Serialize for ChannelFlags {
32    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
33    where
34        S: Serializer,
35    {
36        serializer.serialize_u64(self.bits())
37    }
38}
39
40#[cfg(test)]
41mod tests {
42    use super::ChannelFlags;
43    use serde::{Deserialize, Serialize};
44    use serde_test::Token;
45    use static_assertions::{assert_impl_all, const_assert_eq};
46    use std::{
47        fmt::{Binary, Debug, LowerHex, Octal, UpperHex},
48        hash::Hash,
49        ops::{
50            BitAnd, BitAndAssign, BitOr, BitOrAssign, BitXor, BitXorAssign, Not, Sub, SubAssign,
51        },
52    };
53
54    assert_impl_all!(
55        ChannelFlags: Binary,
56        BitAnd,
57        BitAndAssign,
58        BitOr,
59        BitOrAssign,
60        BitXor,
61        BitXorAssign,
62        Clone,
63        Copy,
64        Debug,
65        Deserialize<'static>,
66        Eq,
67        Extend<ChannelFlags>,
68        FromIterator<ChannelFlags>,
69        Hash,
70        LowerHex,
71        Not,
72        Octal,
73        PartialEq,
74        Send,
75        Serialize,
76        Sub,
77        SubAssign,
78        Sync,
79        UpperHex
80    );
81    const_assert_eq!(ChannelFlags::PINNED.bits(), 1 << 1);
82    const_assert_eq!(ChannelFlags::REQUIRE_TAG.bits(), 1 << 4);
83    const_assert_eq!(ChannelFlags::CHANNEL_OBFUSCATED.bits(), 1 << 17);
84
85    #[test]
86    fn serde() {
87        serde_test::assert_tokens(
88            &ChannelFlags::PINNED,
89            &[Token::U64(ChannelFlags::PINNED.bits())],
90        );
91        // Deserialization truncates unknown bits.
92        serde_test::assert_de_tokens(&ChannelFlags::empty(), &[Token::U64(1 << 63)]);
93    }
94}
twilight_model/channel/flags.rs

twilight_model/channel/
flags.rs
