Struct SyncTimelineEvent

pub struct SyncTimelineEvent {
    pub kind: TimelineEventKind,
    pub push_actions: 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: Vec<Action>

The push actions associated with this event.

Implementations

impl SyncTimelineEvent

pub fn new(event: Raw<AnySyncTimelineEvent>) -> SyncTimelineEvent

Create a new SyncTimelineEvent 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>, ) -> SyncTimelineEvent

Create a new SyncTimelineEvent 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, ) -> SyncTimelineEvent

Create a new SyncTimelineEvent to represent the given decryption failure.

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

Get the event id of this SyncTimelineEvent 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 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 SyncTimelineEvent

fn clone(&self) -> SyncTimelineEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SyncTimelineEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SyncTimelineEvent

fn deserialize<D>( deserializer: D, ) -> Result<SyncTimelineEvent, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Custom deserializer for SyncTimelineEvent, 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 SyncTimelineEvent

fn from(decrypted: DecryptedRoomEvent) -> SyncTimelineEvent

Converts to this type from the input type.

impl From<SyncTimelineEventDeserializationHelperV0> for SyncTimelineEvent

fn from(value: SyncTimelineEventDeserializationHelperV0) -> SyncTimelineEvent

Converts to this type from the input type.

impl From<SyncTimelineEventDeserializationHelperV1> for SyncTimelineEvent

fn from(value: SyncTimelineEventDeserializationHelperV1) -> SyncTimelineEvent

Converts to this type from the input type.

impl From<TimelineEvent> for SyncTimelineEvent

fn from(o: TimelineEvent) -> SyncTimelineEvent

Converts to this type from the input type.

impl Serialize for SyncTimelineEvent

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.