Enum ObzError 

pub enum ObzError {
    Provider {
        code: ErrorCode,
        message: String,
        raw_error: Option<String>,
        recoverable: bool,
        suggestion: Option<String>,
        doc_url: Option<String>,
    },
    Auth {
        code: ErrorCode,
        message: String,
        recoverable: bool,
        suggestion: Option<String>,
    },
    InvalidArgument {
        code: ErrorCode,
        message: String,
        suggestion: Option<String>,
    },
    Network {
        code: ErrorCode,
        message: String,
        recoverable: bool,
        source_chain: Option<Vec<String>>,
    },
    Unsupported {
        message: String,
        provider: Option<String>,
        suggestion: Option<String>,
    },
}

The core error type for obz-core operations.

Uses thiserror for ergonomic error handling. Each variant carries enough information to produce a structured ErrorDetail for the response envelope.

Variants

Provider

Provider returned an error.

Fields

code: ErrorCode

Machine-readable error code.

message: String

Human-readable message.

raw_error: Option<String>

Raw backend error response.

recoverable: bool

Whether a retry might succeed.

suggestion: Option<String>

Suggested fix.

doc_url: Option<String>

Documentation URL.

Auth

Authentication error.

Fields

code: ErrorCode

Machine-readable error code.

message: String

Human-readable message.

recoverable: bool

Whether the caller can recover by retrying the same request.

Set true only when the underlying cause has already been resolved (e.g. credential-process refreshed expired credentials). All other auth errors should use false — downstream consumers (AI Agents) may auto-retry based on this flag.

suggestion: Option<String>

Suggested fix.

InvalidArgument

Invalid CLI arguments.

Fields

code: ErrorCode

Machine-readable error code.

message: String

Human-readable message.

suggestion: Option<String>

Suggested fix.

Network

Network error.

Fields

code: ErrorCode

Machine-readable error code.

message: String

Human-readable message.

recoverable: bool

Whether a retry might succeed.

source_chain: Option<Vec<String>>

Error source chain from the underlying library error.

Unsupported

Operation not supported by this provider.

Fields

message: String

Human-readable message.

provider: Option<String>

The provider that doesn’t support this operation.

suggestion: Option<String>

Suggested fix.

Implementations

impl ObzError

pub fn to_error_detail(&self, provider: Option<&str>) -> ErrorDetail

Convert this error into a structured ErrorDetail for JSON output.

provider is injected into ErrorDetail.provider only when the variant does not already carry one (e.g. [Unsupported] sets its own provider, which takes precedence over the caller-supplied value).

Trait Implementations

impl Debug for ObzError

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

Formats the value using the given formatter.

impl Display for ObzError

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

Formats the value using the given formatter.

impl Error for ObzError

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<ObzError> for ExecuteError

fn from(source: ObzError) -> Self

Converts to this type from the input type.