Struct twilight_util::builder::command::NumberBuilder

pub struct NumberBuilder(_);

Available on crate feature builder only.

Create a number option with a builder.

Implementations

impl NumberBuilder

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

Create a new default NumberBuilder.

pub fn build(self) -> CommandOption

Consume the builder, returning the built command option.

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

Set whether this option supports autocomplete.

Defaults to false.

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

Set localization for a particular choice, by name.

Choices must be set with the choices method before updating their localization.

pub fn choices<K: Into<String>>(
    self,
    choices: impl IntoIterator<Item = (K, f64)>
) -> Self

Set the list of choices for an option.

Accepts tuples of (String, f64) corresponding to the name and value. Localization may be added with choice_localizations.

Defaults to no choices.

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 const fn max_value(self, value: f64) -> Self

Set the maximum value permitted.

Defaults to no limit.

pub const fn min_value(self, value: f64) -> Self

Set the minimum value permitted.

Defaults to no limit.

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 NumberBuilder

fn clone(&self) -> NumberBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NumberBuilder

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

Formats the value using the given formatter.

impl From<NumberBuilder> for CommandOption

fn from(builder: NumberBuilder) -> CommandOption

Converts to this type from the input type.