Enum ruma_client_api::error::ErrorKind

#[non_exhaustive]
pub enum ErrorKind {
    Forbidden {
        authenticate: Option<AuthenticateError>,
    },
    UnknownToken {
        soft_logout: bool,
    },
    MissingToken,
    BadJson,
    NotJson,
    NotFound,
    LimitExceeded {
        retry_after: Option<RetryAfter>,
    },
    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,
    UnableToAuthorizeJoin,
    UnableToGrantJoin,
    BadAlias,
    DuplicateAnnotation,
    NotYetUploaded,
    CannotOverwriteMedia,
    UnknownPos,
    UrlNotSet,
    BadStatus {
        status: Option<StatusCode>,
        body: Option<String>,
    },
    ConnectionFailed,
    ConnectionTimeout,
    WrongRoomKeysVersion {
        current_version: Option<String>,
    },
    Unactionable,
    UserLocked,
}

Available on crate features client or server only.

An enum for the error kind.

Items may contain additional information.

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.

Forbidden

M_FORBIDDEN

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

authenticate: Option<AuthenticateError>

Available on crate feature unstable-msc2967 only.

The WWW-Authenticate header error message.

UnknownToken

M_UNKNOWN_TOKEN

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.

MissingToken

M_MISSING_TOKEN

BadJson

M_BAD_JSON

NotJson

M_NOT_JSON

NotFound

M_NOT_FOUND

LimitExceeded

M_LIMIT_EXCEEDED

Fields

retry_after: Option<RetryAfter>

How long a client should wait 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

Fields

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

Fields

admin_contact: String

A URI giving a contact method for the server administrator.

CannotLeaveServerNoticeRoom

M_CANNOT_LEAVE_SERVER_NOTICE_ROOM

WeakPassword

M_WEAK_PASSWORD

UnableToAuthorizeJoin

M_UNABLE_TO_AUTHORISE_JOIN

UnableToGrantJoin

M_UNABLE_TO_GRANT_JOIN

BadAlias

M_BAD_ALIAS

DuplicateAnnotation

M_DUPLICATE_ANNOTATION

NotYetUploaded

M_NOT_YET_UPLOADED

CannotOverwriteMedia

M_CANNOT_OVERWRITE_MEDIA

UnknownPos

Available on crate features unstable-msc3575 or unstable-msc4186 only.

M_UNKNOWN_POS for sliding sync

UrlNotSet

M_URL_NOT_SET

BadStatus

M_BAD_STATUS

Fields

status: Option<StatusCode>

The HTTP status code of the response.

body: Option<String>

The body of the response.

ConnectionFailed

M_CONNECTION_FAILED

ConnectionTimeout

M_CONNECTION_TIMEOUT

WrongRoomKeysVersion

M_WRONG_ROOM_KEYS_VERSION

Fields

current_version: Option<String>

The currently active backup version.

Unactionable

Available on crate feature unstable-msc3843 only.

M_UNACTIONABLE

UserLocked

M_USER_LOCKED

Implementations

impl ErrorKind

pub fn forbidden() -> Self

Constructs an empty ErrorKind::Forbidden variant.

pub fn forbidden_with_authenticate(authenticate: AuthenticateError) -> Self

Available on crate feature unstable-msc2967 only.

Constructs an ErrorKind::Forbidden variant with the given WWW-Authenticate header error message.

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.

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

Performs copy-assignment from source.

impl Debug for ErrorKind

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

Formats the value using the given formatter.

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.

impl Display for ErrorKind

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

Formats the value using the given formatter.

impl PartialEq for ErrorKind

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

impl Eq for ErrorKind

impl StructuralPartialEq for ErrorKind