Struct TimelineEvent

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

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.

push_actions: Option<Vec<Action>>

The push actions associated with this event.

If it’s set to None, then it means we couldn’t compute those actions.

Implementations

impl TimelineEvent

pub fn new(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 new_with_push_actions( event: Raw<AnySyncTimelineEvent>, push_actions: Vec<Action>, ) -> Self

Create a new TimelineEvent from the given raw event and push actions.

This is a convenience constructor for a plaintext event, 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 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<AnyMessageLikeEvent>)

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

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<'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 From<DecryptedRoomEvent> for TimelineEvent

fn from(decrypted: DecryptedRoomEvent) -> Self

Converts to this type from the input type.

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