doc: document SlidingSyncRoomInner::timeline_queue a bit better

This commit is contained in:
Benjamin Bouvier
2023-12-18 16:12:25 +01:00
parent 07c428ec56
commit c9b02ad068

View File

@@ -271,6 +271,13 @@ struct SlidingSyncRoomInner {
/// A queue of received events, used to build a
/// [`Timeline`][crate::Timeline].
///
/// Given a room, its size is theoretically unbounded: we'll accumulate
/// events in this list, until we reach a limited sync, in which case
/// we'll clear it.
///
/// When persisting the room, this queue is truncated to keep only the last
/// N events.
timeline_queue: RwLock<Vector<SyncTimelineEvent>>,
}