Enum Error

#[non_exhaustive]
pub enum Error<E, F> {
    AuthenticationRequired,
    IntoHttp(IntoHttpError),
    Url(Error),
    Response(E),
    FromHttpResponse(FromHttpResponseError<F>),
}

Available on crate feature client only.

An error that can occur during client operations.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

AuthenticationRequired

Queried endpoint requires authentication but was called on an anonymous client.

IntoHttp(IntoHttpError)

Construction of the HTTP request failed (this should never happen).

Url(Error)

The request’s URL is invalid (this should never happen).

Response(E)

Couldn’t obtain an HTTP response (e.g. due to network or DNS issues).

FromHttpResponse(FromHttpResponseError<F>)

Converting the HTTP response to one of ruma’s types failed.

Implementations

impl<E> Error<E, Error>

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

Available on crate feature client-api only.

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<E, F> Debug for Error<E, F>

where E: Debug, F: Debug,

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

Formats the value using the given formatter.

impl<E, F> Display for Error<E, F>

where E: Display, F: Display,

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

Formats the value using the given formatter.

impl<E, F> Error for Error<E, F>

where E: Debug + Display, F: Debug + Display,

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<E, F> From<FromHttpResponseError<F>> for Error<E, F>

fn from(err: FromHttpResponseError<F>) -> Error<E, F>

Converts to this type from the input type.

impl<E, F> From<IntoHttpError> for Error<E, F>

fn from(err: IntoHttpError) -> Error<E, F>

Converts to this type from the input type.