Struct twilight_model::application::command::Command

pub struct Command {
    pub application_id: Option<Id<ApplicationMarker>>,
    pub default_member_permissions: Option<Permissions>,
    pub dm_permission: Option<bool>,
    pub description: String,
    pub description_localizations: Option<HashMap<String, String>>,
    pub guild_id: Option<Id<GuildMarker>>,
    pub id: Option<Id<CommandMarker>>,
    pub kind: CommandType,
    pub name: String,
    pub name_localizations: Option<HashMap<String, String>>,
    pub options: Vec<CommandOption>,
    pub version: Id<CommandVersionMarker>,
}

Data sent to Discord to create a command.

CommandOptions that are required must be listed before optional ones. Command names must be lower case, matching the Regex ^[\w-]{1,32}$. See Discord Docs/Application Command Object.

This struct has an associated builder in the twilight-util crate.

Fields

application_id: Option<Id<ApplicationMarker>>

default_member_permissions: Option<Permissions>

Default permissions required for a member to run the command.

Setting this Permissions::empty() will prohibit anyone from running the command, except for guild administrators.

dm_permission: Option<bool>

Whether the command is available in DMs.

This is only relevant for globally-scoped commands. By default, commands are visible in DMs.

description: String

Description of the command.

For User and Message commands, this will be an empty string.

description_localizations: Option<HashMap<String, String>>

Localization dictionary for the description field.

See Discord Docs/Localization.

guild_id: Option<Id<GuildMarker>>

Guild ID of the command, if not global.

id: Option<Id<CommandMarker>>

kind: CommandType

name: String

name_localizations: Option<HashMap<String, String>>

Localization dictionary for the name field.

Keys should be valid locales. See Discord Docs/Locales, Discord Docs/Localization.

options: Vec<CommandOption>

version: Id<CommandVersionMarker>

Autoincrementing version identifier.

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Command

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Command

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<Command> for Command

fn eq(&self, other: &Command) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Command

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Command