Struct TimelineEvent 

pub struct TimelineEvent {
    pub kind: TimelineEventKind,
    pub timestamp: Option<MilliSecondsSinceUnixEpoch>,
    /* private fields */
}

Represents a matrix room event that has been returned from a Matrix client-server API endpoint such as /sync or /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.

Fields

kind: TimelineEventKind

The event itself, together with any information on decryption.

timestamp: Option<MilliSecondsSinceUnixEpoch>

The timestamp of the event. It’s the origin_server_ts value (if any), corrected if detected as malicious.

It can be None if the event has been serialised before the addition of this field, or if parsing the origin_server_ts value failed.

Implementations

impl TimelineEvent

pub fn from_plaintext(event: Raw<AnySyncTimelineEvent>) -> 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 from_plaintext_with_max_timestamp( event: Raw<AnySyncTimelineEvent>, max_timestamp: MilliSecondsSinceUnixEpoch, ) -> Self

Like TimelineEvent::from_plaintext but with a given max_timestamp.

pub fn from_decrypted( decrypted: DecryptedRoomEvent, push_actions: Option<Vec<Action>>, ) -> Self

Create a new TimelineEvent from a decrypted event.

pub fn from_decrypted_with_max_timestamp( decrypted: DecryptedRoomEvent, push_actions: Option<Vec<Action>>, max_timestamp: MilliSecondsSinceUnixEpoch, ) -> Self

Like TimelineEvent::from_decrypted but with a given max_timestamp.

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

Create a new TimelineEvent to represent the given decryption failure.

pub fn from_utd_with_max_timestamp( event: Raw<AnySyncTimelineEvent>, utd_info: UnableToDecryptInfo, max_timestamp: MilliSecondsSinceUnixEpoch, ) -> Self

Like TimelineEvent::from_utd but with a given max_timestamp.

pub fn to_decrypted( &self, decrypted: DecryptedRoomEvent, push_actions: Option<Vec<Action>>, ) -> Self

Transform this TimelineEvent into another TimelineEvent with the TimelineEventKind::Decrypted kind.

Panics

It panics (on debug builds only) if the kind already is TimelineEventKind::Decrypted.

pub fn to_utd(&self, utd_info: UnableToDecryptInfo) -> Self

Transform this TimelineEvent into another TimelineEvent with the TimelineEventKind::Decrypted kind.

Panics

It panics (on debug builds only) if the kind already is TimelineEventKind::Decrypted.

pub fn push_actions(&self) -> Option<&[Action]>

Read the current push actions.

Returns None if they were never computed, or if they could not be computed.

pub fn set_push_actions(&mut self, push_actions: Vec<Action>)

Set the push actions for this event.

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

Get the (cached) event ID of this TimelineEvent if the event has any valid ID.

pub fn sender(&self) -> Option<OwnedUserId>

Get the sender of this TimelineEvent if the event has one.

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

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

pub fn replace_raw(&mut self, replacement: Raw<AnyTimelineEvent>)

Replace the raw event included in this item by another one.

pub fn timestamp(&self) -> Option<MilliSecondsSinceUnixEpoch>

Get the timestamp.

If the timestamp is missing (most likely because the event has been created before the addition of the TimelineEvent::timestamp field), this method will try to extract it from the origin_server_ts value. If the origin_server_ts value is malicious, it will be capped to MilliSecondsSinceUnixEpoch::now. It means that the returned value might not be constant.

pub fn timestamp_raw(&self) -> Option<MilliSecondsSinceUnixEpoch>

Get the timestamp value, without trying to backfill it if None.

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 into_raw(self) -> Raw<AnySyncTimelineEvent>

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

pub fn is_thread_root(&self) -> bool

Checks whether this event is a thread root, i.e. in-thread events are attached to it.

pub fn thread_summary(&self) -> Option<ThreadSummary>

If this event is a thread root, find, parse, and create the ThreadSummary of the thread.

Note that this value is NEVER updated. An event is immutable in Matrix. However, the thread summary is updated dynamically in the SDK, see matrix_sdk_base::event_cache::thread::ThreadInfo.

pub fn bundled_latest_thread_event(&self) -> Option<Self>

If this event is a thread root, find, parse, and create the latest event of the thread.

The latest event comes bundled with this event, if it was provided in the unsigned relations of this event.

Note that this value is NEVER updated. An event is immutable in Matrix. However, the thread summary is updated dynamically in the SDK, see matrix_sdk_base::event_cache::thread::ThreadInfo.

pub fn thread_summary_with_latest_event(&self) -> Option<(ThreadSummary, Self)>

Combo of Self::thread_summary and Self::bundled_latest_thread_event: if this event is a thread root, find, parse once, and create the ThreadSummary and the TimelineEvent representing the latest event of the thread.

Note that this value is NEVER updated. An event is immutable in Matrix. However, the thread summary is updated dynamically in the SDK, see matrix_sdk_base::event_cache::thread::ThreadInfo.

Trait Implementations

impl Clone for TimelineEvent

fn clone(&self) -> Self

Returns a duplicate 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<'de> Deserialize<'de> for TimelineEvent

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Custom deserializer for TimelineEvent, to support older formats.

Ideally we might use an untagged enum and then convert from that; however, that doesn’t work due to a serde bug.

Instead, we first deserialize into an unstructured JSON map, and then inspect the json to figure out which format we have.

impl IndexableItem for TimelineEvent

type ItemId = OwnedEventId

fn id(&self) -> Self::ItemId

Return the identifier of the item.

impl Send for TimelineEvent

Available on non-crate feature test-send-sync only.

impl Serialize for TimelineEvent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sync for TimelineEvent

Available on non-crate feature test-send-sync only.