Enum OpenCodeError 

pub enum OpenCodeError {
    CliNotFound(String),
    CliExecution(String),
    CliExitError {
        code: i32,
        stderr: String,
    },
    Timeout(u64),
    OutputParse(String),
    Json(Error),
    Io(Error),
    InvalidConfig(String),
    McpError(String),
    AuthRequired,
    NoResults(String),
    RateLimited,
    ModelUnavailable(String),
    FileCollection(String),
}

Errors that can occur when using OpenCode CLI

Variants

CliNotFound(String)

OpenCode CLI binary not found

CliExecution(String)

CLI execution failed

CliExitError

CLI returned non-zero exit code

Fields

code: i32

stderr: String

Timeout(u64)

CLI timed out

OutputParse(String)

Failed to parse CLI output

Json(Error)

Failed to serialize/deserialize JSON

Io(Error)

IO error during file operations

InvalidConfig(String)

Invalid configuration

McpError(String)

MCP server error

AuthRequired

Authentication required

NoResults(String)

No results found

RateLimited

Rate limit exceeded

ModelUnavailable(String)

Model not available

FileCollection(String)

File collection error

Implementations

impl OpenCodeError

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

Create a CLI execution error

pub fn exit_error(code: i32, stderr: impl Into<String>) -> Self

Create a CLI exit error

pub fn timeout(seconds: u64) -> Self

Create a timeout error

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

Create a parse error

pub fn is_retryable(&self) -> bool

Check if error is retryable

pub fn needs_auth(&self) -> bool

Check if error requires authentication

pub fn is_config_error(&self) -> bool

Check if this is a configuration error

Trait Implementations

impl Debug for OpenCodeError

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

Formats the value using the given formatter.

impl Display for OpenCodeError

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

Formats the value using the given formatter.

impl Error for OpenCodeError

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 OpenCodeError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for OpenCodeError

fn from(source: Error) -> Self

Converts to this type from the input type.