Struct DecryptedEvent

pub struct DecryptedEvent {
    pub clear_event: String,
    pub sender_curve25519_key: String,
    pub claimed_ed25519_key: Option<String>,
    pub forwarding_curve25519_chain: Vec<String>,
    pub shield_state: ShieldState,
}

An event that was successfully decrypted.

Fields

clear_event: String

The decrypted version of the event.

sender_curve25519_key: String

The claimed curve25519 key of the sender.

claimed_ed25519_key: Option<String>

The claimed ed25519 key of the sender.

forwarding_curve25519_chain: Vec<String>

The curve25519 chain of the senders that forwarded the Megolm decryption key to us. Is empty if the key came directly from the sender of the event.

shield_state: ShieldState

The shield state (color and message to display to user) for the event, representing the event’s authenticity. Computed from the properties of the sender user identity and their Olm device.

Note that this is computed at time of decryption, so the value reflects the computed event authenticity at that time. Authenticity-related properties can change later on, such as when a user identity is subsequently verified or a device is deleted.

Trait Implementations

impl<UT> ConvertError<UT> for DecryptedEvent

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

impl<UT> FfiConverter<UT> for DecryptedEvent

const TYPE_ID_META: MetadataBuffer = _

Type ID metadata, serialized into a MetadataBuffer.

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: Self) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<Self>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: Self, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<Self>

Read a rust value from a buffer, received over the FFI in serialized form.

impl<UT> Lift<UT> for DecryptedEvent

type FfiType = <DecryptedEvent as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for DecryptedEvent

type LiftType = DecryptedEvent

impl<UT> LiftReturn<UT> for DecryptedEvent

type ReturnType = <DecryptedEvent as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for DecryptedEvent

type FfiType = <DecryptedEvent as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for DecryptedEvent

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for DecryptedEvent

type ReturnType = <DecryptedEvent as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustBuffer>

Lower this value for scaffolding function return

fn handle_failed_lift(arg_name: &str, e: Error) -> Self

If possible, get a serialized error for failed argument lifts

impl<UT> TypeId<UT> for DecryptedEvent

const TYPE_ID_META: MetadataBuffer = _