refactor(base): Reorganize the state_events processors.

This patch tries to clarify the processors in `state_events` by
putting them in two modules: `sync` and `stripped`, along with a bit
of renaming:

- `collect_sync` becomes `sync::collect`,
- `collect_sync_from_timeline` becomes `sync::collect_from_timeline`,
- `collect_stripped` becomes `stripped::collect`.

I believe this is an improvement.

Author: Hywan

crates/matrix-sdk-base/src/client.rs

@@ -614,7 +614,7 @@ impl BaseClient {
             room_info.handle_encryption_state(requested_required_states.for_room(&room_id));
 
             let (raw_state_events, state_events) =
-                processors::state_events::collect_sync(&mut context, &new_info.state.events);
+                processors::state_events::sync::collect(&mut context, &new_info.state.events);
 
             let mut new_user_ids = processors::state_events::dispatch_and_get_new_users(
                 &mut context,
@@ -646,7 +646,7 @@ impl BaseClient {
             }
 
             let (raw_state_events_from_timeline, state_events_from_timeline) =
-                processors::state_events::collect_sync_from_timeline(
+                processors::state_events::sync::collect_from_timeline(
                     &mut context,
                     &new_info.timeline.events,
                 );
@@ -743,7 +743,7 @@ impl BaseClient {
             room_info.handle_encryption_state(requested_required_states.for_room(&room_id));
 
             let (raw_state_events, state_events) =
-                processors::state_events::collect_sync(&mut context, &new_info.state.events);
+                processors::state_events::sync::collect(&mut context, &new_info.state.events);
 
             let mut new_user_ids = processors::state_events::dispatch_and_get_new_users(
                 &mut context,
@@ -754,7 +754,7 @@ impl BaseClient {
             .await?;
 
             let (raw_state_events_from_timeline, state_events_from_timeline) =
-                processors::state_events::collect_sync_from_timeline(
+                processors::state_events::sync::collect_from_timeline(
                     &mut context,
                     &new_info.timeline.events,
                 );
@@ -818,7 +818,7 @@ impl BaseClient {
                 self.room_info_notable_update_sender.clone(),
             );
 
-            let invite_state = processors::state_events::collect_stripped(
+            let invite_state = processors::state_events::stripped::collect(
                 &mut context,
                 &new_info.invite_state.events,
             );
@@ -849,7 +849,7 @@ impl BaseClient {
                 self.room_info_notable_update_sender.clone(),
             );
 
-            let knock_state = processors::state_events::collect_stripped(
+            let knock_state = processors::state_events::stripped::collect(
                 &mut context,
                 &new_info.knock_state.events,
             );

crates/matrix-sdk-base/src/response_processors/state_events.rs

@@ -18,10 +18,7 @@ use std::{
 };
 
 use ruma::{
-    events::{
-        room::member::MembershipState, AnyStrippedStateEvent, AnySyncStateEvent,
-        AnySyncTimelineEvent,
-    },
+    events::{room::member::MembershipState, AnySyncStateEvent},
     serde::Raw,
     OwnedUserId,
 };
@@ -34,35 +31,51 @@ use crate::{
     RoomInfo,
 };
 
-/// Collect sync state events and map them with their deserialized form.
-pub fn collect_sync(
-    _context: &mut Context,
-    raw_events: &[Raw<AnySyncStateEvent>],
-) -> (Vec<Raw<AnySyncStateEvent>>, Vec<AnySyncStateEvent>) {
-    collect(raw_events)
-}
+/// Collect [`AnySyncStateEvent`].
+pub mod sync {
+    use ruma::events::AnySyncTimelineEvent;
+
+    use super::{AnySyncStateEvent, Context, Raw};
 
-/// Collect stripped state events and map them with their deserialized form.
-pub fn collect_stripped(
-    _context: &mut Context,
-    raw_events: &[Raw<AnyStrippedStateEvent>],
-) -> (Vec<Raw<AnyStrippedStateEvent>>, Vec<AnyStrippedStateEvent>) {
-    collect(raw_events)
+    /// Collect [`AnySyncStateEvent`] to [`AnySyncStateEvent`].
+    pub fn collect(
+        _context: &mut Context,
+        raw_events: &[Raw<AnySyncStateEvent>],
+    ) -> (Vec<Raw<AnySyncStateEvent>>, Vec<AnySyncStateEvent>) {
+        super::collect(raw_events)
+    }
+
+    /// Collect [`AnySyncTimelineEvent`] to [`AnySyncStateEvent`].
+    ///
+    /// A [`AnySyncTimelineEvent`] can represent either message-like events or
+    /// state events. The message-like events are filtered out.
+    pub fn collect_from_timeline(
+        _context: &mut Context,
+        raw_events: &[Raw<AnySyncTimelineEvent>],
+    ) -> (Vec<Raw<AnySyncStateEvent>>, Vec<AnySyncStateEvent>) {
+        super::collect(raw_events.iter().filter_map(|raw_event| {
+            // Only state events have a `state_key` field.
+            match raw_event.get_field::<&str>("state_key") {
+                Ok(Some(_)) => Some(raw_event.cast_ref()),
+                _ => None,
+            }
+        }))
+    }
 }
 
-/// Collect sync timeline event, filter the sync state events, and map them with
-/// their deserialized form.
-pub fn collect_sync_from_timeline(
-    _context: &mut Context,
-    raw_events: &[Raw<AnySyncTimelineEvent>],
-) -> (Vec<Raw<AnySyncStateEvent>>, Vec<AnySyncStateEvent>) {
-    collect(raw_events.iter().filter_map(|raw_event| {
-        // State events have a `state_key` field.
-        match raw_event.get_field::<&str>("state_key") {
-            Ok(Some(_)) => Some(raw_event.cast_ref()),
-            _ => None,
-        }
-    }))
+/// Collect [`AnyStrippedStateEvent`].
+pub mod stripped {
+    use ruma::events::AnyStrippedStateEvent;
+
+    use super::{Context, Raw};
+
+    /// Collect [`AnyStrippedStateEvent`] to [`AnyStrippedStateEvent`].
+    pub fn collect(
+        _context: &mut Context,
+        raw_events: &[Raw<AnyStrippedStateEvent>],
+    ) -> (Vec<Raw<AnyStrippedStateEvent>>, Vec<AnyStrippedStateEvent>) {
+        super::collect(raw_events)
+    }
 }
 
 fn collect<'a, I, T>(raw_events: I) -> (Vec<Raw<T>>, Vec<T>)

crates/matrix-sdk-base/src/sliding_sync.rs

@@ -369,15 +369,15 @@ impl BaseClient {
         // incomplete or staled already. We must only read state events from
         // `required_state`.
         let (raw_state_events, state_events) =
-            processors::state_events::collect_sync(context, &room_data.required_state);
+            processors::state_events::sync::collect(context, &room_data.required_state);
 
         // Find or create the room in the store
         let is_new_room = !state_store.room_exists(room_id);
 
         let invite_state_events = room_data
             .invite_state
             .as_ref()
-            .map(|events| processors::state_events::collect_stripped(context, events));
+            .map(|events| processors::state_events::stripped::collect(context, events));
 
         #[allow(unused_mut)] // Required for some feature flag combinations
         let (mut room, mut room_info, invited_room, knocked_room) = self