Enum ruma_client_api::error::ErrorKind

source · [−]

#[non_exhaustive]
pub enum ErrorKind {
Show 33 variants    Forbidden,
    UnknownToken {
        soft_logout: bool,
    },
    MissingToken,
    BadJson,
    NotJson,
    NotFound,
    LimitExceeded {
        retry_after_ms: Option<Duration>,
    },
    Unknown,
    Unrecognized,
    Unauthorized,
    UserDeactivated,
    UserInUse,
    InvalidUsername,
    RoomInUse,
    InvalidRoomState,
    ThreepidInUse,
    ThreepidNotFound,
    ThreepidAuthFailed,
    ThreepidDenied,
    ServerNotTrusted,
    UnsupportedRoomVersion,
    IncompatibleRoomVersion {
        room_version: RoomVersionId,
    },
    BadState,
    GuestAccessForbidden,
    CaptchaNeeded,
    CaptchaInvalid,
    MissingParam,
    InvalidParam,
    TooLarge,
    Exclusive,
    ResourceLimitExceeded {
        admin_contact: String,
    },
    CannotLeaveServerNoticeRoom,
    WeakPassword,
    // some variants omitted
}

Expand description

An enum for the error kind.

Items may contain additional information.

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.

`Forbidden`

M_FORBIDDEN

`UnknownToken`

Fields

soft_logout: bool

If this is true, the client can acquire a new access token by specifying the device ID it is already using to the login API.

For more information, see the spec.

M_UNKNOWN_TOKEN

`MissingToken`

M_MISSING_TOKEN

`BadJson`

M_BAD_JSON

`NotJson`

M_NOT_JSON

`NotFound`

M_NOT_FOUND

`LimitExceeded`

Fields

retry_after_ms: Option<Duration>

How long a client should wait in milliseconds before they can try again.

M_LIMIT_EXCEEDED

`Unknown`

M_UNKNOWN

`Unrecognized`

M_UNRECOGNIZED

`Unauthorized`

M_UNAUTHORIZED

`UserDeactivated`

M_USER_DEACTIVATED

`UserInUse`

M_USER_IN_USE

`InvalidUsername`

M_INVALID_USERNAME

`RoomInUse`

M_ROOM_IN_USE

`InvalidRoomState`

M_INVALID_ROOM_STATE

`ThreepidInUse`

M_THREEPID_IN_USE

`ThreepidNotFound`

M_THREEPID_NOT_FOUND

`ThreepidAuthFailed`

M_THREEPID_AUTH_FAILED

`ThreepidDenied`

M_THREEPID_DENIED

`ServerNotTrusted`

M_SERVER_NOT_TRUSTED

`UnsupportedRoomVersion`

M_UNSUPPORTED_ROOM_VERSION

`IncompatibleRoomVersion`

Fields

room_version: RoomVersionId

The room’s version.

M_INCOMPATIBLE_ROOM_VERSION

`BadState`

M_BAD_STATE

`GuestAccessForbidden`

M_GUEST_ACCESS_FORBIDDEN

`CaptchaNeeded`

M_CAPTCHA_NEEDED

`CaptchaInvalid`

M_CAPTCHA_INVALID

`MissingParam`

M_MISSING_PARAM

`InvalidParam`

M_INVALID_PARAM

`TooLarge`

M_TOO_LARGE

`Exclusive`

M_EXCLUSIVE

`ResourceLimitExceeded`

Fields

admin_contact: String

A URI giving a contact method for the server administrator.

M_RESOURCE_LIMIT_EXCEEDED

`CannotLeaveServerNoticeRoom`

M_CANNOT_LEAVE_SERVER_NOTICE_ROOM

`WeakPassword`

M_WEAK_PASSWORD

Trait Implementations

impl AsRef<str> for ErrorKind

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ErrorKind

fn clone(&self) -> ErrorKind

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for ErrorKind

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for ErrorKind

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Display for ErrorKind

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

Formats the value using the given formatter. Read more

impl PartialEq<ErrorKind> for ErrorKind

fn eq(&self, other: &ErrorKind) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

fn ne(&self, other: &ErrorKind) -> bool

This method tests for !=.

impl Serialize for ErrorKind

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl Eq for ErrorKind

impl StructuralEq for ErrorKind

impl StructuralPartialEq for ErrorKind

Auto Trait Implementations

impl RefUnwindSafe for ErrorKind

impl Send for ErrorKind

impl Sync for ErrorKind

impl Unpin for ErrorKind

impl UnwindSafe for ErrorKind

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

const: unstable · 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.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

default fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,