Skip to main content

CommandContext

Struct CommandContext 

Source
pub struct CommandContext {
    pub command_path: Vec<String>,
    pub extensions: Extensions,
}
Expand description

Context passed to command handlers.

Provides information about the execution environment plus an extensions container for injecting custom state via pre-dispatch hooks.

Note that output format is deliberately not included here - format decisions are made by the render handler, not by logic handlers.

§Extensions

Pre-dispatch hooks can inject state into extensions that handlers retrieve:

use standout_dispatch::{Hooks, HookError, CommandContext};

struct Database { /* ... */ }

let hooks = Hooks::new()
    .pre_dispatch(|_matches, ctx| {
        ctx.extensions.insert(Database { /* ... */ });
        Ok(())
    });

// In handler:
fn my_handler(matches: &clap::ArgMatches, ctx: &CommandContext) -> anyhow::Result<()> {
    let db = ctx.extensions.get_required::<Database>()?;
    // use db...
    Ok(())
}

Fields§

§command_path: Vec<String>

The command path being executed (e.g., [“config”, “get”])

§extensions: Extensions

Type-safe container for custom state injection.

Pre-dispatch hooks can insert values that handlers retrieve.

Trait Implementations§

Source§

impl Debug for CommandContext

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CommandContext

Source§

fn default() -> CommandContext

Returns the “default value” for a type. 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, 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.