Enum OpencodeError 

pub enum OpencodeError {
    Api {
        status: u16,
        headers: Option<Box<HeaderMap>>,
        body: Option<Box<Value>>,
        message: String,
    },
    Connection {
        message: String,
        source: Option<Box<dyn Error + Send + Sync>>,
    },
    Timeout,
    UserAbort,
    Serialization(Error),
    Http(Box<dyn Error + Send + Sync>),
}

Primary error type for the OpenCode SDK.

Models the JS SDK’s error hierarchy as a flat enum with variants for API errors (with status codes), connection errors, timeouts, user aborts, serialization errors, and generic HTTP transport errors.

Variants

Api

An API error returned by the server with an HTTP status code.

Fields

status: u16

headers: Option<Box<HeaderMap>>

body: Option<Box<Value>>

message: String

Connection

A connection-level error (DNS, TCP, TLS, etc.).

Fields

message: String

source: Option<Box<dyn Error + Send + Sync>>

Timeout

The request timed out.

UserAbort

The user aborted the request.

Serialization(Error)

Failed to serialize or deserialize JSON.

Http(Box<dyn Error + Send + Sync>)

An opaque HTTP transport error.

Implementations

impl OpencodeError

pub const fn status(&self) -> Option<u16>

Returns the HTTP status code if this is an Api variant.

pub const fn is_retryable(&self) -> bool

Whether this error should be retried.

Mirrors the JS SDK logic:

• Status 408, 409, 429, >= 500 → retryable
• Connection errors and timeouts → retryable
• Everything else → not retryable

pub const fn is_timeout(&self) -> bool

Whether this error represents a timeout.

pub fn bad_request( headers: Option<HeaderMap>, body: Option<Value>, message: impl Into<String>, ) -> Self

400 Bad Request

pub fn authentication( headers: Option<HeaderMap>, body: Option<Value>, message: impl Into<String>, ) -> Self

401 Authentication Error

pub fn permission_denied( headers: Option<HeaderMap>, body: Option<Value>, message: impl Into<String>, ) -> Self

403 Permission Denied

pub fn not_found( headers: Option<HeaderMap>, body: Option<Value>, message: impl Into<String>, ) -> Self

404 Not Found

pub fn conflict( headers: Option<HeaderMap>, body: Option<Value>, message: impl Into<String>, ) -> Self

409 Conflict

pub fn unprocessable_entity( headers: Option<HeaderMap>, body: Option<Value>, message: impl Into<String>, ) -> Self

422 Unprocessable Entity

pub fn rate_limit( headers: Option<HeaderMap>, body: Option<Value>, message: impl Into<String>, ) -> Self

429 Rate Limit

pub fn internal_server( status: u16, headers: Option<HeaderMap>, body: Option<Value>, message: impl Into<String>, ) -> Self

5xx Internal Server Error

pub fn from_response( status: u16, headers: Option<HeaderMap>, body: Option<Value>, ) -> Self

Create an error from an HTTP response’s status, headers, and body.

Maps well-known status codes to their specific constructors; falls through to a generic Api variant for other codes.

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.