ruma_federation_api/directory/
get_public_rooms.rs

Help
1//! `GET /_matrix/federation/*/publicRooms`
2//!
3//! Get all the public rooms for the homeserver.
4
5pub mod v1 {
6    //! `/v1/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/server-server-api/#post_matrixfederationv1publicrooms
9
10    use js_int::UInt;
11    use ruma_common::{
12        api::{request, response, Metadata},
13        directory::{PublicRoomsChunk, RoomNetwork},
14        metadata,
15    };
16
17    const METADATA: Metadata = metadata! {
18        method: GET,
19        rate_limited: false,
20        authentication: ServerSignatures,
21        history: {
22            1.0 => "/_matrix/federation/v1/publicRooms",
23        }
24    };
25
26    /// Request type for the `get_public_rooms` endpoint.
27    #[request]
28    #[derive(Default)]
29    pub struct Request {
30        /// Limit for the number of results to return.
31        #[serde(skip_serializing_if = "Option::is_none")]
32        #[ruma_api(query)]
33        pub limit: Option<UInt>,
34
35        /// Pagination token from a previous request.
36        #[serde(skip_serializing_if = "Option::is_none")]
37        #[ruma_api(query)]
38        pub since: Option<String>,
39
40        /// Network to fetch the public room lists from.
41        #[serde(flatten, skip_serializing_if = "ruma_common::serde::is_default")]
42        #[ruma_api(query)]
43        pub room_network: RoomNetwork,
44    }
45
46    /// Response type for the `get_public_rooms` endpoint.
47    #[response]
48    #[derive(Default)]
49    pub struct Response {
50        /// A paginated chunk of public rooms.
51        pub chunk: Vec<PublicRoomsChunk>,
52
53        /// A pagination token for the response.
54        #[serde(skip_serializing_if = "Option::is_none")]
55        pub next_batch: Option<String>,
56
57        /// A pagination token that allows fetching previous results.
58        #[serde(skip_serializing_if = "Option::is_none")]
59        pub prev_batch: Option<String>,
60
61        /// An estimate on the total number of public rooms, if the server has an estimate.
62        pub total_room_count_estimate: Option<UInt>,
63    }
64
65    impl Request {
66        /// Creates an empty `Request`.
67        pub fn new() -> Self {
68            Default::default()
69        }
70    }
71
72    impl Response {
73        /// Creates an empty `Response`.
74        pub fn new() -> Self {
75            Default::default()
76        }
77    }
78}
ruma_federation_api/directory/get_public_rooms.rs

ruma_federation_api/directory/
get_public_rooms.rs
