Enum ruma_identifiers::Error

source · [−]

#[non_exhaustive]
pub enum Error {
Show 16 variants    EmptyClientSecret,
    EmptyRoomName,
    EmptyRoomVersionId,
    InvalidCharacters,
    InvalidKeyAlgorithm,
    InvalidKeyVersion,
    InvalidMatrixId(MatrixIdError),
    InvalidMatrixToRef(MatrixToError),
    InvalidMatrixUri(MatrixUriError),
    InvalidMxcUri(MxcUriError),
    InvalidServerName,
    InvalidUri,
    InvalidUtf8,
    MaximumLengthExceeded,
    MissingDelimiter,
    MissingLeadingSigil,
}

Expand description

An error encountered when trying to parse an invalid ID string.

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.

`EmptyClientSecret`

The client secret is empty.

`EmptyRoomName`

The room name is empty.

`EmptyRoomVersionId`

The room version ID is empty.

`InvalidCharacters`

The ID’s localpart contains invalid characters.

Only relevant for user IDs.

`InvalidKeyAlgorithm`

The key algorithm is invalid (e.g. empty).

`InvalidKeyVersion`

The key version contains outside of [a-zA-Z0-9_].

`InvalidMatrixId(MatrixIdError)`

The string isn’t a valid Matrix ID.

`InvalidMatrixToRef(MatrixToError)`

The string isn’t a valid Matrix.to URI.

`InvalidMatrixUri(MatrixUriError)`

The string isn’t a valid Matrix URI.

`InvalidMxcUri(MxcUriError)`

The mxc:// isn’t a valid Matrix Content URI.

`InvalidServerName`

The server name part of the the ID string is not a valid server name.

`InvalidUri`

The string isn’t a valid URI.

`InvalidUtf8`

The string isn’t valid UTF-8.

`MaximumLengthExceeded`

The ID exceeds 255 bytes (or 32 codepoints for a room version ID).

`MissingDelimiter`

The ID is missing the colon delimiter between localpart and server name, or between key algorithm and key name / version.

`MissingLeadingSigil`

The ID is missing the correct leading sigil.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

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 Error

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

Formats the value using the given formatter. Read more

impl Display for Error

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

Formats the value using the given formatter. Read more

impl Error for Error

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

The lower-level source of this error, if any. Read more

fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred. 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

impl From<MatrixIdError> for Error

fn from(source: MatrixIdError) -> Error

Converts to this type from the input type.

impl From<MatrixToError> for Error

fn from(source: MatrixToError) -> Error

Converts to this type from the input type.

impl From<MatrixUriError> for Error

fn from(source: MatrixUriError) -> Error

Converts to this type from the input type.

impl From<MxcUriError> for Error

fn from(source: MxcUriError) -> Error

Converts to this type from the input type.

impl From<ParseError> for Error

fn from(ParseError) -> Error

Converts to this type from the input type.

impl From<Utf8Error> for Error

fn from(Utf8Error) -> Error

Converts to this type from the input type.

impl Hash for Error

fn hash<H>(&self, state: &mut H) where
__H: Hasher,

Feeds this value into the given Hasher. Read more

1.3.0 · source

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

Feeds a slice of this type into the given Hasher. Read more

impl PartialEq<Error> for Error

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

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

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

This method tests for !=.

impl Copy for Error

impl Eq for Error

impl StructuralEq for Error

impl StructuralPartialEq for Error

Auto Trait Implementations

impl RefUnwindSafe for Error

impl Send for Error

impl Sync for Error

impl Unpin for Error

impl UnwindSafe for Error

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<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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)

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

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