Command

Struct Command 

Source
pub struct Command {
    pub info: CommandInfo,
    pub args: Vec<Arg>,
    pub subcommands: Vec<Command>,
    pub hooks: Hooks,
}

Fields§

§info: CommandInfo§args: Vec<Arg>§subcommands: Vec<Command>§hooks: Hooks

Implementations§

Source§

impl Command

Source

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

Create a new command with the given name

Source

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

Source

pub fn aliases(self, aliases: Vec<String>) -> Self

Source

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

Source

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

Source

pub fn arg(self, arg: Arg) -> Self

Add an argument (positional, flag, or option)

Source

pub fn subcommand(self, command: Command) -> Self

Source

pub fn run(self, f: Box<dyn Fn(&mut dyn Context) -> Result<()>>) -> Self

Source

pub fn pre_run(self, f: Box<dyn Fn(&mut dyn Context) -> Result<()>>) -> Self

Source

pub fn post_run(self, f: Box<dyn Fn(&mut dyn Context) -> Result<()>>) -> Self

Source

pub fn is_leaf(&self) -> bool

Check if this is a leaf command (no subcommands)

Source

pub fn execute(&self, ctx: &mut dyn Context) -> Result<()>

Execute the command with the given context

Runs hooks in order: pre_run -> run -> post_run

Auto Trait Implementations§

§

impl Freeze for Command

§

impl !RefUnwindSafe for Command

§

impl !Send for Command

§

impl !Sync for Command

§

impl Unpin for Command

§

impl !UnwindSafe for Command

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