Struct twilight_util::builder::command::CommandBuilder

pub struct CommandBuilder(_);

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 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

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 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.

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.