Skip to content

Commit cec8f37

Browse files
committed
doc(sdk): Add more documentation for RoomEvents.
1 parent c42ce9c commit cec8f37

File tree

1 file changed

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

1 file changed

+3
-0
lines changed

crates/matrix-sdk/src/event_cache/store.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,9 @@ pub struct Gap {
3030

3131
const DEFAULT_CHUNK_CAPACITY: usize = 128;
3232

33+
/// This type represents all events of a single room.
3334
pub struct RoomEvents {
35+
/// The real in-memory storage for all the events.
3436
chunks: LinkedChunk<DEFAULT_CHUNK_CAPACITY, Event, Gap>,
3537
}
3638

@@ -41,6 +43,7 @@ impl Default for RoomEvents {
4143
}
4244

4345
impl RoomEvents {
46+
/// Build a new `Self` with zero events.
4447
pub fn new() -> Self {
4548
Self { chunks: LinkedChunk::new() }
4649
}

0 commit comments

Comments
 (0)