Enum CliCoreError 

pub enum CliCoreError {
    MissingAuthProvider(String),
    AuthProvider {
        provider: String,
        source: Box<dyn Error + Send + Sync>,
    },
    InvalidOutputFormat(String),
    Message(String),
    SystemMessage {
        message: String,
        system: String,
        code: String,
        request_id: String,
    },
    System {
        system: String,
        source: Box<dyn Error + Send + Sync>,
    },
    Detailed {
        code: String,
        system: String,
        request_id: String,
        next_actions: Vec<NextAction>,
        source: Box<dyn Error + Send + Sync>,
    },
    ExitCode {
        code: i32,
        source: Box<dyn Error + Send + Sync>,
    },
    Fix {
        fix: String,
        source: Box<dyn Error + Send + Sync>,
    },
    Io(Error),
    Json(Error),
    Transport(Error),
    EnvConfig(EnvConfigError),
}

Framework error type.

Variants

MissingAuthProvider(String)

Requested auth provider has not been registered.

AuthProvider

Auth provider failed.

Fields

provider: String

Provider name.

source: Box<dyn Error + Send + Sync>

Source error.

InvalidOutputFormat(String)

Output format is not supported.

Message(String)

Plain message error.

SystemMessage

Structured message with explicit envelope metadata.

Fields

message: String

Error message.

system: String

Backend/system id.

code: String

Stable error code.

request_id: String

Optional request id.

System

Wrapped source error with backend/system attribution.

Fields

system: String

Backend/system id.

source: Box<dyn Error + Send + Sync>

Source error.

Detailed

Wrapped source error with structured metadata captured up front.

Fields

code: String

Stable error code.

system: String

Backend/system id.

request_id: String

Optional request id.

next_actions: Vec<NextAction>

Structured follow-up actions captured from the source’s DetailedError::error_next_actions at wrap time — the source is erased to Box<dyn Error> immediately below, so this can’t be recovered later by downcasting.

source: Box<dyn Error + Send + Sync>

Source error.

ExitCode

Wrapped source error with explicit process exit code.

Fields

code: i32

Process-style exit code.

source: Box<dyn Error + Send + Sync>

Source error.

Fix

Wrapped source error with a recovery hint for the output envelope.

Fields

fix: String

Recovery guidance shown as the envelope’s top-level fix.

source: Box<dyn Error + Send + Sync>

Source error.

Io(Error)

IO error.

Json(Error)

JSON serialization or decoding error.

Transport(Error)

Structured HTTP transport error.

EnvConfig(EnvConfigError)

An EnvConfig struct failed to assemble from its SourceChain.

Implementations

impl CliCoreError

pub fn message(message: impl Into<String>) -> Self

Creates a plain message error.

pub fn message_for_system( system: impl Into<String>, message: impl Into<String>, ) -> Self

Creates a structured message attributed to a backend/system id.

pub fn with_system( system: impl Into<String>, source: impl Error + Send + Sync + 'static, ) -> Self

Wraps a source error with backend/system attribution.

pub fn with_exit_code( code: i32, source: impl Error + Send + Sync + 'static, ) -> Self

Wraps a source error with an explicit process exit code.

pub fn with_fix( fix: impl Into<String>, source: impl Error + Send + Sync + 'static, ) -> Self

Wraps a source error with a recovery hint for the output envelope.

Empty hints do not wrap: a CliCoreError source is returned as-is.

pub fn with_detailed_error( source: impl DetailedError + Send + Sync + 'static, ) -> Self

Captures structured metadata from a detailed source error.

pub fn is_auth(&self) -> bool

Reports whether this error originates from credential resolution.

True for MissingAuthProvider and AuthProvider, including when those variants are wrapped by Fix or ExitCode. The engine uses this to classify a command outcome as auth-error rather than a generic command error, based on the error a handler actually returns — so a handler that swallows a resolution failure and then fails for another reason is not misclassified.

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

Returns backend/system attribution when the error carries one.

Fix / ExitCode wrappers delegate to their source.

Trait Implementations

impl Debug for CliCoreError

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

Formats the value using the given formatter.

impl Display for CliCoreError

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

Formats the value using the given formatter.

impl Error for CliCoreError

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 ExitCoder for CliCoreError

fn exit_code(&self) -> i32

Returns the process-style exit code for the error.

impl From<CliCoreError> for EnvConfigError

fn from(err: CliCoreError) -> Self

Converts to this type from the input type.

impl From<CliCoreError> for Value

fn from(error: CliCoreError) -> Self

Converts to this type from the input type.

impl From<EnvConfigError> for CliCoreError

fn from(source: EnvConfigError) -> Self

Converts to this type from the input type.

impl From<Error> for CliCoreError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for CliCoreError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for CliCoreError

fn from(source: Error) -> Self

Converts to this type from the input type.