feat: Add LowPriority filter implementation and FFI bindings

Co-authored-by: pixlwave <[email protected]>

Author: 2 people

bindings/matrix-sdk-ffi/src/room_list.rs

@@ -16,7 +16,7 @@ use matrix_sdk_ui::{
     room_list_service::filters::{
         new_filter_all, new_filter_any, new_filter_category, new_filter_deduplicate_versions,
         new_filter_favourite, new_filter_fuzzy_match_room_name, new_filter_invite,
-        new_filter_joined, new_filter_non_left, new_filter_non_space, new_filter_none,
+        new_filter_joined, new_filter_low_priority, new_filter_non_left, new_filter_non_space, new_filter_none,
         new_filter_normalized_match_room_name, new_filter_unread, BoxedFilterFn, RoomCategory,
     },
     unable_to_decrypt_hook::UtdHookManager,
@@ -461,6 +461,7 @@ pub enum RoomListEntriesDynamicFilterKind {
     Joined,
     Unread,
     Favourite,
+    LowPriority,
     Invite,
     Category { expect: RoomListFilterCategory },
     None,
@@ -500,6 +501,7 @@ impl From<RoomListEntriesDynamicFilterKind> for BoxedFilterFn {
             Kind::Joined => Box::new(new_filter_joined()),
             Kind::Unread => Box::new(new_filter_unread()),
             Kind::Favourite => Box::new(new_filter_favourite()),
+            Kind::LowPriority => Box::new(new_filter_low_priority()),
             Kind::Invite => Box::new(new_filter_invite()),
             Kind::Category { expect } => Box::new(new_filter_category(expect.into())),
             Kind::None => Box::new(new_filter_none()),

crates/matrix-sdk-ui/src/room_list_service/filters/low_priority.rs

@@ -0,0 +1,70 @@
+// Copyright 2024 The Matrix.org Foundation C.I.C.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+use super::{super::Room, Filter};
+
+struct LowPriorityRoomMatcher<F>
+where
+    F: Fn(&Room) -> bool,
+{
+    is_low_priority: F,
+}
+
+impl<F> LowPriorityRoomMatcher<F>
+where
+    F: Fn(&Room) -> bool,
+{
+    fn matches(&self, room: &Room) -> bool {
+        (self.is_low_priority)(room)
+    }
+}
+
+/// Create a new filter that will filter out rooms that are not marked as
+/// low priority (see [`matrix_sdk_base::Room::is_low_priority`]).
+pub fn new_filter() -> impl Filter {
+    let matcher = LowPriorityRoomMatcher { is_low_priority: move |room| room.is_low_priority() };
+
+    move |room| -> bool { matcher.matches(room) }
+}
+
+#[cfg(test)]
+mod tests {
+    use std::ops::Not;
+
+    use matrix_sdk::test_utils::logged_in_client_with_server;
+    use matrix_sdk_test::async_test;
+    use ruma::room_id;
+
+    use super::{super::new_rooms, *};
+
+    #[async_test]
+    async fn test_is_low_priority() {
+        let (client, server) = logged_in_client_with_server().await;
+        let [room] = new_rooms([room_id!("!a:b.c")], &client, &server).await;
+
+        let matcher = LowPriorityRoomMatcher { is_low_priority: |_| true };
+
+        assert!(matcher.matches(&room));
+    }
+
+    #[async_test]
+    async fn test_is_not_low_priority() {
+        let (client, server) = logged_in_client_with_server().await;
+        let [room] = new_rooms([room_id!("!a:b.c")], &client, &server).await;
+
+        let matcher = LowPriorityRoomMatcher { is_low_priority: |_| false };
+
+        assert!(matcher.matches(&room).not());
+    }
+}

crates/matrix-sdk-ui/src/room_list_service/filters/mod.rs

@@ -59,6 +59,7 @@ mod favourite;
 mod fuzzy_match_room_name;
 mod invite;
 mod joined;
+mod low_priority;
 mod non_left;
 mod non_space;
 mod none;
@@ -74,6 +75,7 @@ pub use favourite::new_filter as new_filter_favourite;
 pub use fuzzy_match_room_name::new_filter as new_filter_fuzzy_match_room_name;
 pub use invite::new_filter as new_filter_invite;
 pub use joined::new_filter as new_filter_joined;
+pub use low_priority::new_filter as new_filter_low_priority;
 #[cfg(test)]
 use matrix_sdk::Client;
 use matrix_sdk::Room;