Enum RoomKeyWithheldCode

#[non_exhaustive]
pub enum RoomKeyWithheldCode {
    Blacklisted,
    Unverified,
    Unauthorized,
    Unavailable,
    NoOlm,
}

The possible codes for why a megolm key was not sent.

This type can hold an arbitrary string. To build this with a custom value, convert it from a string with ::from() / .into(). To check for values that are not available as a documented variant here, use its string representation, obtained through .as_str().

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.

Blacklisted

m.blacklisted

The user or device was blacklisted.

Unverified

m.unverified

The user or device was not verified, and the sender is only sharing keys with verified users or devices.

Unauthorized

m.unauthorised

The user or device is not allowed to have the key. For example, this could be sent in response to a key request if the user or device was not in the room when the original message was sent.

Unavailable

m.unavailable

Sent in reply to a key request if the device that the key is requested from does not have the requested key.

NoOlm

m.no_olm

An olm session could not be established.

Implementations

impl RoomKeyWithheldCode

pub fn as_str(&self) -> &str

Creates a string slice from this RoomKeyWithheldCode.

Trait Implementations

impl AsRef<str> for RoomKeyWithheldCode

fn as_ref(&self) -> &str

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

impl Clone for RoomKeyWithheldCode

fn clone(&self) -> RoomKeyWithheldCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RoomKeyWithheldCode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RoomKeyWithheldCode

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RoomKeyWithheldCode

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

Formats the value using the given formatter.

impl<T> From<T> for RoomKeyWithheldCode

where T: AsRef<str> + Into<Box<str>>,

fn from(s: T) -> RoomKeyWithheldCode

Converts to this type from the input type.

impl PartialEq for RoomKeyWithheldCode

fn eq(&self, other: &RoomKeyWithheldCode) -> 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 RoomKeyWithheldCode

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.

impl Eq for RoomKeyWithheldCode

impl StructuralPartialEq for RoomKeyWithheldCode