Struct Error

#[non_exhaustive]
pub struct Error {
    pub status_code: StatusCode,
    pub body: ErrorBody,
}

Available on (crate features client-api-c or client-api-s) and (crate features client or server) and crate feature api only.

A Matrix Error

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_code: StatusCode

The http status code.

body: ErrorBody

The http response’s body.

Implementations

impl Error

pub fn new(status_code: StatusCode, body: ErrorBody) -> Error

Constructs a new Error with the given status code and body.

This is equivalent to calling body.into_error(status_code).

pub fn error_kind(&self) -> Option<&ErrorKind>

If self is a server error in the errcode + error format expected for client-server API endpoints, returns the error kind (errcode).

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl EndpointError for Error

fn from_http_response<T>(response: Response<T>) -> Error

where T: AsRef<[u8]>,

Tries to construct Self from an http::Response.

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 UiaaResponse

fn from(error: Error) -> UiaaResponse

Converts to this type from the input type.

impl OutgoingResponse for Error

fn try_into_http_response<T>(self) -> Result<Response<T>, IntoHttpError>

where T: Default + BufMut,

Tries to convert this response into an http::Response.