matrix_sdk_ui/room_list_service/filters/
favourite.rs

// 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 FavouriteRoomMatcher<F>
where
    F: Fn(&Room) -> bool,
{
    is_favourite: F,
}

impl<F> FavouriteRoomMatcher<F>
where
    F: Fn(&Room) -> bool,
{
    fn matches(&self, room: &Room) -> bool {
        (self.is_favourite)(room)
    }
}

/// Create a new filter that will filter out rooms that are not marked as
/// favourite (see [`matrix_sdk_base::Room::is_favourite`]).
pub fn new_filter() -> impl Filter {
    let matcher = FavouriteRoomMatcher { is_favourite: move |room| room.is_favourite() };

    move |room| -> bool { matcher.matches(room) }
}

#[cfg(test)]
mod tests {
    use std::ops::Not;

    use matrix_sdk_test::async_test;
    use ruma::room_id;

    use super::{
        super::{client_and_server_prelude, new_rooms},
        *,
    };

    #[async_test]
    async fn test_is_favourite() {
        let (client, server, sliding_sync) = client_and_server_prelude().await;
        let [room] = new_rooms([room_id!("!a:b.c")], &client, &server, &sliding_sync).await;

        let matcher = FavouriteRoomMatcher { is_favourite: |_| true };

        assert!(matcher.matches(&room));
    }

    #[async_test]
    async fn test_is_not_favourite() {
        let (client, server, sliding_sync) = client_and_server_prelude().await;
        let [room] = new_rooms([room_id!("!a:b.c")], &client, &server, &sliding_sync).await;

        let matcher = FavouriteRoomMatcher { is_favourite: |_| false };

        assert!(matcher.matches(&room).not());
    }
}
matrix_sdk_ui/room_list_service/filters/favourite.rs

matrix_sdk_ui/room_list_service/filters/
favourite.rs
