Enum UnableToDecryptReason

pub enum UnableToDecryptReason {
    MalformedEncryptedEvent,
    MissingMegolmSession {
        withheld_code: Option<WithheldCode>,
    },
    UnknownMegolmMessageIndex,
    MegolmDecryptionFailure,
    PayloadDeserializationFailure,
    MismatchedIdentityKeys,
    SenderIdentityNotTrusted(VerificationLevel),
    // some variants omitted
}

Reason code for a decryption failure

Variants

MalformedEncryptedEvent

The m.room.encrypted event that should have been decrypted is malformed in some way (e.g. unsupported algorithm, missing fields, unknown megolm message type).

MissingMegolmSession

Decryption failed because we’re missing the megolm session that was used to encrypt the event.

Fields

withheld_code: Option<WithheldCode>

If the key was withheld on purpose, the associated code. None means no withheld code was received.

UnknownMegolmMessageIndex

Decryption failed because, while we have the megolm session that was used to encrypt the message, it is ratcheted too far forward.

MegolmDecryptionFailure

We found the Megolm session, but were unable to decrypt the event using that session for some reason (e.g. incorrect MAC).

This represents all vodozemac::megolm::DecryptionErrors, except UnknownMessageIndex, which is represented as UnknownMegolmMessageIndex.

PayloadDeserializationFailure

The event could not be deserialized after decryption.

MismatchedIdentityKeys

Decryption failed because of a mismatch between the identity keys of the device we received the room key from and the identity keys recorded in the plaintext of the room key to-device message.

SenderIdentityNotTrusted(VerificationLevel)

An encrypted message wasn’t decrypted, because the sender’s cross-signing identity did not satisfy the requested TrustRequirement.

Implementations

impl UnableToDecryptReason

pub fn is_missing_room_key(&self) -> bool

Returns true if this UTD is due to a missing room key (and hence might resolve itself if we wait a bit.)

Trait Implementations

impl Clone for UnableToDecryptReason

fn clone(&self) -> UnableToDecryptReason

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UnableToDecryptReason

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UnableToDecryptReason

fn deserialize<__D>( __deserializer: __D, ) -> Result<UnableToDecryptReason, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for UnableToDecryptReason

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

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 UnableToDecryptReason

impl StructuralPartialEq for UnableToDecryptReason