Enum ExecutionError 

pub enum ExecutionError {
    HandlerNotFound {
        command: String,
        implementation: String,
        suggestion: Option<String>,
    },
    ContextDowncastFailed {
        expected_type: String,
        suggestion: Option<String>,
    },
    InvalidContextState {
        reason: String,
        suggestion: Option<String>,
    },
    CommandFailed(Error),
    Interrupted,
}

Errors during command execution

These errors occur during user code execution.

Variants

HandlerNotFound

Command handler not found

The implementation name in the config doesn’t match any registered handler.

Example

use dynamic_cli::error::ExecutionError;

let error = ExecutionError::HandlerNotFound {
    command: "run".to_string(),
    implementation: "run_handler".to_string(),
    suggestion: Some(
        "Ensure .register_handler(\"run_handler\", ...) was called before running."
            .to_string()
    ),
};
let msg = format!("{}", error);
assert!(msg.contains("run"));

Fields

command: String

implementation: String

suggestion: Option<String>

Actionable hint surfaced to the user (not part of the Display string)

ContextDowncastFailed

Error during context downcasting

The handler tried to downcast the context to an incorrect type.

Example

use dynamic_cli::error::ExecutionError;

let error = ExecutionError::ContextDowncastFailed {
    expected_type: "MyAppContext".to_string(),
    suggestion: Some(
        "Check that the context type passed to the handler matches the expected type."
            .to_string()
    ),
};
let msg = format!("{}", error);
assert!(msg.contains("MyAppContext"));

Fields

expected_type: String

suggestion: Option<String>

Actionable hint surfaced to the user (not part of the Display string)

InvalidContextState

Invalid context state for this operation

Example

use dynamic_cli::error::ExecutionError;

let error = ExecutionError::InvalidContextState {
    reason: "connection pool not initialised".to_string(),
    suggestion: Some("Ensure the context is fully initialised before running commands.".to_string()),
};
let msg = format!("{}", error);
assert!(msg.contains("connection pool"));

Fields

reason: String

suggestion: Option<String>

Actionable hint surfaced to the user (not part of the Display string)

CommandFailed(Error)

Error in command implementation

Wraps errors from user code.

Interrupted

Command interrupted by user

User pressed Ctrl+C during execution.

Implementations

impl ExecutionError

pub fn handler_not_found(command: &str, implementation: &str) -> Self

Create a handler-not-found error with an actionable suggestion

The suggestion interpolates the implementation name so the user knows exactly which .register_handler() call is missing.

Example

use dynamic_cli::error::ExecutionError;

let error = ExecutionError::handler_not_found("run", "run_handler");
match error {
    ExecutionError::HandlerNotFound { suggestion, .. } => {
        assert!(suggestion.as_deref().unwrap_or("").contains("run_handler"));
    }
    _ => panic!("wrong variant"),
}

Trait Implementations

impl Debug for ExecutionError

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

Formats the value using the given formatter.

impl Display for ExecutionError

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

Formats the value using the given formatter.

impl Error for ExecutionError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<ExecutionError> for DynamicCliError

fn from(source: ExecutionError) -> Self

Converts to this type from the input type.