ruma-client-api 0.14.1

Types for the endpoints in the Matrix client-server API.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

//! `GET /_matrix/client/*/directory/room/{roomAlias}`

pub mod v3 {
    //! `/v3/` ([spec])
    //!
    //! [spec]: https://spec.matrix.org/v1.2/client-server-api/#get_matrixclientv3directoryroomroomalias

    use ruma_common::{api::ruma_api, OwnedRoomId, OwnedServerName, RoomAliasId};

    ruma_api! {
        metadata: {
            description: "Resolve a room alias to a room ID.",
            method: GET,
            name: "get_alias",
            r0_path: "/_matrix/client/r0/directory/room/:room_alias",
            stable_path: "/_matrix/client/v3/directory/room/:room_alias",
            rate_limited: false,
            authentication: None,
            added: 1.0,
        }

        request: {
            /// The room alias.
            #[ruma_api(path)]
            pub room_alias: &'a RoomAliasId,
        }

        response: {
            /// The room ID for this room alias.
            pub room_id: OwnedRoomId,

            /// A list of servers that are aware of this room ID.
            pub servers: Vec<OwnedServerName>,
        }

        error: crate::Error
    }

    impl<'a> Request<'a> {
        /// Creates a new `Request` with the given room alias id.
        pub fn new(room_alias: &'a RoomAliasId) -> Self {
            Self { room_alias }
        }
    }

    impl Response {
        /// Creates a new `Response` with the given room id and servers
        pub fn new(room_id: OwnedRoomId, servers: Vec<OwnedServerName>) -> Self {
            Self { room_id, servers }
        }
    }
}