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
use crate::channel::{ChannelType, message::EmojiReactionType};
use crate::id::Id;
use crate::id::marker::{ChannelMarker, RoleMarker, UserMarker};
use serde::{Deserialize, Serialize};
/// Dropdown-style [`Component`] that renders below messages.
///
/// [`Component`]: super::Component
#[derive(Clone, Debug, Eq, Hash, PartialEq)]
pub struct SelectMenu {
/// Optional identifier for this select menu.
pub id: Option<i32>,
/// An optional list of channel types.
///
/// This is only applicable to [channel select menus](SelectMenuType::Channel).
pub channel_types: Option<Vec<ChannelType>>,
/// Developer defined identifier.
pub custom_id: String,
/// List of default values for auto-populated select menus.
pub default_values: Option<Vec<SelectDefaultValue>>,
/// Whether the select menu is disabled.
///
/// Defaults to `false`.
pub disabled: bool,
/// This select menu's type.
pub kind: SelectMenuType,
/// Maximum number of options that may be chosen.
pub max_values: Option<u8>,
/// Minimum number of options that must be chosen.
pub min_values: Option<u8>,
/// A list of available options.
///
/// This is required by [text select menus](SelectMenuType::Text).
pub options: Option<Vec<SelectMenuOption>>,
/// Custom placeholder text if no option is selected.
pub placeholder: Option<String>,
/// Whether a selection is required in a modal.
///
/// Ignored in messages.
pub required: Option<bool>,
}
/// A [`SelectMenu`]'s type.
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
#[non_exhaustive]
pub enum SelectMenuType {
/// Select menus with a text-based `options` list.
///
/// Select menus of this `kind` *must* set the `options` field to specify the options users
/// can pick from.
Text,
/// User select menus.
User,
/// Role select menus.
Role,
/// Mentionable select menus.
Mentionable,
/// Channel select menus.
Channel,
}
/// Dropdown options that are part of [`SelectMenu`].
#[derive(Clone, Debug, Deserialize, Eq, Hash, PartialEq, Serialize)]
pub struct SelectMenuOption {
/// Whether the option will be selected by default.
#[serde(default)]
pub default: bool,
/// Additional description.
#[serde(skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// Emoji associated with the option. Appears left of the label and
/// description.
#[serde(skip_serializing_if = "Option::is_none")]
pub emoji: Option<EmojiReactionType>,
/// User-facing name.
pub label: String,
/// Developer defined value.
pub value: String,
}
/// A default value for an auto-populated select menu.
#[derive(Copy, Clone, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
#[serde(tag = "type", content = "id", rename_all = "snake_case")]
pub enum SelectDefaultValue {
/// Default user.
User(Id<UserMarker>),
/// Default role.
Role(Id<RoleMarker>),
/// Default channel.
Channel(Id<ChannelMarker>),
}
#[cfg(test)]
mod tests {
use super::*;
use static_assertions::{assert_fields, assert_impl_all};
use std::{fmt::Debug, hash::Hash};
assert_fields!(
SelectMenu: channel_types,
custom_id,
default_values,
disabled,
kind,
max_values,
min_values,
options,
placeholder,
required
);
assert_impl_all!(SelectMenu: Clone, Debug, Eq, Hash, PartialEq, Send, Sync);
assert_impl_all!(
SelectMenuType: Clone,
Debug,
Eq,
Hash,
PartialEq,
Send,
Sync
);
assert_impl_all!(
SelectMenuOption: Clone,
Debug,
Deserialize<'static>,
Eq,
Hash,
PartialEq,
Send,
Serialize,
Sync
);
assert_fields!(SelectMenuOption: default, description, emoji, label, value);
assert_impl_all!(
SelectDefaultValue: Copy,
Clone,
Debug,
Deserialize<'static>,
Eq,
Hash,
Ord,
PartialEq,
PartialOrd,
Serialize
);
}