Struct CommandContext 

#[non_exhaustive]
pub struct CommandContext {
    pub credential: Option<Credential>,
    pub args: ValueMap,
    pub user_args: ValueMap,
    pub command_path: String,
    pub middleware: Middleware,
    pub raw_matches: Arc<ArgMatches>,
}

Runtime context passed to advanced command handlers.

Most commands can use RuntimeCommandSpec::new and receive just the credential and effective args. Use this context when a command needs the colon path, user-supplied args, or a snapshot of middleware state.

This struct is constructed by the framework during command dispatch. Consumer code receives it in handler closures and should not construct it directly.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

credential: Option<Credential>

Credential resolved by middleware. No-auth commands receive None.

args: ValueMap

Effective arguments, including defaults and framework-injected values.

user_args: ValueMap

Arguments explicitly supplied by the user.

command_path: String

Colon-separated command path such as project:list.

middleware: Middleware

Middleware snapshot for this invocation.

raw_matches: Arc<ArgMatches>

Raw clap matches for typed argument deserialization via derive.

Implementations

impl CommandContext

pub fn typed_args<T: FromArgMatches>(&self) -> Result<T>

Deserializes the raw argument matches into a typed args struct.

Use this with #[derive(clap::Args)] structs to get type-safe access to command arguments instead of working with the ValueMap directly.

Errors

Returns an error if the matches cannot be deserialized into T.

Trait Implementations

impl Clone for CommandContext

fn clone(&self) -> CommandContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandContext

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

Formats the value using the given formatter.