Enum Error 

pub enum Error {
    CliNotFound(String),
    Spawn(String),
    Process {
        detail: String,
        stderr: String,
        code: Option<i32>,
    },
    JsonParse(String),
    ThreadRun(String),
    InvalidOutputSchema(String),
    InvalidConfig(String),
    Cancelled,
    Io(Error),
    Json(Error),
}

Unified error type for all Codex SDK operations.

Variants

CliNotFound(String)

The codex executable could not be resolved.

Spawn(String)

Spawning the Codex subprocess failed.

Process

The Codex subprocess exited unsuccessfully.

Fields

detail: String

Human-readable exit detail such as code 2 or signal termination.

stderr: String

Full stderr output captured from the Codex subprocess.

code: Option<i32>

Numeric exit code when available.

JsonParse(String)

A line from stdout could not be decoded as JSON.

ThreadRun(String)

A thread turn failed according to Codex turn-level error events.

InvalidOutputSchema(String)

The provided output schema is invalid.

InvalidConfig(String)

A config override cannot be represented as Codex CLI TOML literal flags.

Cancelled

The caller cancelled an in-flight turn.

Io(Error)

Wrapper for I/O errors while interacting with the subprocess or temp files.

Json(Error)

Wrapper for JSON serialization/deserialization errors.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.