Enum WithheldCode

pub enum WithheldCode {
    Blacklisted,
    Unverified,
    Unauthorised,
    Unavailable,
    NoOlm,
    // some variants omitted
}

A machine-readable code for why a Megolm key was not sent.

Normally sent as the payload of an m.room_key.withheld to-device message.

Variants

Blacklisted

the user/device was blacklisted.

Unverified

the user/devices is unverified.

Unauthorised

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

Unavailable

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

NoOlm

An olm session could not be established. This may happen, for example, if the sender was unable to obtain a one-time key from the recipient.

Implementations

impl WithheldCode

pub fn as_str(&self) -> &str

Creates a string slice from this WithheldCode.

Trait Implementations

impl AsRef<str> for WithheldCode

fn as_ref(&self) -> &str

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

impl Clone for WithheldCode

fn clone(&self) -> WithheldCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WithheldCode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WithheldCode

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for WithheldCode

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

Formats the value using the given formatter.

impl<T> From<T> for WithheldCode

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

fn from(s: T) -> WithheldCode

Converts to this type from the input type.

impl Hash for WithheldCode

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for WithheldCode

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

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 WithheldCode

impl StructuralPartialEq for WithheldCode