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 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
use std::{borrow::Cow, collections::HashMap};
use twilight_model::{
application::{
command::{Command, CommandOption, CommandOptionType, CommandType},
interaction::application_command::InteractionChannel,
},
channel::Attachment,
guild::{Permissions, Role},
id::{
marker::{AttachmentMarker, ChannelMarker, GenericMarker, RoleMarker, UserMarker},
Id,
},
user::User,
};
use super::{internal::CreateOptionData, ResolvedUser};
/// Create a slash command from a type.
///
/// This trait is used to create commands from command models. A derive
/// macro is provided to automatically implement the traits.
///
/// ## Types and fields documentation
/// The trait can be derived on structs whose fields implement [`CreateOption`]
/// (see the [module documentation](crate::command) for a list of supported
/// types) or enums whose variants implement [`CreateCommand`].
///
/// Unlike the [`CommandModel`] trait, all fields or variants of the type it's
/// implemented on must have a description. The description corresponds either
/// to the first line of the documentation comment or the value of the `desc`
/// attribute. The type must also be named with the `name` attribute.
///
/// ## Example
/// ```
/// # use twilight_model::guild::Permissions;
/// use twilight_interactions::command::{CreateCommand, ResolvedUser};
///
/// #[derive(CreateCommand)]
/// #[command(
/// name = "hello",
/// desc = "Say hello",
/// default_permissions = "hello_permissions"
/// )]
/// struct HelloCommand {
/// /// The message to send.
/// message: String,
/// /// The user to send the message to.
/// user: Option<ResolvedUser>,
/// }
///
/// fn hello_permissions() -> Permissions {
/// Permissions::SEND_MESSAGES
/// }
/// ```
///
/// ## Macro attributes
/// The macro provides a `#[command]` attribute to provide additional
/// information.
///
/// | Attribute | Type | Location | Description |
/// |----------------------------|---------------------|------------------------|-----------------------------------------------------------------|
/// | `name` | `str` | Type | Name of the command (required). |
/// | `desc` | `str` | Type / Field / Variant | Description of the command (required). |
/// | `default_permissions` | `fn`[^perms] | Type | Default permissions required by members to run the command. |
/// | `dm_permission` | `bool` | Type | Whether the command can be run in DMs. |
/// | `nsfw` | `bool` | Type | Whether the command is age-restricted.
/// | `rename` | `str` | Field | Use a different option name than the field name. |
/// | `name_localizations` | `fn`[^localization] | Type / Field / Variant | Localized name of the command (optional). |
/// | `desc_localizations` | `fn`[^localization] | Type / Field / Variant | Localized description of the command (optional). |
/// | `autocomplete` | `bool` | Field | Enable autocomplete on this field. |
/// | `channel_types` | `str` | Field | Restricts the channel choice to specific types.[^channel_types] |
/// | `max_value`, `min_value` | `i64` or `f64` | Field | Set the maximum and/or minimum value permitted. |
/// | `max_length`, `min_length` | `u16` | Field | Maximum and/or minimum string length permitted. |
///
/// [^perms]: Path to a function that returns [`Permissions`].
///
/// [^localization]: Path to a function that returns a type that implements
/// `IntoIterator<Item = (ToString, ToString)>`. See the module documentation to
/// learn more.
///
/// [^channel_types]: List of [`ChannelType`] names in snake_case separated by spaces
/// like `guild_text private`.
///
/// [`CommandModel`]: super::CommandModel
/// [`ChannelType`]: twilight_model::channel::ChannelType
pub trait CreateCommand: Sized {
/// Name of the command.
const NAME: &'static str;
/// Create an [`ApplicationCommandData`] for this type.
fn create_command() -> ApplicationCommandData;
}
/// Create a command option from a type.
///
/// This trait is used by the implementation of [`CreateCommand`] generated
/// by the derive macro. See the [module documentation](crate::command) for
/// a list of implemented types.
///
/// ## Option choices
/// This trait can be derived on enums to represent command options with
/// predefined choices. The `#[option]` attribute must be present on each
/// variant.
///
/// ### Example
/// ```
/// use twilight_interactions::command::CreateOption;
///
/// #[derive(CreateOption)]
/// enum TimeUnit {
/// #[option(name = "Minute", value = 60)]
/// Minute,
/// #[option(name = "Hour", value = 3600)]
/// Hour,
/// #[option(name = "Day", value = 86400)]
/// Day,
/// }
/// ```
///
/// ### Macro attributes
/// The macro provides an `#[option]` attribute to configure the generated code.
///
/// | Attribute | Type | Location | Description |
/// |----------------------|-----------------------|----------|----------------------------------------------|
/// | `name` | `str` | Variant | Set the name of the command option choice. |
/// | `name_localizations` | `fn`[^localization] | Variant | Localized name of the command option choice. |
/// | `value` | `str`, `i64` or `f64` | Variant | Value of the command option choice. |
///
/// [^localization]: Path to a function that returns a type that implements
/// `IntoIterator<Item = (ToString, ToString)>`. See the
/// [module documentation](crate::command) to learn more.
pub trait CreateOption: Sized {
/// Create a [`CommandOption`] from this type.
fn create_option(data: CreateOptionData) -> CommandOption;
}
/// Data sent to Discord to create a command.
///
/// This type is used in the [`CreateCommand`] trait.
/// To convert it into a [`Command`], use the [From] (or [Into]) trait.
#[derive(Debug, Clone, PartialEq)]
pub struct ApplicationCommandData {
/// Name of the command. It must be 32 characters or less.
pub name: String,
/// Localization dictionary for the command name. Keys must be valid
/// locales.
pub name_localizations: Option<HashMap<String, String>>,
/// Description of the command. It must be 100 characters or less.
pub description: String,
/// Localization dictionary for the command description. Keys must be valid
/// locales.
pub description_localizations: Option<HashMap<String, String>>,
/// List of command options.
pub options: Vec<CommandOption>,
/// Whether the command is available in DMs.
pub dm_permission: Option<bool>,
/// Default permissions required for a member to run the command.
pub default_member_permissions: Option<Permissions>,
/// Whether the command is a subcommand group.
pub group: bool,
/// Whether the command is nsfw.
pub nsfw: Option<bool>,
}
impl From<ApplicationCommandData> for Command {
fn from(item: ApplicationCommandData) -> Self {
Command {
application_id: None,
guild_id: None,
name: item.name,
name_localizations: item.name_localizations,
default_member_permissions: item.default_member_permissions,
dm_permission: item.dm_permission,
description: item.description,
description_localizations: item.description_localizations,
id: None,
kind: CommandType::ChatInput,
nsfw: item.nsfw,
options: item.options,
version: Id::new(1),
}
}
}
impl From<ApplicationCommandData> for CommandOption {
fn from(item: ApplicationCommandData) -> Self {
let data = CreateOptionData {
name: item.name,
name_localizations: item.name_localizations,
description: item.description,
description_localizations: item.description_localizations,
required: None,
autocomplete: false,
data: Default::default(),
};
if item.group {
data.builder(CommandOptionType::SubCommandGroup)
.options(item.options)
.build()
} else {
data.builder(CommandOptionType::SubCommand)
.options(item.options)
.build()
}
}
}
impl CreateOption for String {
fn create_option(data: CreateOptionData) -> CommandOption {
data.into_option(CommandOptionType::String)
}
}
impl<'a> CreateOption for Cow<'a, str> {
fn create_option(data: CreateOptionData) -> CommandOption {
data.into_option(CommandOptionType::String)
}
}
impl CreateOption for i64 {
fn create_option(data: CreateOptionData) -> CommandOption {
data.into_option(CommandOptionType::Integer)
}
}
impl CreateOption for f64 {
fn create_option(data: CreateOptionData) -> CommandOption {
data.into_option(CommandOptionType::Number)
}
}
impl CreateOption for bool {
fn create_option(data: CreateOptionData) -> CommandOption {
data.into_option(CommandOptionType::Boolean)
}
}
impl CreateOption for Id<UserMarker> {
fn create_option(data: CreateOptionData) -> CommandOption {
data.into_option(CommandOptionType::User)
}
}
impl CreateOption for Id<ChannelMarker> {
fn create_option(data: CreateOptionData) -> CommandOption {
data.into_option(CommandOptionType::Channel)
}
}
impl CreateOption for Id<RoleMarker> {
fn create_option(data: CreateOptionData) -> CommandOption {
data.into_option(CommandOptionType::Role)
}
}
impl CreateOption for Id<GenericMarker> {
fn create_option(data: CreateOptionData) -> CommandOption {
data.into_option(CommandOptionType::Mentionable)
}
}
impl CreateOption for Id<AttachmentMarker> {
fn create_option(data: CreateOptionData) -> CommandOption {
data.into_option(CommandOptionType::Attachment)
}
}
impl CreateOption for Attachment {
fn create_option(data: CreateOptionData) -> CommandOption {
data.into_option(CommandOptionType::Attachment)
}
}
impl CreateOption for User {
fn create_option(data: CreateOptionData) -> CommandOption {
data.into_option(CommandOptionType::User)
}
}
impl CreateOption for ResolvedUser {
fn create_option(data: CreateOptionData) -> CommandOption {
data.into_option(CommandOptionType::User)
}
}
impl CreateOption for InteractionChannel {
fn create_option(data: CreateOptionData) -> CommandOption {
data.into_option(CommandOptionType::Channel)
}
}
impl CreateOption for Role {
fn create_option(data: CreateOptionData) -> CommandOption {
data.into_option(CommandOptionType::Role)
}
}