Struct ApiError 

#[non_exhaustive]
pub struct ApiError {
    pub status: StatusCode,
    pub problem_type: Option<String>,
    pub title: Option<String>,
    pub detail: Option<String>,
    pub errors: BTreeMap<String, Vec<String>>,
    pub request_id: Option<String>,
    pub retry_after: Option<Duration>,
}

A non-success HTTP response.

Its Display output contains only the status, so it is safe to log. The other fields hold untrusted server data.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

status: StatusCode

The HTTP status of the response.

problem_type: Option<String>

A URI identifying the problem type, such as https://docs.synthient.com/errors/unauthorized.

title: Option<String>

A short summary of the problem type.

detail: Option<String>

An explanation of this occurrence of the problem. For a plain-text error, such as the edge’s 401 for a malformed key, it is the response body.

errors: BTreeMap<String, Vec<String>>

Validation messages keyed by request field.

request_id: Option<String>

Identifies the request when contacting Synthient support.

retry_after: Option<Duration>

How long the server asked the client to wait before retrying.

Trait Implementations

impl Clone for ApiError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiError

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

Formats the value using the given formatter.

impl Display for ApiError

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

Formats the value using the given formatter.

impl Eq for ApiError

impl Error for ApiError

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 ApiError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ApiError