Struct twilight_util::builder::command::ChannelBuilder

pub struct ChannelBuilder(_);

Available on crate feature builder only.

Create a channel option with a builder.

Implementations

impl ChannelBuilder

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

Create a new default ChannelBuilder.

pub fn build(self) -> CommandOption

Consume the builder, returning the built command option.

pub fn channel_types(
    self,
    channel_types: impl IntoIterator<Item = ChannelType>
) -> Self

Restricts the channel choice to specific types.

Defaults to all channel types allowed.

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 ChannelBuilder

fn clone(&self) -> ChannelBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelBuilder

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

Formats the value using the given formatter.

impl From<ChannelBuilder> for CommandOption

fn from(builder: ChannelBuilder) -> CommandOption

Converts to this type from the input type.