Skip to main content

PrefixedCommandGroupBuilder

Struct PrefixedCommandGroupBuilder 

Source
pub struct PrefixedCommandGroupBuilder<State>
where State: StateBound,
{ /* private fields */ }
Expand description

A command group builder that allows setting optional fields.

Implementations§

Source§

impl<State> PrefixedCommandGroupBuilder<State>
where State: StateBound,

Source

pub fn summary(self, summary: impl Into<String>) -> Self

Sets the group’s summary, which is ideally a short one-line description of the group.

Arguments:

  • summary - The group’s summary.

Returns: PrefixedCommandGroupBuilder - The command group builder with the set summary.

Source

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

Sets the group’s description, which is ideally a more detailed description of the group.

Arguments:

  • description - The group’s description.

Returns: PrefixedCommandGroupBuilder - The command group builder with the set description.

Source

pub fn command(self, command: PrefixedCommandBuilder<State>) -> Self

Adds a command as a child of this group.

Arguments:

  • command - The command to add as a child of this group.

Returns: PrefixedCommandGroupBuilder - The command group builder with the added command.

Source

pub fn nest(self, group: PrefixedCommandGroupBuilder<State>) -> Self

Adds a subgroup as a child of this group.

Arguments:

  • group - The subgroup to add as a child of this group.

Returns: PrefixedCommandGroupBuilder - The command group builder with the added subgroup.

Source

pub fn on_error<F, Dummy, Error>(self, handler: F) -> Self
where F: ErrorHandler<State, Error> + 'static, Error: Send + Sync + 'static,

Sets an error handler for all of this group’s children.

Arguments:

  • handler - The error handler to set.

Returns: PrefixedCommandGroupBuilder - The current command group builder with the error handler added to the error handlers list.

Trait Implementations§

Source§

impl<State> CommandGroupIntoCommandNode<State> for PrefixedCommandGroupBuilder<State>
where State: StateBound,

Source§

fn into_command_node(self) -> CommandNode<State>

Converts the current type into a CommandNode. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more