mirror of
https://github.com/matrix-org/matrix-rust-sdk.git
synced 2026-05-18 13:40:55 -04:00
timeline: Add documentation to [Sync]TimelineEvent
I found it hard to understand what these two structs were for, so let's start by giving them some documentation.
This commit is contained in:
committed by
Richard van der Hoff
parent
95ae5d1938
commit
b36a9ad781
@@ -297,8 +297,11 @@ pub struct EncryptionInfo {
|
||||
pub verification_state: VerificationState,
|
||||
}
|
||||
|
||||
/// A customized version of a room event coming from a sync that holds optional
|
||||
/// encryption info.
|
||||
/// Represents a matrix room event that has been returned from `/sync`,
|
||||
/// after initial processing.
|
||||
///
|
||||
/// This is almost identical to [`TimelineEvent`], but wraps an
|
||||
/// [`AnySyncTimelineEvent`] instead of [`AnyTimelineEvent`].
|
||||
#[derive(Clone, Deserialize, Serialize)]
|
||||
pub struct SyncTimelineEvent {
|
||||
/// The actual event.
|
||||
@@ -388,6 +391,16 @@ impl From<DecryptedRoomEvent> for SyncTimelineEvent {
|
||||
}
|
||||
}
|
||||
|
||||
/// 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.
|
||||
///
|
||||
/// See also [`SyncTimelineEvent`] which is almost identical, but is used for
|
||||
/// results from the `/sync` endpoint (which lack a `room_id` property) and
|
||||
/// hence wraps an [`AnySyncTimelineEvent`] instead of [`AnyTimelineEvent`].
|
||||
#[derive(Clone)]
|
||||
pub struct TimelineEvent {
|
||||
/// The actual event.
|
||||
|
||||
Reference in New Issue
Block a user