Struct UserBuilder

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

Available on crate feature builder only.

Create a user option with a builder.

Implementations

impl UserBuilder

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

Create a new default UserBuilder.

pub fn build(self) -> CommandOption

Consume the builder, returning the built command option.

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

Set the localization dictionary for the option 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 option name.

Defaults to None.

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

Set whether this option is required.

Defaults to false.

Trait Implementations

impl Clone for UserBuilder

fn clone(&self) -> UserBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserBuilder

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

Formats the value using the given formatter.

impl From<UserBuilder> for CommandOption

fn from(builder: UserBuilder) -> CommandOption

Converts to this type from the input type.