Skip to main content

CommandContext

Struct CommandContext 

Source
pub struct CommandContext {
    pub subcommand: String,
    pub positionals: Vec<String>,
    pub flags: HashMap<String, String>,
}
Expand description

Holds the parsed context for a command invocation.

Passed by reference to every command handler. Contains the resolved subcommand name, any positional arguments (non-flag tokens), and the full set of flags after alias resolution. Global flags registered on the app are merged in alongside command-specific flags.

Fields§

§subcommand: String

The subcommand name as typed by the user.

§positionals: Vec<String>

Positional arguments, in order, with flags filtered out.

§flags: HashMap<String, String>

Resolved flags, keyed by canonical name. Boolean flags have the value "true". Includes both command-specific flags and any global flags that were passed.

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