Enum ruma::api::client::error::ErrorKind[−][src]

pub enum ErrorKind {
Show 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,
    // some variants omitted
}

This is supported on crate feature api and (crate features client-api or client-api-c or client-api-s) only.

Expand description

An enum for the error kind. Items may contain additional information.

Variants

Forbidden

M_FORBIDDEN

UnknownToken

M_UNKNOWN_TOKEN

Show fields

Fields of UnknownToken

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.

MissingToken

M_MISSING_TOKEN

BadJson

M_BAD_JSON

NotJson

M_NOT_JSON

NotFound

M_NOT_FOUND

LimitExceeded

M_LIMIT_EXCEEDED

Show fields

Fields of LimitExceeded

retry_after_ms: Option<Duration>

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

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

M_INCOMPATIBLE_ROOM_VERSION

Show fields

Fields of IncompatibleRoomVersion

room_version: RoomVersionId

The room’s 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

M_RESOURCE_LIMIT_EXCEEDED

Show fields

Fields of ResourceLimitExceeded

admin_contact: String

A URI giving a contact method for the server administrator.

CannotLeaveServerNoticeRoom

M_CANNOT_LEAVE_SERVER_NOTICE_ROOM

Trait Implementations

[src]

impl AsRef<str> for ErrorKind

[src]

pub fn as_ref(&self) -> &str

Performs the conversion.

[src]

impl Clone for ErrorKind

[src]

pub fn clone(&self) -> ErrorKind

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

[src]

impl Debug for ErrorKind

[src]

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

Formats the value using the given formatter. Read more

[src]

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

[src]

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

Deserialize this value from the given Serde deserializer. Read more

[src]

impl Display for ErrorKind

[src]

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

Formats the value using the given formatter. Read more

[src]

impl PartialEq<ErrorKind> for ErrorKind

[src]

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

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

[src]

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

This method tests for !=.

[src]

impl Serialize for ErrorKind

[src]

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

Serialize this value into the given Serde serializer. Read more

[src]

impl Eq for ErrorKind

[src]

impl StructuralEq for ErrorKind

[src]

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

[src]

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

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

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

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

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

[src]

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

Mutably borrows from an owned value. Read more

[src]

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

[src]

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

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

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T> Instrument for T

[src]

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

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

[src]

fn in_current_span(self) -> Instrumented<Self>

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

[src]

impl<T> Instrument for T

[src]

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

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

[src]

fn in_current_span(self) -> Instrumented<Self>

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

[src]

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

[src]

pub fn into(self) -> U

Performs the conversion.

impl<T> Same<T> for T

type Output = T

Should always be Self

[src]

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

type Owned = T

The resulting type after obtaining ownership.

[src]

pub fn to_owned(&self) -> T

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

[src]

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

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

[src]

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

[src]

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

[src]

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

type Error = Infallible

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

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.

[src]

pub 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>,

pub fn vzip(self) -> V

[src]

impl<T> WithSubscriber for T

[src]

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

[src]

fn with_current_subscriber(self) -> WithDispatch<Self>

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

[src]

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