matrix-rust-sdk

public

Star0

Fork 0

Watch0

3 commits 4 branches 0 tags 0 releases16.6 MiB

Commit `9467d8fde596`

tarball

atagen <boss@atagen.co>2026-10-22 12:30 UTC

2 files changed+40-2

room_list_service: let callers request extra required state

Modified file: crates/matrix-sdk-ui/src/room_list_service/mod.rs+21 additions−1 deletions@@ -129,6 +129,10 @@ pub struct RoomListService {
     ///
     /// `RoomListService` is a simple state-machine.
     state_machine: StateMachine,
+
+    /// State events requested on top of [`DEFAULT_REQUIRED_STATE`], for the
+    /// list and for room subscriptions alike.
+    extra_required_state: Vec<(StateEventType, String)>,
 }
 
 impl RoomListService {
@@ -158,6 +162,20 @@ impl RoomListService {
         connection_id: &str,
         timeline_limit: u32,
     ) -> Result<Self, Error> {
+        Self::new_with_required_state(client, share_pos, connection_id, timeline_limit, Vec::new())
+            .await
+    }
+
+    /// Like [`RoomListService::new_with`], also requesting
+    /// `extra_required_state` for every room in the list and every room
+    /// subscription, on top of the defaults.
+    pub async fn new_with_required_state(
+        client: Client,
+        share_pos: bool,
+        connection_id: &str,
+        timeline_limit: u32,
+        extra_required_state: Vec<(StateEventType, String)>,
+    ) -> Result<Self, Error> {
         let mut builder = client
             .sliding_sync(connection_id)
             .map_err(Error::SlidingSync)?
@@ -222,6 +240,7 @@ impl RoomListService {
                         DEFAULT_REQUIRED_STATE
                             .iter()
                             .map(|(state_event, value)| (state_event.clone(), (*value).to_owned()))
+                            .chain(extra_required_state.iter().cloned())
                             .collect(),
                     )
                     .filters(Some(assign!(http::request::ListFilters::default(), {
@@ -265,7 +284,7 @@ impl RoomListService {
         // Eagerly subscribe the event cache to sync responses.
         client.event_cache().subscribe()?;
 
-        Ok(Self { client, sliding_sync, state_machine })
+        Ok(Self { client, sliding_sync, state_machine, extra_required_state })
     }
 
     /// Start to sync the room list.
@@ -489,6 +508,7 @@ impl RoomListService {
                     (state_event.clone(), (*value).to_owned())
                 })
             )
+            .chain(self.extra_required_state.iter().cloned())
             .collect(),
             timeline_limit: UInt::from(DEFAULT_ROOM_SUBSCRIPTION_TIMELINE_LIMIT),
         });

Modified file: crates/matrix-sdk-ui/src/sync_service.rs+19 additions−1 deletions@@ -36,6 +36,7 @@ use matrix_sdk::{
     Client,
     config::RequestConfig,
     executor::{JoinHandle, spawn},
+    ruma::events::StateEventType,
     sleep::sleep,
 };
 use thiserror::Error;
@@ -785,6 +786,9 @@ pub struct SyncServiceBuilder {
     /// [`room_list_service::DEFAULT_LIST_TIMELINE_LIMIT`].
     room_list_timeline_limit: u32,
 
+    /// State events the room list service requests on top of its defaults.
+    room_list_extra_required_state: Vec<(StateEventType, String)>,
+
     /// The parent tracing span to use for the tasks within this service.
     ///
     /// Normally this will be [`Span::none`], but it may be useful to assign a
@@ -801,6 +805,7 @@ impl SyncServiceBuilder {
             with_share_pos: true,
             room_list_conn_id: DEFAULT_CONNECTION_ID.to_owned(),
             room_list_timeline_limit: DEFAULT_LIST_TIMELINE_LIMIT,
+            room_list_extra_required_state: Vec::new(),
             parent_span: Span::none(),
         }
     }
@@ -834,6 +839,17 @@ impl SyncServiceBuilder {
         self
     }
 
+    /// Request these state events for every room the room list service
+    /// syncs, on top of its defaults. Use it for state the sdk doesn't know
+    /// about, so it lands in the state store like the rest.
+    pub fn with_room_list_extra_required_state(
+        mut self,
+        required_state: Vec<(StateEventType, String)>,
+    ) -> Self {
+        self.room_list_extra_required_state = required_state;
+        self
+    }
+
     /// Set the parent tracing span to be used for the tasks within this
     /// service.
     pub fn with_parent_span(mut self, parent_span: Span) -> Self {
@@ -853,16 +869,18 @@ impl SyncServiceBuilder {
             with_share_pos,
             room_list_conn_id,
             room_list_timeline_limit,
+            room_list_extra_required_state,
             parent_span,
         } = self;
 
         let encryption_sync_permit = Arc::new(AsyncMutex::new(EncryptionSyncPermit::new()));
 
-        let room_list = RoomListService::new_with(
+        let room_list = RoomListService::new_with_required_state(
             client.clone(),
             with_share_pos,
             &room_list_conn_id,
             room_list_timeline_limit,
+            room_list_extra_required_state,
         )
         .await?;

matrix-rust-sdk

Commit 9467d8fde596

Commit `9467d8fde596`