Struct CommandBuilder

pub struct CommandBuilder(/* private fields */);

Available on crate feature builder only.

Builder to create a [Command].

Implementations

impl CommandBuilder

pub fn new( name: impl Into<String>, description: impl Into<String>, kind: CommandType, ) -> Self

Create a new default [Command] builder.

pub fn build(self) -> Command

Consume the builder, returning a [Command].

pub fn validate(self) -> Result<Self, CommandValidationError>

Ensure the command is valid.

Errors

Refer to the errors section of [twilight_validate::command::command] for possible errors.

pub const fn guild_id(self, guild_id: Id<GuildMarker>) -> Self

Set the guild ID of the command.

Defaults to None.

pub fn contexts( self, contexts: impl IntoIterator<Item = InteractionContextType>, ) -> Self

Set the contexts of the command.

Defaults to nothing.

pub const fn default_member_permissions( self, default_member_permissions: Permissions, ) -> Self

Set the default member permission required to run the command.

Defaults to None.

pub const fn dm_permission(self, dm_permission: bool) -> Self

👎Deprecated: use contexts instead

Set whether the command is available in DMs.

Defaults to None.

pub fn description_localizations<K: Into<String>, V: Into<String>>( self, localizations: impl IntoIterator<Item = (K, V)>, ) -> Self

Set the localization dictionary for the command description.

Defaults to None.

pub fn integration_types( self, integration_types: impl IntoIterator<Item = ApplicationIntegrationType>, ) -> Self

Set the integration types for the command.

Defaults to None.

pub fn name_localizations<K: Into<String>, V: Into<String>>( self, localizations: impl IntoIterator<Item = (K, V)>, ) -> Self

Set the localization dictionary for the command name.

Defaults to None.

pub fn option(self, option: impl Into<CommandOption>) -> Self

Add an option to the command.

Defaults to an empty list.

pub const fn nsfw(self, nsfw: bool) -> Self

Set whether the command is age-restricted.

Defaults to not being specified, which uses Discord’s default.

Trait Implementations

impl Clone for CommandBuilder

fn clone(&self) -> CommandBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommandBuilder

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

Formats the value using the given formatter.