Struct TimelineEvent

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

Represents a Matrix room event that has been returned from /sync, after initial processing.

Previously, this differed from TimelineEvent by wrapping an [AnySyncTimelineEvent] instead of an [AnyTimelineEvent], 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.

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.

thread_summary: ThreadSummaryStatus

If the event is part of a thread, a thread summary.

bundled_latest_thread_event: Option<Box<TimelineEvent>>

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

Not serialized.

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<OwnedEventId>

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

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.

Trait Implementations

impl Clone for TimelineEvent

fn clone(&self) -> TimelineEvent

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 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 Send for TimelineEvent

impl Sync for TimelineEvent