ruma_client_api/user_directory/
search_users.rs

1//! `POST /_matrix/client/*/user_directory/search`
2//!
3//! Performs a search for users.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3user_directorysearch
9
10    use http::header::ACCEPT_LANGUAGE;
11    use js_int::{uint, UInt};
12    use ruma_common::{
13        api::{request, response, Metadata},
14        metadata, OwnedMxcUri, OwnedUserId,
15    };
16    use serde::{Deserialize, Serialize};
17
18    const METADATA: Metadata = metadata! {
19        method: POST,
20        rate_limited: true,
21        authentication: AccessToken,
22        history: {
23            1.0 => "/_matrix/client/r0/user_directory/search",
24            1.1 => "/_matrix/client/v3/user_directory/search",
25        }
26    };
27
28    /// Request type for the `search_users` endpoint.
29    #[request(error = crate::Error)]
30    pub struct Request {
31        /// The term to search for.
32        pub search_term: String,
33
34        /// The maximum number of results to return.
35        ///
36        /// Defaults to 10.
37        #[serde(default = "default_limit", skip_serializing_if = "is_default_limit")]
38        pub limit: UInt,
39
40        /// Language tag to determine the collation to use for the (case-insensitive) search.
41        ///
42        /// See [MDN] for the syntax.
43        ///
44        /// [MDN]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language#Syntax
45        #[ruma_api(header = ACCEPT_LANGUAGE)]
46        pub language: Option<String>,
47    }
48
49    /// Response type for the `search_users` endpoint.
50    #[response(error = crate::Error)]
51    pub struct Response {
52        /// Ordered by rank and then whether or not profile info is available.
53        pub results: Vec<User>,
54
55        /// Indicates if the result list has been truncated by the limit.
56        pub limited: bool,
57    }
58
59    impl Request {
60        /// Creates a new `Request` with the given search term.
61        pub fn new(search_term: String) -> Self {
62            Self { search_term, limit: default_limit(), language: None }
63        }
64    }
65
66    impl Response {
67        /// Creates a new `Response` with the given results and limited flag
68        pub fn new(results: Vec<User>, limited: bool) -> Self {
69            Self { results, limited }
70        }
71    }
72
73    fn default_limit() -> UInt {
74        uint!(10)
75    }
76
77    fn is_default_limit(limit: &UInt) -> bool {
78        limit == &default_limit()
79    }
80
81    /// User data as result of a search.
82    #[derive(Clone, Debug, Deserialize, Serialize)]
83    #[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
84    pub struct User {
85        /// The user's matrix user ID.
86        pub user_id: OwnedUserId,
87
88        /// The display name of the user, if one exists.
89        #[serde(skip_serializing_if = "Option::is_none")]
90        pub display_name: Option<String>,
91
92        /// The avatar url, as an MXC, if one exists.
93        ///
94        /// If you activate the `compat-empty-string-null` feature, this field being an empty
95        /// string in JSON will result in `None` here during deserialization.
96        #[serde(skip_serializing_if = "Option::is_none")]
97        #[cfg_attr(
98            feature = "compat-empty-string-null",
99            serde(default, deserialize_with = "ruma_common::serde::empty_string_as_none")
100        )]
101        pub avatar_url: Option<OwnedMxcUri>,
102    }
103
104    impl User {
105        /// Create a new `User` with the given `UserId`.
106        pub fn new(user_id: OwnedUserId) -> Self {
107            Self { user_id, display_name: None, avatar_url: None }
108        }
109    }
110}
ruma_client_api/user_directory/search_users.rs

ruma_client_api/user_directory/
search_users.rs
