matrix-sdk-base: remove InvitedRoom, JoinedRoom, LeftRoom and RoomState

They are all replaced by `Room`

Author: jsparber

matrix_sdk/examples/autojoin.rs

@@ -4,7 +4,7 @@ use tokio::time::{sleep, Duration};
 use matrix_sdk::{
     self, async_trait,
     events::{room::member::MemberEventContent, StrippedStateEvent},
-    Client, ClientConfig, EventHandler, RoomState, SyncSettings,
+    Client, ClientConfig, EventHandler, Room, RoomType, SyncSettings,
 };
 use url::Url;
 
@@ -22,15 +22,15 @@ impl AutoJoinBot {
 impl EventHandler for AutoJoinBot {
     async fn on_stripped_state_member(
         &self,
-        room: RoomState,
+        room: Room,
         room_member: &StrippedStateEvent<MemberEventContent>,
         _: Option<MemberEventContent>,
     ) {
         if room_member.state_key != self.client.user_id().await.unwrap() {
             return;
         }
 
-        if let RoomState::Invited(room) = room {
+        if room.room_type() == RoomType::Invited {
             println!("Autojoining room {}", room.room_id());
             let mut delay = 2;
 

matrix_sdk/examples/command_bot.rs

@@ -6,7 +6,7 @@ use matrix_sdk::{
         room::message::{MessageEventContent, MessageType, TextMessageEventContent},
         AnyMessageEventContent, SyncMessageEvent,
     },
-    Client, ClientConfig, EventHandler, RoomState, SyncSettings,
+    Client, ClientConfig, EventHandler, Room, RoomType, SyncSettings,
 };
 use url::Url;
 
@@ -24,12 +24,8 @@ impl CommandBot {
 
 #[async_trait]
 impl EventHandler for CommandBot {
-    async fn on_room_message(
-        &self,
-        room: RoomState,
-        event: &SyncMessageEvent<MessageEventContent>,
-    ) {
-        if let RoomState::Joined(room) = room {
+    async fn on_room_message(&self, room: Room, event: &SyncMessageEvent<MessageEventContent>) {
+        if room.room_type() == RoomType::Joined {
             let msg_body = if let SyncMessageEvent {
                 content:
                     MessageEventContent {

matrix_sdk/examples/image_bot.rs

@@ -14,7 +14,7 @@ use matrix_sdk::{
         room::message::{MessageEventContent, MessageType, TextMessageEventContent},
         SyncMessageEvent,
     },
-    Client, EventHandler, RoomState, SyncSettings,
+    Client, EventHandler, Room, RoomType, SyncSettings,
 };
 use url::Url;
 
@@ -32,12 +32,8 @@ impl ImageBot {
 
 #[async_trait]
 impl EventHandler for ImageBot {
-    async fn on_room_message(
-        &self,
-        room: RoomState,
-        event: &SyncMessageEvent<MessageEventContent>,
-    ) {
-        if let RoomState::Joined(room) = room {
+    async fn on_room_message(&self, room: Room, event: &SyncMessageEvent<MessageEventContent>) {
+        if room.room_type() == RoomType::Joined {
             let msg_body = if let SyncMessageEvent {
                 content:
                     MessageEventContent {

matrix_sdk/examples/login.rs

@@ -7,19 +7,15 @@ use matrix_sdk::{
         room::message::{MessageEventContent, MessageType, TextMessageEventContent},
         SyncMessageEvent,
     },
-    Client, EventHandler, RoomState, SyncSettings,
+    Client, EventHandler, Room, RoomType, SyncSettings,
 };
 
 struct EventCallback;
 
 #[async_trait]
 impl EventHandler for EventCallback {
-    async fn on_room_message(
-        &self,
-        room: RoomState,
-        event: &SyncMessageEvent<MessageEventContent>,
-    ) {
-        if let RoomState::Joined(room) = room {
+    async fn on_room_message(&self, room: Room, event: &SyncMessageEvent<MessageEventContent>) {
+        if room.room_type() == RoomType::Joined {
             if let SyncMessageEvent {
                 content:
                     MessageEventContent {

matrix_sdk/src/client.rs

@@ -41,8 +41,7 @@ use tracing::{error, info, instrument};
 
 use matrix_sdk_base::{
     deserialized_responses::{MembersResponse, SyncResponse},
-    BaseClient, BaseClientConfig, EventHandler, InvitedRoom, JoinedRoom, LeftRoom, RoomState,
-    Session, Store,
+    BaseClient, BaseClientConfig, EventHandler, Room, RoomType, Session, Store,
 };
 
 #[cfg(feature = "encryption")]
@@ -564,34 +563,34 @@ impl Client {
     /// Get all the rooms the client knows about.
     ///
     /// This will return the list of joined, invited, and left rooms.
-    pub fn rooms(&self) -> Vec<RoomState> {
+    pub fn rooms(&self) -> Vec<Room> {
         self.store().get_rooms()
     }
 
     /// Returns the joined rooms this client knows about.
-    pub fn joined_rooms(&self) -> Vec<JoinedRoom> {
+    pub fn joined_rooms(&self) -> Vec<Room> {
         self.store()
             .get_rooms()
             .into_iter()
-            .filter_map(|r| r.joined())
+            .filter(|room| room.room_type() == RoomType::Joined)
             .collect()
     }
 
     /// Returns the invited rooms this client knows about.
-    pub fn invited_rooms(&self) -> Vec<InvitedRoom> {
+    pub fn invited_rooms(&self) -> Vec<Room> {
         self.store()
             .get_rooms()
             .into_iter()
-            .filter_map(|r| r.invited())
+            .filter(|room| room.room_type() == RoomType::Invited)
             .collect()
     }
 
     /// Returns the left rooms this client knows about.
-    pub fn left_rooms(&self) -> Vec<LeftRoom> {
+    pub fn left_rooms(&self) -> Vec<Room> {
         self.store()
             .get_rooms()
             .into_iter()
-            .filter_map(|r| r.left())
+            .filter(|room| room.room_type() == RoomType::Left)
             .collect()
     }
 
@@ -600,26 +599,32 @@ impl Client {
     /// # Arguments
     ///
     /// `room_id` - The unique id of the room that should be fetched.
-    pub fn get_joined_room(&self, room_id: &RoomId) -> Option<JoinedRoom> {
-        self.store().get_joined_room(room_id)
+    pub fn get_joined_room(&self, room_id: &RoomId) -> Option<Room> {
+        self.store()
+            .get_room(room_id)
+            .filter(|room| room.room_type() == RoomType::Joined)
     }
 
     /// Get an invited room with the given room id.
     ///
     /// # Arguments
     ///
     /// `room_id` - The unique id of the room that should be fetched.
-    pub fn get_invited_room(&self, room_id: &RoomId) -> Option<InvitedRoom> {
-        self.store().get_invited_room(room_id)
+    pub fn get_invited_room(&self, room_id: &RoomId) -> Option<Room> {
+        self.store()
+            .get_room(room_id)
+            .filter(|room| room.room_type() == RoomType::Invited)
     }
 
     /// Get a left room with the given room id.
     ///
     /// # Arguments
     ///
     /// `room_id` - The unique id of the room that should be fetched.
-    pub fn get_left_room(&self, room_id: &RoomId) -> Option<LeftRoom> {
-        self.store().get_left_room(room_id)
+    pub fn get_left_room(&self, room_id: &RoomId) -> Option<Room> {
+        self.store()
+            .get_room(room_id)
+            .filter(|room| room.room_type() == RoomType::Left)
     }
 
     /// Login to the server.

matrix_sdk/src/lib.rs

@@ -68,8 +68,8 @@ compile_error!("only one of 'native-tls' or 'rustls-tls' features can be enabled
 #[cfg_attr(feature = "docs", doc(cfg(encryption)))]
 pub use matrix_sdk_base::crypto::{EncryptionInfo, LocalTrust};
 pub use matrix_sdk_base::{
-    CustomEvent, Error as BaseError, EventHandler, InvitedRoom, JoinedRoom, LeftRoom, RoomInfo,
-    RoomMember, RoomState, RoomType, Session, StateChanges, StoreError,
+    CustomEvent, Error as BaseError, EventHandler, Room, RoomInfo, RoomMember, RoomType, Session,
+    StateChanges, StoreError,
 };
 
 pub use matrix_sdk_common::*;

matrix_sdk_base/src/client.rs

@@ -63,10 +63,10 @@ use zeroize::Zeroizing;
 use crate::{
     error::Result,
     event_handler::Handler,
-    rooms::{RoomInfo, RoomType},
+    rooms::{Room, RoomInfo, RoomType},
     session::Session,
     store::{ambiguity_map::AmbiguityCache, Result as StoreResult, StateChanges, Store},
-    EventHandler, RoomState,
+    EventHandler,
 };
 
 pub type Token = String;
@@ -1178,7 +1178,7 @@ impl BaseClient {
     /// # Arguments
     ///
     /// * `room_id` - The id of the room that should be fetched.
-    pub fn get_room(&self, room_id: &RoomId) -> Option<RoomState> {
+    pub fn get_room(&self, room_id: &RoomId) -> Option<Room> {
         self.store.get_room(room_id)
     }