Enum TimelineEventKind 

pub enum TimelineEventKind {
    Decrypted(DecryptedRoomEvent),
    UnableToDecrypt {
        event: Raw<AnySyncTimelineEvent>,
        utd_info: UnableToDecryptInfo,
    },
    PlainText {
        event: Raw<AnySyncTimelineEvent>,
    },
}

The event within a TimelineEvent, together with encryption data.

Variants

Decrypted(DecryptedRoomEvent)

A successfully-decrypted encrypted event.

UnableToDecrypt

An encrypted event which could not be decrypted.

Fields

event: Raw<AnySyncTimelineEvent>

The m.room.encrypted event. Depending on the source of the event, it could actually be an AnyTimelineEvent (i.e., it may have a room_id property).

utd_info: UnableToDecryptInfo

Information on the reason we failed to decrypt

PlainText

An unencrypted event.

Fields

event: Raw<AnySyncTimelineEvent>

The actual event. Depending on the source of the event, it could actually be a AnyTimelineEvent (which differs from AnySyncTimelineEvent by the addition of a room_id property).

Implementations

impl TimelineEventKind

pub fn raw(&self) -> &Raw<AnySyncTimelineEvent>

Returns a reference to the (potentially decrypted) Matrix event inside this TimelineEvent.

pub fn event_id(&self) -> Option<OwnedEventId>

Get the event id of this TimelineEventKind if the event has any valid id.

pub fn is_utd(&self) -> bool

Whether we could not decrypt the event (i.e. it is a UTD).

pub fn encryption_info(&self) -> Option<&Arc<EncryptionInfo>>

If the event was a decrypted event that was successfully decrypted, get its encryption info. Otherwise, None.

pub fn unsigned_encryption_map( &self, ) -> Option<&BTreeMap<UnsignedEventLocation, UnsignedDecryptionResult>>

If the event was a decrypted event that was successfully decrypted, get the map of decryption metadata related to the bundled events.

pub fn into_raw(self) -> Raw<AnySyncTimelineEvent>

Takes ownership of this TimelineEvent, returning the (potentially decrypted) Matrix event within.

pub fn session_id(&self) -> Option<&str>

The Megolm session ID that was used to send this event, if it was encrypted.

pub fn event_type(&self) -> Option<String>

Get the event type of this event.

Returns None if there isn’t an event type or if the event failed to be deserialized.

Trait Implementations

impl Clone for TimelineEventKind

fn clone(&self) -> TimelineEventKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TimelineEventKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TimelineEventKind

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TimelineEventKind

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.