pub struct TimelineEvent {
pub kind: TimelineEventKind,
pub push_actions: Option<Vec<Action>>,
}
Expand description
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§
source§impl TimelineEvent
impl TimelineEvent
sourcepub fn new(event: Raw<AnyTimelineEvent>) -> Self
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.
sourcepub fn new_utd_event(
event: Raw<AnySyncTimelineEvent>,
utd_info: UnableToDecryptInfo,
) -> Self
pub fn new_utd_event( event: Raw<AnySyncTimelineEvent>, utd_info: UnableToDecryptInfo, ) -> Self
Create a new TimelineEvent
to represent the given decryption failure.
sourcepub fn raw(&self) -> &Raw<AnySyncTimelineEvent>
pub fn raw(&self) -> &Raw<AnySyncTimelineEvent>
Returns a reference to the (potentially decrypted) Matrix event inside
this TimelineEvent
.
sourcepub fn encryption_info(&self) -> Option<&EncryptionInfo>
pub fn encryption_info(&self) -> Option<&EncryptionInfo>
If the event was a decrypted event that was successfully decrypted, get
its encryption info. Otherwise, None
.
sourcepub fn into_raw(self) -> Raw<AnySyncTimelineEvent>
pub fn into_raw(self) -> Raw<AnySyncTimelineEvent>
Takes ownership of this TimelineEvent
, returning the (potentially
decrypted) Matrix event within.
Trait Implementations§
source§impl Clone for TimelineEvent
impl Clone for TimelineEvent
source§fn clone(&self) -> TimelineEvent
fn clone(&self) -> TimelineEvent
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for TimelineEvent
impl Debug for TimelineEvent
source§impl From<DecryptedRoomEvent> for TimelineEvent
impl From<DecryptedRoomEvent> for TimelineEvent
source§fn from(decrypted: DecryptedRoomEvent) -> Self
fn from(decrypted: DecryptedRoomEvent) -> Self
source§impl From<TimelineEvent> for SyncTimelineEvent
impl From<TimelineEvent> for SyncTimelineEvent
source§fn from(o: TimelineEvent) -> Self
fn from(o: TimelineEvent) -> Self
Auto Trait Implementations§
impl Freeze for TimelineEvent
impl RefUnwindSafe for TimelineEvent
impl Send for TimelineEvent
impl Sync for TimelineEvent
impl Unpin for TimelineEvent
impl UnwindSafe for TimelineEvent
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)