ruma_client_api/filter/
get_filter.rs

Help
1//! `GET /_matrix/client/*/user/{userId}/filter/{filterId}`
2//!
3//! Retrieve a previously created filter.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3useruseridfilterfilterid
9
10    use ruma_common::{
11        api::{request, response, Metadata},
12        metadata, OwnedUserId,
13    };
14
15    use crate::filter::FilterDefinition;
16
17    const METADATA: Metadata = metadata! {
18        method: GET,
19        rate_limited: false,
20        authentication: AccessToken,
21        history: {
22            1.0 => "/_matrix/client/r0/user/:user_id/filter/:filter_id",
23            1.1 => "/_matrix/client/v3/user/:user_id/filter/:filter_id",
24        }
25    };
26
27    /// Request type for the `get_filter` endpoint.
28    #[request(error = crate::Error)]
29    pub struct Request {
30        /// The user ID to download a filter for.
31        #[ruma_api(path)]
32        pub user_id: OwnedUserId,
33
34        /// The ID of the filter to download.
35        #[ruma_api(path)]
36        pub filter_id: String,
37    }
38
39    /// Response type for the `get_filter` endpoint.
40    #[response(error = crate::Error)]
41    pub struct Response {
42        /// The filter definition.
43        #[ruma_api(body)]
44        pub filter: FilterDefinition,
45    }
46
47    impl Request {
48        /// Creates a new `Request` with the given user ID and filter ID.
49        pub fn new(user_id: OwnedUserId, filter_id: String) -> Self {
50            Self { user_id, filter_id }
51        }
52    }
53
54    impl Response {
55        /// Creates a new `Response` with the given filter definition.
56        pub fn new(filter: FilterDefinition) -> Self {
57            Self { filter }
58        }
59    }
60
61    #[cfg(all(test, any(feature = "client", feature = "server")))]
62    mod tests {
63        #[cfg(feature = "client")]
64        #[test]
65        fn deserialize_response() {
66            use ruma_common::api::IncomingResponse;
67
68            let res = super::Response::try_from_http_response(
69                http::Response::builder().body(b"{}" as &[u8]).unwrap(),
70            )
71            .unwrap();
72            assert!(res.filter.is_empty());
73        }
74
75        #[cfg(feature = "server")]
76        #[test]
77        fn serialize_response() {
78            use ruma_common::api::OutgoingResponse;
79
80            use crate::filter::FilterDefinition;
81
82            let res = super::Response::new(FilterDefinition::default())
83                .try_into_http_response::<Vec<u8>>()
84                .unwrap();
85            assert_eq!(res.body(), b"{}");
86        }
87    }
88}
ruma_client_api/filter/get_filter.rs

ruma_client_api/filter/
get_filter.rs
