Enum Error

#[non_exhaustive]
pub enum Error {
    Http(HttpError),
    AuthenticationRequired,
    InsufficientData,
    BadCryptoStoreState,
    NoOlmMachine,
    SerdeJson(Error),
    Io(Error),
    CryptoStoreError(CryptoStoreError),
    CrossProcessLockError(LockStoreError),
    OlmError(OlmError),
    MegolmError(MegolmError),
    DecryptorError(DecryptorError),
    StateStore(StoreError),
    EventCacheStore(EventCacheStoreError),
    Identifier(IdParseError),
    Url(ParseError),
    QrCodeScanError(ScanError),
    UserTagName(InvalidUserTagName),
    SlidingSync(Error),
    WrongRoomState(WrongRoomState),
    MultipleSessionCallbacks,
    Oidc(OidcError),
    ConcurrentRequestFailed,
    UnknownError(Box<dyn Error + Send + Sync>),
    EventCache(EventCacheError),
    SendQueueWedgeError(QueueWedgeError),
    BackupNotEnabled,
    Media(MediaError),
}

Internal representation of errors.

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.

Http(HttpError)

Error doing an HTTP request.

AuthenticationRequired

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

InsufficientData

This request failed because the local data wasn’t sufficient.

BadCryptoStoreState

Available on crate feature e2e-encryption only.

Attempting to restore a session after the olm-machine has already been set up fails

NoOlmMachine

Available on crate feature e2e-encryption only.

Attempting to access the olm-machine but it is not yet available.

SerdeJson(Error)

An error de/serializing type for the StateStore

Io(Error)

An IO error happened.

CryptoStoreError(CryptoStoreError)

Available on crate feature e2e-encryption only.

An error occurred in the crypto store.

CrossProcessLockError(LockStoreError)

An error occurred with a cross-process store lock.

OlmError(OlmError)

Available on crate feature e2e-encryption only.

An error occurred during a E2EE operation.

MegolmError(MegolmError)

Available on crate feature e2e-encryption only.

An error occurred during a E2EE group operation.

DecryptorError(DecryptorError)

Available on crate feature e2e-encryption only.

An error occurred during decryption.

StateStore(StoreError)

An error occurred in the state store.

EventCacheStore(EventCacheStoreError)

An error occurred in the event cache store.

Identifier(IdParseError)

An error encountered when trying to parse an identifier.

Url(ParseError)

An error encountered when trying to parse a url.

QrCodeScanError(ScanError)

Available on crate feature qrcode only.

An error while scanning a QR code.

UserTagName(InvalidUserTagName)

An error encountered when trying to parse a user tag name.

SlidingSync(Error)

Available on crate feature experimental-sliding-sync only.

An error occurred within sliding-sync

WrongRoomState(WrongRoomState)

Attempted to call a method on a room that requires the user to have a specific membership state in the room, but the membership state is different.

MultipleSessionCallbacks

Session callbacks have been set multiple times.

Oidc(OidcError)

Available on crate feature experimental-oidc only.

An error occurred interacting with the OpenID Connect API.

ConcurrentRequestFailed

A concurrent request to a deduplicated request has failed.

UnknownError(Box<dyn Error + Send + Sync>)

An other error was raised.

This might happen because encryption was enabled on the base-crate but not here and that raised.

EventCache(EventCacheError)

An error coming from the event cache subsystem.

SendQueueWedgeError(QueueWedgeError)

An item has been wedged in the send queue.

BackupNotEnabled

Backups are not enabled

Media(MediaError)

An error happened during handling of a media subrequest.

Implementations

impl Error

pub fn as_ruma_api_error(&self) -> Option<&RumaApiError>

If self is Http(Api(Server(e))), returns Some(e).

Otherwise, returns None.

pub fn as_client_api_error(&self) -> Option<&Error>

Shorthand for .as_ruma_api_error().and_then(RumaApiError::as_client_api_error).

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

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

pub fn as_uiaa_response(&self) -> Option<&UiaaInfo>

Try to destructure the error into an universal interactive auth info.

Some requests require universal interactive auth, doing such a request will always fail the first time with a 401 status code, the response body will contain info how the client can authenticate.

The request will need to be retried, this time containing additional authentication data.

This method is an convenience method to get to the info the server returned on the first, failed request.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

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 QueueWedgeError

fn from(value: &Error) -> Self

Converts to this type from the input type.

impl From<CryptoStoreError> for Error

fn from(source: CryptoStoreError) -> Self

Converts to this type from the input type.

impl From<DecryptorError> for Error

fn from(source: DecryptorError) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: JsonError) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: IoError) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(e: SdkBaseError) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(e: ReqwestError) -> Self

Converts to this type from the input type.

impl From<Error> for RecoveryError

Available on crate feature e2e-encryption only.

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for RequestVerificationError

Available on crate feature e2e-encryption only.

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for SecretStorageError

Available on crate feature e2e-encryption only.

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<EventCacheError> for Error

fn from(source: EventCacheError) -> Self

Converts to this type from the input type.

impl From<EventCacheStoreError> for Error

fn from(source: EventCacheStoreError) -> Self

Converts to this type from the input type.

impl From<HttpError> for Error

fn from(source: HttpError) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: IdParseError) -> Self

Converts to this type from the input type.

impl From<InvalidUserTagName> for Error

fn from(source: InvalidUserTagName) -> Self

Converts to this type from the input type.

impl From<LockStoreError> for Error

fn from(source: LockStoreError) -> Self

Converts to this type from the input type.

impl From<MediaError> for Error

fn from(source: MediaError) -> Self

Converts to this type from the input type.

impl From<MegolmError> for Error

fn from(source: MegolmError) -> Self

Converts to this type from the input type.

impl From<OidcError> for Error

fn from(source: OidcError) -> Self

Converts to this type from the input type.

impl From<OlmError> for Error

fn from(source: OlmError) -> Self

Converts to this type from the input type.

impl From<ParseError> for Error

fn from(source: UrlParseError) -> Self

Converts to this type from the input type.

impl From<QueueWedgeError> for Error

fn from(source: QueueWedgeError) -> Self

Converts to this type from the input type.

impl From<ScanError> for Error

fn from(source: ScanError) -> Self

Converts to this type from the input type.

impl From<StoreError> for Error

fn from(source: StoreError) -> Self

Converts to this type from the input type.

impl From<TryFromIntError> for Error

fn from(e: TryFromIntError) -> Self

Converts to this type from the input type.