twilight_model/channel/message/component/
kind.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
use serde::{Deserialize, Serialize};
use std::fmt::{Display, Formatter, Result as FmtResult};

/// Type of [`Component`].
///
/// [`Component`]: super::Component
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, PartialEq, Serialize)]
#[non_exhaustive]
#[serde(from = "u8", into = "u8")]
pub enum ComponentType {
    /// Component is an [`ActionRow`].
    ///
    /// [`ActionRow`]: super::ActionRow
    ActionRow,
    /// Component is an [`Button`].
    ///
    /// [`Button`]: super::Button
    Button,
    /// Component is a [`SelectMenu`] with custom string options.
    ///
    /// [`SelectMenu`]: super::SelectMenu
    TextSelectMenu,
    /// Component is an [`TextInput`].
    ///
    /// [`TextInput`]: super::TextInput
    TextInput,
    /// Component is a [`SelectMenu`] for users.
    ///
    /// [`SelectMenu`]: super::SelectMenu
    UserSelectMenu,
    /// Component is a [`SelectMenu`] for roles.
    ///
    /// [`SelectMenu`]: super::SelectMenu
    RoleSelectMenu,
    /// Component is a [`SelectMenu`] for mentionables.
    ///
    /// [`SelectMenu`]: super::SelectMenu
    MentionableSelectMenu,
    /// Component is a [`SelectMenu`] for channels.
    ///
    /// [`SelectMenu`]: super::SelectMenu
    ChannelSelectMenu,
    /// Variant value is unknown to the library.
    Unknown(u8),
}

impl From<u8> for ComponentType {
    fn from(value: u8) -> Self {
        match value {
            1 => ComponentType::ActionRow,
            2 => ComponentType::Button,
            3 => ComponentType::TextSelectMenu,
            4 => ComponentType::TextInput,
            5 => ComponentType::UserSelectMenu,
            6 => ComponentType::RoleSelectMenu,
            7 => ComponentType::MentionableSelectMenu,
            8 => ComponentType::ChannelSelectMenu,
            unknown => ComponentType::Unknown(unknown),
        }
    }
}

impl From<ComponentType> for u8 {
    fn from(value: ComponentType) -> Self {
        match value {
            ComponentType::ActionRow => 1,
            ComponentType::Button => 2,
            ComponentType::TextSelectMenu => 3,
            ComponentType::TextInput => 4,
            ComponentType::UserSelectMenu => 5,
            ComponentType::RoleSelectMenu => 6,
            ComponentType::MentionableSelectMenu => 7,
            ComponentType::ChannelSelectMenu => 8,
            ComponentType::Unknown(unknown) => unknown,
        }
    }
}

impl ComponentType {
    /// Name of the component type.
    ///
    /// Variants have a name equivalent to the variant name itself.
    ///
    /// # Examples
    ///
    /// Check the [`ActionRow`] variant's name:
    ///
    /// ```
    /// use twilight_model::channel::message::component::ComponentType;
    ///
    /// assert_eq!("ActionRow", ComponentType::ActionRow.name());
    /// ```
    ///
    /// [`ActionRow`]: Self::ActionRow
    pub const fn name(self) -> &'static str {
        match self {
            Self::ActionRow => "ActionRow",
            Self::Button => "Button",
            Self::TextSelectMenu
            | Self::UserSelectMenu
            | Self::RoleSelectMenu
            | Self::MentionableSelectMenu
            | Self::ChannelSelectMenu => "SelectMenu",
            Self::TextInput => "TextInput",
            Self::Unknown(_) => "Unknown",
        }
    }
}

impl Display for ComponentType {
    fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
        f.write_str(self.name())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde_test::Token;
    use static_assertions::assert_impl_all;
    use std::{fmt::Debug, hash::Hash};

    assert_impl_all!(
        ComponentType: Clone,
        Copy,
        Debug,
        Deserialize<'static>,
        Eq,
        Hash,
        PartialEq,
        Send,
        Serialize,
        Sync
    );

    #[test]
    fn variants() {
        serde_test::assert_tokens(&ComponentType::ActionRow, &[Token::U8(1)]);
        serde_test::assert_tokens(&ComponentType::Button, &[Token::U8(2)]);
        serde_test::assert_tokens(&ComponentType::TextSelectMenu, &[Token::U8(3)]);
        serde_test::assert_tokens(&ComponentType::TextInput, &[Token::U8(4)]);
        serde_test::assert_tokens(&ComponentType::UserSelectMenu, &[Token::U8(5)]);
        serde_test::assert_tokens(&ComponentType::RoleSelectMenu, &[Token::U8(6)]);
        serde_test::assert_tokens(&ComponentType::MentionableSelectMenu, &[Token::U8(7)]);
        serde_test::assert_tokens(&ComponentType::ChannelSelectMenu, &[Token::U8(8)]);
        serde_test::assert_tokens(&ComponentType::Unknown(99), &[Token::U8(99)]);
    }

    #[test]
    fn names() {
        assert_eq!("ActionRow", ComponentType::ActionRow.name());
        assert_eq!("Button", ComponentType::Button.name());
        assert_eq!("SelectMenu", ComponentType::TextSelectMenu.name());
        assert_eq!("SelectMenu", ComponentType::UserSelectMenu.name());
        assert_eq!("SelectMenu", ComponentType::RoleSelectMenu.name());
        assert_eq!("SelectMenu", ComponentType::MentionableSelectMenu.name());
        assert_eq!("SelectMenu", ComponentType::ChannelSelectMenu.name());
        assert_eq!("TextInput", ComponentType::TextInput.name());
        assert_eq!("Unknown", ComponentType::Unknown(99).name());
    }
}