Enum RunResult 

#[non_exhaustive]
pub enum RunResult {
    Handled(RunOutput),
    Binary(Vec<u8>, String),
    Silent,
    Error(RunError),
    NoMatch(ArgMatches),
}

Result of running the CLI dispatcher.

After processing arguments, the dispatcher either handles a command, surfaces an error, or falls through for manual handling.

Marked #[non_exhaustive] so future variants can be added without breaking exhaustive matchers.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Handled(RunOutput)

A handler processed the command successfully; contains the rendered output

Binary(Vec<u8>, String)

A handler produced binary output (bytes, suggested filename)

Silent

Silent output (handler completed but produced no output)

Error(RunError)

A handler, hook, or output step failed; contains the formatted error message. Consumers should write this to stderr and exit non-zero.

NoMatch(ArgMatches)

No handler matched; contains the ArgMatches for manual handling

Implementations

impl RunResult

pub fn is_handled(&self) -> bool

Returns true if a handler processed the command successfully (text output).

pub fn is_binary(&self) -> bool

Returns true if the result is binary output.

pub fn is_silent(&self) -> bool

Returns true if the result is silent.

pub fn is_error(&self) -> bool

Returns true if the result is an error.

pub fn output(&self) -> Option<&str>

Returns the output if handled, or None otherwise.

pub fn error(&self) -> Option<&str>

Returns the error message if this is an error, or None otherwise.

pub fn success_kind(&self) -> Option<SuccessKind>

Returns the typed success origin for captured text.

pub fn error_kind(&self) -> Option<RunErrorKind>

Returns the typed error origin, if this run failed.

pub fn exit_status(&self) -> Option<ExitStatus>

Returns the completed run’s shell status.

NoMatch returns None: it is a fallback handoff, not a completed framework execution and is deliberately not treated as a usage error.

pub fn binary(&self) -> Option<(&[u8], &str)>

Returns the binary data and filename if binary, or None otherwise.

pub fn matches(&self) -> Option<&ArgMatches>

Returns the matches if unhandled, or None if handled.

Trait Implementations

impl Debug for RunResult

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

Formats the value using the given formatter.