Struct CommandOption

#[non_exhaustive]
pub struct CommandOption {

    pub kind: CommandOptionType,
    pub name: String,
    pub name_localizations: Option<HashMap<String, String>>,
    pub description: String,
    pub description_localizations: Option<HashMap<String, String>>,
    pub required: bool,
    pub choices: Vec<CommandOptionChoice>,
    pub options: Vec<CommandOption>,
    pub channel_types: Vec<ChannelType>,
    pub min_value: Option<Number>,
    pub max_value: Option<Number>,
    pub min_length: Option<u16>,
    pub max_length: Option<u16>,
    pub autocomplete: bool,
}

The parameters for an Command.

Discord docs.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

kind: CommandOptionType

The option type.

name: String

The option name.

name_localizations: Option<HashMap<String, String>>

Localizations of the option name with locale as the key

description: String

The option description.

description_localizations: Option<HashMap<String, String>>

Localizations of the option description with locale as the key

required: bool

Whether the parameter is optional or required.

choices: Vec<CommandOptionChoice>

Choices the user can pick from.

Note: Only available for String and Integer CommandOptionType.

options: Vec<CommandOption>

The nested options.

Note: Only available for SubCommand or SubCommandGroup.

channel_types: Vec<ChannelType>

If the option is a Channel, it will only be able to show these types.

min_value: Option<Number>

Minimum permitted value for Integer or Number options

max_value: Option<Number>

Maximum permitted value for Integer or Number options

min_length: Option<u16>

Minimum permitted length for String options

max_length: Option<u16>

Maximum permitted length for String options

autocomplete: bool

Trait Implementations

impl Clone for CommandOption

fn clone(&self) -> CommandOption

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CommandOption

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommandOption

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CommandOption

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.