Struct ClientError 

pub struct ClientError {
    pub message: String,
    pub code: u16,
    pub rate_limit: Option<RateLimitError>,
}

Error type returned by the XYO SDK client.

Fields

message: String

code: u16

rate_limit: Option<RateLimitError>

Implementations

impl ClientError

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

Construct a new ClientError without rate limit details.

pub fn with_rate_limit( code: u16, message: impl Into<String>, rate_limit: RateLimitError, ) -> Self

Construct a new ClientError with rate limit details.

pub fn is_auth(&self) -> bool

Returns true if this error represents an authentication or authorization failure (HTTP 401 or 403).

pub fn is_rate_limited(&self) -> bool

Returns true if this error represents a rate limit or throttle (HTTP 429).

pub fn is_not_found(&self) -> bool

Returns true if this error represents a resource not found (HTTP 404).

pub fn is_server_error(&self) -> bool

Returns true if this error represents an internal server error (HTTP 5xx).

pub fn is_retryable(&self) -> bool

Returns true if the operation is transient and safe to retry.

Trait Implementations

impl Clone for ClientError

fn clone(&self) -> ClientError

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ClientError

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

Formats the value using the given formatter.

impl Display for ClientError

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

Formats the value using the given formatter.

impl Eq for ClientError

impl Error for ClientError

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 PartialEq for ClientError

fn eq(&self, other: &ClientError) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ClientError