From 4f7186a8402f86278c25d7a5d3dac29aa0718a67 Mon Sep 17 00:00:00 2001
From: Ivan Enderlin <ivan@mnt.io>
Date: Mon, 27 Feb 2023 13:46:35 +0100
Subject: [PATCH] chore(sdk): Simplify the implementation of `RoomListEntry`.

---
 crates/matrix-sdk/src/sliding_sync/view.rs | 26 ++++++++++++----------
 1 file changed, 14 insertions(+), 12 deletions(-)

diff --git a/crates/matrix-sdk/src/sliding_sync/view.rs b/crates/matrix-sdk/src/sliding_sync/view.rs
index 143e2c4d0..ae60271e5 100644
--- a/crates/matrix-sdk/src/sliding_sync/view.rs
+++ b/crates/matrix-sdk/src/sliding_sync/view.rs
@@ -943,38 +943,40 @@ pub enum SlidingSyncMode {
     Selective,
 }
 
-/// The Entry in the sliding sync room list per sliding sync view
+/// The Entry in the Sliding Sync room list per Sliding Sync view.
 #[derive(Clone, Debug, Default, Serialize, Deserialize)]
 pub enum RoomListEntry {
-    /// This entry isn't known at this point and thus considered `Empty`
+    /// This entry isn't known at this point and thus considered `Empty`.
     #[default]
     Empty,
     /// There was `OwnedRoomId` but since the server told us to invalid this
-    /// entry. it is considered stale
+    /// entry. it is considered stale.
     Invalidated(OwnedRoomId),
-    /// This Entry is followed with `OwnedRoomId`
+    /// This entry is followed with `OwnedRoomId`.
     Filled(OwnedRoomId),
 }
 
 impl RoomListEntry {
     /// Is this entry empty or invalidated?
     pub fn empty_or_invalidated(&self) -> bool {
-        matches!(self, RoomListEntry::Empty | RoomListEntry::Invalidated(_))
+        matches!(self, Self::Empty | Self::Invalidated(_))
     }
 
-    /// The inner room_id if given
+    /// Return the inner `room_id` if the entry' state is not empty.
     pub fn as_room_id(&self) -> Option<&RoomId> {
         match &self {
-            RoomListEntry::Empty => None,
-            RoomListEntry::Invalidated(b) | RoomListEntry::Filled(b) => Some(b.as_ref()),
+            Self::Empty => None,
+            Self::Invalidated(room_id) | Self::Filled(room_id) => Some(room_id.as_ref()),
         }
     }
 
-    fn freeze(&self) -> RoomListEntry {
+    /// Clone this entry, but freeze it, i.e. if the entry is empty, it remains
+    /// empty, otherwise it is invalidated.
+    fn freeze(&self) -> Self {
         match &self {
-            RoomListEntry::Empty => RoomListEntry::Empty,
-            RoomListEntry::Invalidated(b) | RoomListEntry::Filled(b) => {
-                RoomListEntry::Invalidated(b.clone())
+            Self::Empty => Self::Empty,
+            Self::Invalidated(room_id) | Self::Filled(room_id) => {
+                Self::Invalidated(room_id.clone())
             }
         }
     }