Skip to content

Commit 13f9f6c

Browse files
committed
doc(sdk): Add missing documentation.
1 parent 9d021a8 commit 13f9f6c

File tree

1 file changed

+8
-0
lines changed
  • crates/matrix-sdk/src/event_cache/room

1 file changed

+8
-0
lines changed

crates/matrix-sdk/src/event_cache/room/mod.rs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1356,13 +1356,21 @@ mod private {
13561356
}
13571357
}
13581358

1359+
/// Output of the callback passed to `RoomEventCacheState::with_events_mut`.
13591360
pub(super) enum EventsPostProcessing {
1361+
/// Trigger the post-processing when new events have been inserted.
13601362
HaveBeenInserted(Vec<TimelineEvent>),
1363+
1364+
/// No post-processing.
13611365
None,
13621366
}
13631367

1368+
/// An enum representing where an event has been found.
13641369
pub(super) enum EventLocation {
1370+
/// Event lives in memory (and likely in the store!).
13651371
InMemory,
1372+
1373+
/// Event lives in the store only, it has not been loaded in memory yet.
13661374
InStore,
13671375
}
13681376

0 commit comments

Comments
 (0)