matrix_sdk

Enum Error

Source
#[non_exhaustive]
pub enum Error {
Show 27 variants 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, ConcurrentRequestFailed, UnknownError(Box<dyn Error + Send + Sync>), EventCache(EventCacheError), SendQueueWedgeError(QueueWedgeError), BackupNotEnabled, Media(MediaError),
}
Expand description

Internal representation of errors.

Variants (Non-exhaustive)§

This enum is marked as 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.

§

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§

Source§

impl Error

Source

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

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

Otherwise, returns None.

Source

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

Source

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).

Source

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§

Source§

impl Debug for Error

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Error

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for Error

Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
Source§

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. Read more
Source§

impl From<&Error> for QueueWedgeError

Source§

fn from(value: &Error) -> Self

Converts to this type from the input type.
Source§

impl From<CryptoStoreError> for Error

Source§

fn from(source: CryptoStoreError) -> Self

Converts to this type from the input type.
Source§

impl From<DecryptorError> for Error

Source§

fn from(source: DecryptorError) -> Self

Converts to this type from the input type.
Source§

impl From<Error> for Error

Source§

fn from(source: JsonError) -> Self

Converts to this type from the input type.
Source§

impl From<Error> for Error

Source§

fn from(source: IoError) -> Self

Converts to this type from the input type.
Source§

impl From<Error> for Error

Source§

fn from(source: Error) -> Self

Converts to this type from the input type.
Source§

impl From<Error> for Error

Source§

fn from(e: SdkBaseError) -> Self

Converts to this type from the input type.
Source§

impl From<Error> for Error

Source§

fn from(e: ReqwestError) -> Self

Converts to this type from the input type.
Source§

impl From<Error> for RecoveryError

Available on crate feature e2e-encryption only.
Source§

fn from(source: Error) -> Self

Converts to this type from the input type.
Source§

impl From<Error> for RequestVerificationError

Available on crate feature e2e-encryption only.
Source§

fn from(source: Error) -> Self

Converts to this type from the input type.
Source§

impl From<Error> for SecretStorageError

Available on crate feature e2e-encryption only.
Source§

fn from(source: Error) -> Self

Converts to this type from the input type.
Source§

impl From<EventCacheError> for Error

Source§

fn from(source: EventCacheError) -> Self

Converts to this type from the input type.
Source§

impl From<EventCacheStoreError> for Error

Source§

fn from(source: EventCacheStoreError) -> Self

Converts to this type from the input type.
Source§

impl From<HttpError> for Error

Source§

fn from(source: HttpError) -> Self

Converts to this type from the input type.
Source§

impl From<Error> for Error

Source§

fn from(source: IdParseError) -> Self

Converts to this type from the input type.
Source§

impl From<InvalidUserTagName> for Error

Source§

fn from(source: InvalidUserTagName) -> Self

Converts to this type from the input type.
Source§

impl From<LockStoreError> for Error

Source§

fn from(source: LockStoreError) -> Self

Converts to this type from the input type.
Source§

impl From<MediaError> for Error

Source§

fn from(source: MediaError) -> Self

Converts to this type from the input type.
Source§

impl From<MegolmError> for Error

Source§

fn from(source: MegolmError) -> Self

Converts to this type from the input type.
Source§

impl From<OlmError> for Error

Source§

fn from(source: OlmError) -> Self

Converts to this type from the input type.
Source§

impl From<ParseError> for Error

Source§

fn from(source: UrlParseError) -> Self

Converts to this type from the input type.
Source§

impl From<QueueWedgeError> for Error

Source§

fn from(source: QueueWedgeError) -> Self

Converts to this type from the input type.
Source§

impl From<ScanError> for Error

Source§

fn from(source: ScanError) -> Self

Converts to this type from the input type.
Source§

impl From<StoreError> for Error

Source§

fn from(source: StoreError) -> Self

Converts to this type from the input type.
Source§

impl From<TryFromIntError> for Error

Source§

fn from(e: TryFromIntError) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl !Freeze for Error

§

impl !RefUnwindSafe for Error

§

impl Send for Error

§

impl Sync for Error

§

impl Unpin for Error

§

impl !UnwindSafe for Error

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

impl<T> Identity for T
where T: ?Sized,

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize = _

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> Any for T
where T: Any,

Source§

impl<T> AsyncTraitDeps for T

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> MaybeSendSync for T

Source§

impl<T> SendOutsideWasm for T
where T: Send,

Source§

impl<T> SyncOutsideWasm for T
where T: Sync,