Enum Error 

pub enum Error {
    Http(Error),
    Api {
        status: u16,
        code: String,
        message: String,
    },
    Deserialize(String),
    Sse(String),
    Exhausted {
        attempts: u32,
        source: Box<Error>,
    },
}

SDK error type.

Distinguishes between network errors, API errors (with status code and structured body), and deserialization errors.

Examples

use ironflow_sdk::Error;

let err = Error::api(404, "RUN_NOT_FOUND", "run not found");
assert!(err.is_api_error());

Variants

Http(Error)

HTTP transport error (network unreachable, DNS, TLS, timeout).

Api

The API returned an error response with a structured body.

Fields

status: u16

HTTP status code.

code: String

Machine-readable error code.

message: String

Human-readable error message.

Deserialize(String)

Failed to deserialize the response body.

Sse(String)

SSE stream error.

Exhausted

All retry attempts exhausted.

Fields

attempts: u32

Number of attempts made.

source: Box<Error>

The last error encountered.

Implementations

impl Error

pub fn api( status: u16, code: impl Into<String>, message: impl Into<String>, ) -> Self

Create an API error from its components.

pub fn is_api_error(&self) -> bool

Returns true if this is an API error (not a transport error).

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

Returns the HTTP status code if this is an API error (or an Exhausted wrapping one).

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

Returns the API error code if this is an API error.

pub fn is_exhausted(&self) -> bool

Returns true if all retry attempts were exhausted.

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.