Dima/matrix-rust-sdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc(sdk): Add missing, or fix existing documentation.

Browse Source
This commit is contained in:
Ivan Enderlin
2026-02-26 14:28:54 +01:00
parent a9f946d365
commit 07f9e998e9
1 changed files with 9 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
crates/matrix-sdk/src/event_cache/caches/room/state.rs
+9 -2
View File
@@ -241,8 +241,14 @@ impl RoomEventCacheStateLock {
}
}
/// The read-lock guard around [`RoomEventCacheState`].
///
/// See [`RoomEventCacheStateLock::read`] to acquire it.
pub type RoomEventCacheStateLockReadGuard<'a> = lock::StateLockReadGuard<'a, RoomEventCacheState>;
/// The write-lock guard around [`RoomEventCacheState`].
///
/// See [`RoomEventCacheStateLock::write`] to acquire it.
pub type RoomEventCacheStateLockWriteGuard<'a> = lock::StateLockWriteGuard<'a, RoomEventCacheState>;
impl<'a> lock::Reload for RoomEventCacheStateLockWriteGuard<'a> {
@@ -268,11 +274,12 @@ impl<'a> lock::Reload for RoomEventCacheStateLockWriteGuard<'a> {
}
impl<'a> RoomEventCacheStateLockReadGuard<'a> {
/// Returns a read-only reference to the underlying room linked chunk.
/// Return a read-only reference to the underlying room linked chunk.
pub fn room_linked_chunk(&self) -> &EventLinkedChunk {
&self.state.room_linked_chunk
}
/// Return the subscriber count.
pub fn subscriber_count(&self) -> &Arc<AtomicUsize> {
&self.state.subscriber_count
}
@@ -389,7 +396,7 @@ impl<'a> RoomEventCacheStateLockReadGuard<'a> {
}
impl<'a> RoomEventCacheStateLockWriteGuard<'a> {
/// Returns a write reference to the underlying room linked chunk.
/// Return a write reference to the underlying room linked chunk.
#[cfg(any(feature = "e2e-encryption", test))]
pub fn room_linked_chunk(&mut self) -> &mut EventLinkedChunk {
&mut self.state.room_linked_chunk