Struct Context 

pub struct Context { /* private fields */ }

Context for Clawless commands

This struct provides information about the environment that Clawless commands are executed in, access to shared resources, and configuration settings. It is passed to each command by the Clawless runtime when executing commands.

Examples

#[derive(Debug, Args)]
pub struct GreetArgs {
    name: String,
}

#[command]
pub async fn greet(args: GreetArgs, context: Context) -> CommandResult {
    message!("Hello, {}!", args.name);
    Ok(())
}

Implementations

impl Context

pub fn current_working_directory(&self) -> &CurrentWorkingDirectory

The working directory in which a command was called

pub fn cancellation(&self) -> &Cancellation

The cancellation token for cooperative shutdown

pub fn output(&self) -> &Output

The output handler for sending events to the presenter

impl Context

pub fn builder() -> ContextBuilder

Creates a new Context instance

When current_working_directory is omitted, it is auto-detected from the environment. When provided explicitly (e.g., in tests), the given value is used directly.

Errors

Returns ContextError::CurrentWorkingDirectory if current_working_directory is not provided and the current working directory cannot be determined from the environment.

Examples

// Production: CWD auto-detected
let context = Context::builder()
    .output(output)
    .build()?;

// Tests: explicit CWD
let context = Context::builder()
    .current_working_directory(tmp.path())
    .output(output)
    .build()?;

Trait Implementations

impl Clone for Context

fn clone(&self) -> Context

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Context

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

Formats the value using the given formatter.