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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
//! The Command struct, which stores all information about a single framework command
use crate::{serenity_prelude as serenity, BoxFuture};
/// Type returned from `#[poise::command]` annotated functions, which contains all of the generated
/// prefix and application commands
#[derive(derivative::Derivative)]
#[derivative(Default(bound = ""), Debug(bound = ""))]
pub struct Command<U, E> {
// =============
/// Callback to execute when this command is invoked in a prefix context
#[derivative(Debug = "ignore")]
pub prefix_action: Option<
for<'a> fn(
crate::PrefixContext<'a, U, E>,
) -> BoxFuture<'a, Result<(), crate::FrameworkError<'a, U, E>>>,
>,
/// Callback to execute when this command is invoked in a slash context
#[derivative(Debug = "ignore")]
pub slash_action: Option<
for<'a> fn(
crate::ApplicationContext<'a, U, E>,
) -> BoxFuture<'a, Result<(), crate::FrameworkError<'a, U, E>>>,
>,
/// Callback to execute when this command is invoked in a context menu context
///
/// The enum variant shows which Discord item this context menu command works on
pub context_menu_action: Option<crate::ContextMenuCommandAction<U, E>>,
// ============= Command type agnostic data
/// Subcommands of this command, if any
pub subcommands: Vec<Command<U, E>>,
/// Require a subcommand to be invoked
pub subcommand_required: bool,
/// Main name of the command. Aliases (prefix-only) can be set in [`Self::aliases`].
pub name: String,
/// Localized names with locale string as the key (slash-only)
pub name_localizations: std::collections::HashMap<String, String>,
/// Full name including parent command names.
///
/// Initially set to just [`Self::name`] and properly populated when the framework is started.
pub qualified_name: String,
/// A string to identify this particular command within a list of commands.
///
/// Can be configured via the [`crate::command`] macro (though it's probably not needed for most
/// bots). If not explicitly configured, it falls back to the command function name.
pub identifying_name: String,
/// The name of the `#[poise::command]`-annotated function
pub source_code_name: String,
/// Identifier for the category that this command will be displayed in for help commands.
pub category: Option<String>,
/// Whether to hide this command in help menus.
pub hide_in_help: bool,
/// Short description of the command. Displayed inline in help menus and similar.
pub description: Option<String>,
/// Localized descriptions with locale string as the key (slash-only)
pub description_localizations: std::collections::HashMap<String, String>,
/// Multiline description with detailed usage instructions. Displayed in the command specific
/// help: `~help command_name`
pub help_text: Option<String>,
/// if `true`, disables automatic cooldown handling before this commands invocation.
///
/// Will override [`crate::FrameworkOptions::manual_cooldowns`] allowing manual cooldowns
/// on select commands.
pub manual_cooldowns: Option<bool>,
/// Handles command cooldowns. Mainly for framework internal use
pub cooldowns: std::sync::Mutex<crate::CooldownTracker>,
/// Configuration for the [`crate::CooldownTracker`]
pub cooldown_config: std::sync::RwLock<crate::CooldownConfig>,
/// After the first response, whether to post subsequent responses as edits to the initial
/// message
///
/// Note: in prefix commands, this only has an effect if
/// `crate::PrefixFrameworkOptions::edit_tracker` is set.
pub reuse_response: bool,
/// Permissions which users must have to invoke this command. Used by Discord to set who can
/// invoke this as a slash command. Not used on prefix commands or checked internally.
///
/// Set to [`serenity::Permissions::empty()`] by default
pub default_member_permissions: serenity::Permissions,
/// Permissions which users must have to invoke this command. This is checked internally and
/// works for both prefix commands and slash commands.
///
/// Set to [`serenity::Permissions::empty()`] by default
pub required_permissions: serenity::Permissions,
/// Permissions without which command execution will fail. You can set this to fail early and
/// give a descriptive error message in case the
/// bot hasn't been assigned the minimum permissions by the guild admin.
///
/// Set to [`serenity::Permissions::empty()`] by default
pub required_bot_permissions: serenity::Permissions,
/// If true, only users from the [owners list](crate::FrameworkOptions::owners) may use this
/// command.
pub owners_only: bool,
/// If true, only people in guilds may use this command
pub guild_only: bool,
/// If true, the command may only run in DMs
pub dm_only: bool,
/// If true, the command may only run in NSFW channels
pub nsfw_only: bool,
/// Command-specific override for [`crate::FrameworkOptions::on_error`]
#[derivative(Debug = "ignore")]
pub on_error: Option<fn(crate::FrameworkError<'_, U, E>) -> BoxFuture<'_, ()>>,
/// If any of these functions returns false, this command will not be executed.
#[derivative(Debug = "ignore")]
pub checks: Vec<fn(crate::Context<'_, U, E>) -> BoxFuture<'_, Result<bool, E>>>,
/// List of parameters for this command
///
/// Used for registering and parsing slash commands. Can also be used in help commands
pub parameters: Vec<crate::CommandParameter<U, E>>,
/// Arbitrary data, useful for storing custom metadata about your commands
#[derivative(Default(value = "Box::new(())"))]
pub custom_data: Box<dyn std::any::Any + Send + Sync>,
// ============= Prefix-specific data
/// Alternative triggers for the command (prefix-only)
pub aliases: Vec<String>,
/// Whether to rerun the command if an existing invocation message is edited (prefix-only)
pub invoke_on_edit: bool,
/// Whether to delete the bot response if an existing invocation message is deleted (prefix-only)
pub track_deletion: bool,
/// Whether to broadcast a typing indicator while executing this commmand (prefix-only)
pub broadcast_typing: bool,
// ============= Application-specific data
/// Context menu specific name for this command, displayed in Discord's context menu
pub context_menu_name: Option<String>,
/// Whether responses to this command should be ephemeral by default (application-only)
pub ephemeral: bool,
/// List of installation contexts for this command (application-only)
pub install_context: Option<Vec<serenity::InstallationContext>>,
/// List of interaction contexts for this command (application-only)
pub interaction_context: Option<Vec<serenity::InteractionContext>>,
// Like #[non_exhaustive], but #[poise::command] still needs to be able to create an instance
#[doc(hidden)]
pub __non_exhaustive: (),
}
impl<U, E> PartialEq for Command<U, E> {
fn eq(&self, other: &Self) -> bool {
std::ptr::eq(self, other)
}
}
impl<U, E> Eq for Command<U, E> {}
impl<U, E> Command<U, E> {
/// Serializes this Command into an application command option, which is the form which Discord
/// requires subcommands to be in
fn create_as_subcommand(&self) -> Option<serenity::CreateCommandOption> {
self.slash_action?;
let kind = if self.subcommands.is_empty() {
serenity::CommandOptionType::SubCommand
} else {
serenity::CommandOptionType::SubCommandGroup
};
let description = self.description.as_deref().unwrap_or("A slash command");
let mut builder = serenity::CreateCommandOption::new(kind, self.name.clone(), description);
for (locale, name) in &self.name_localizations {
builder = builder.name_localized(locale, name);
}
for (locale, description) in &self.description_localizations {
builder = builder.description_localized(locale, description);
}
if self.subcommands.is_empty() {
for param in &self.parameters {
// Using `?` because if this command has slash-incompatible parameters, we cannot
// just ignore them but have to abort the creation process entirely
builder = builder.add_sub_option(param.create_as_slash_command_option()?);
}
} else {
for subcommand in &self.subcommands {
if let Some(subcommand) = subcommand.create_as_subcommand() {
builder = builder.add_sub_option(subcommand);
}
}
}
Some(builder)
}
/// Generates a slash command builder from this [`Command`] instance. This can be used
/// to register this command on Discord's servers
pub fn create_as_slash_command(&self) -> Option<serenity::CreateCommand> {
self.slash_action?;
let mut builder = serenity::CreateCommand::new(self.name.clone())
.description(self.description.as_deref().unwrap_or("A slash command"));
for (locale, name) in &self.name_localizations {
builder = builder.name_localized(locale, name);
}
for (locale, description) in &self.description_localizations {
builder = builder.description_localized(locale, description);
}
// This is_empty check is needed because Discord special cases empty
// default_member_permissions to mean "admin-only" (yes it's stupid)
if !self.default_member_permissions.is_empty() {
builder = builder.default_member_permissions(self.default_member_permissions);
}
if self.guild_only {
builder = builder.contexts(vec![serenity::InteractionContext::Guild]);
} else if self.dm_only {
builder = builder.contexts(vec![serenity::InteractionContext::BotDm]);
}
if let Some(install_context) = self.install_context.clone() {
builder = builder.integration_types(install_context);
}
if let Some(interaction_context) = self.interaction_context.clone() {
builder = builder.contexts(interaction_context);
}
if self.subcommands.is_empty() {
for param in &self.parameters {
// Using `?` because if this command has slash-incompatible parameters, we cannot
// just ignore them but have to abort the creation process entirely
builder = builder.add_option(param.create_as_slash_command_option()?);
}
} else {
for subcommand in &self.subcommands {
if let Some(subcommand) = subcommand.create_as_subcommand() {
builder = builder.add_option(subcommand);
}
}
}
Some(builder)
}
/// Generates a context menu command builder from this [`Command`] instance. This can be used
/// to register this command on Discord's servers
pub fn create_as_context_menu_command(&self) -> Option<serenity::CreateCommand> {
let context_menu_action = self.context_menu_action?;
// TODO: localization?
let name = self.context_menu_name.as_deref().unwrap_or(&self.name);
let mut builder = serenity::CreateCommand::new(name).kind(match context_menu_action {
crate::ContextMenuCommandAction::User(_) => serenity::CommandType::User,
crate::ContextMenuCommandAction::Message(_) => serenity::CommandType::Message,
crate::ContextMenuCommandAction::__NonExhaustive => unreachable!(),
});
// This is_empty check is needed because Discord special cases empty
// default_member_permissions to mean "admin-only"
if !self.default_member_permissions.is_empty() {
builder = builder.default_member_permissions(self.default_member_permissions);
}
if self.guild_only {
builder = builder.contexts(vec![serenity::InteractionContext::Guild]);
} else if self.dm_only {
builder = builder.contexts(vec![serenity::InteractionContext::BotDm]);
}
if let Some(install_context) = self.install_context.clone() {
builder = builder.integration_types(install_context);
}
if let Some(interaction_context) = self.interaction_context.clone() {
builder = builder.contexts(interaction_context);
}
Some(builder)
}
}