Enum ruma_client_api::error::ErrorBody

pub enum ErrorBody {
    Standard {
        kind: ErrorKind,
        message: String,
    },
    Json(Value),
    NotJson {
        bytes: Bytes,
        deserialization_error: Arc<Error>,
    },
}

Available on crate features client or server only.

The body of a Matrix Client API error.

Variants

Standard

A JSON body with the fields expected for Client API errors.

Fields

kind: ErrorKind

A value which can be used to handle an error message.

message: String

A human-readable error message, usually a sentence explaining what went wrong.

Json(Value)

A JSON body with an unexpected structure.

NotJson

A response body that is not valid JSON.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

bytes: Bytes

The raw bytes of the response body.

deserialization_error: Arc<Error>

The error from trying to deserialize the bytes as JSON.

Implementations

impl ErrorBody

pub fn into_error(self, status_code: StatusCode) -> Error

Convert the ErrorBody into an Error by adding the http status code.

This is equivalent to calling Error::new(status_code, self).

Trait Implementations

impl Clone for ErrorBody

fn clone(&self) -> ErrorBody

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorBody

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

Formats the value using the given formatter.