mirror/matrix-rust-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-rust-sdk.git synced 2026-05-15 19:45:34 -04:00
Code Issues Packages Projects Releases Wiki Activity

doc(sdk): Improve doc of EventCache.

Browse Source
This commit is contained in:
Ivan Enderlin
2024-03-27 09:09:40 +01:00
parent f11cf87326
commit 11c3799fa2
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
crates/matrix-sdk/src/event_cache/mod.rs
View File

@@ -517,8 +517,8 @@ impl RoomEventCacheInner {
Ok(())
}
// Remove existing events, and append a set of events to the room cache and
// storage, notifying observers.
/// Remove existing events, and append a set of events to the room cache and
/// storage, notifying observers.
async fn replace_all_events_by(
&self,
events: Vec<SyncTimelineEvent>,

4
crates/matrix-sdk/src/event_cache/store.rs
View File

@@ -65,7 +65,7 @@ impl RoomEvents {
self.push_events(once(event))
}
/// Push events after existing events.
/// Push events after all events or gaps.
///
/// The last event in `events` is the most recent one.
pub fn push_events<I>(&mut self, events: I)
@@ -76,7 +76,7 @@ impl RoomEvents {
self.chunks.push_items_back(events)
}
/// Push a gap after existing events.
/// Push a gap after all events or gaps.
pub fn push_gap(&mut self, gap: Gap) {
self.chunks.push_gap_back(gap)
}