Enum UniError 

pub enum UniError {
    Api {
        code: String,
        message: String,
        status: StatusCode,
        request_id: Option<String>,
        body: Option<Value>,
    },
    Http {
        status: StatusCode,
        message: String,
        request_id: Option<String>,
        body: Option<Value>,
    },
    Transport(Error),
    Configuration(String),
    InvalidResponse {
        status: StatusCode,
        request_id: Option<String>,
        message: String,
        body: String,
    },
}

Errors produced while configuring the client or calling the API.

Variants

Api

An API response contained a non-zero business error code.

Fields

code: String

Business error code returned by the API.

message: String

Human-readable error message returned by the API.

status: StatusCode

HTTP status of the response.

request_id: Option<String>

Unimatrix request ID used for support and diagnostics.

body: Option<Value>

Parsed response body, when one was available.

Http

The server returned a non-successful HTTP status without an API error.

Fields

status: StatusCode

Non-successful HTTP status.

message: String

HTTP or response message describing the failure.

request_id: Option<String>

Unimatrix request ID used for support and diagnostics.

body: Option<Value>

Parsed response body, or the raw body represented as a JSON string.

Transport(Error)

A transport-level error occurred.

Configuration(String)

The endpoint URL or client configuration was invalid.

InvalidResponse

A response could not be decoded according to the API schema.

Fields

status: StatusCode

HTTP status of the response.

request_id: Option<String>

Unimatrix request ID used for support and diagnostics.

message: String

Description of the response decoding failure.

body: String

Raw response body.

Implementations

impl UniError

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

API error code, when the server supplied one.

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

HTTP status associated with the error, when available.

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

Request ID that can be provided to Unimatrix support.

Trait Implementations

impl Debug for UniError

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

Formats the value using the given formatter.

impl Display for UniError

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

Formats the value using the given formatter.

impl Error for UniError

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 UniError

fn from(error: Error) -> Self

Converts to this type from the input type.