Struct TimelineEvent

pub struct TimelineEvent {
    pub kind: TimelineEventKind,
    pub push_actions: Option<Vec<Action>>,
}

Represents a matrix room event that has been returned from a Matrix client-server API endpoint such as /messages, after initial processing.

The “initial processing” includes an attempt to decrypt encrypted events, so the main thing this adds over [AnyTimelineEvent] is information on encryption.

Previously, this differed from SyncTimelineEvent by wrapping an [AnyTimelineEvent] instead of an [AnySyncTimelineEvent], but nowadays they are essentially identical, and one of them should probably be removed.

Fields

kind: TimelineEventKind

The event itself, together with any information on decryption.

push_actions: Option<Vec<Action>>

The push actions associated with this event, if we had sufficient context to compute them.

Implementations

impl TimelineEvent

pub fn new(event: Raw<AnyTimelineEvent>) -> Self

Create a new TimelineEvent from the given raw event.

This is a convenience constructor for a plaintext event when you don’t need to set push_action, for example inside a test.

pub fn new_utd_event( event: Raw<AnySyncTimelineEvent>, utd_info: UnableToDecryptInfo, ) -> Self

Create a new TimelineEvent to represent the given decryption failure.

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

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

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

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

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

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

Trait Implementations

impl Clone for TimelineEvent

fn clone(&self) -> TimelineEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TimelineEvent

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

Formats the value using the given formatter.

impl From<DecryptedRoomEvent> for TimelineEvent

fn from(decrypted: DecryptedRoomEvent) -> Self

Converts to this type from the input type.

impl From<TimelineEvent> for SyncTimelineEvent

fn from(o: TimelineEvent) -> Self

Converts to this type from the input type.