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
53
54

//! `GET /_matrix/client/*/rooms/{roomId}/state`

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

    use ruma_common::{api::ruma_api, events::AnyStateEvent, serde::Raw, RoomId};

    ruma_api! {
        metadata: {
            description: "Get state events for a room.",
            method: GET,
            name: "get_state_events",
            r0_path: "/_matrix/client/r0/rooms/:room_id/state",
            stable_path: "/_matrix/client/v3/rooms/:room_id/state",
            rate_limited: false,
            authentication: AccessToken,
            added: 1.0,
        }

        request: {
            /// The room to look up the state for.
            #[ruma_api(path)]
            pub room_id: &'a RoomId,
        }

        response: {
            /// If the user is a member of the room this will be the current state of the room as a
            /// list of events.
            ///
            /// If the user has left the room then this will be the state of the room when they left as
            /// a list of events.
            #[ruma_api(body)]
            pub room_state: Vec<Raw<AnyStateEvent>>,
        }

        error: crate::Error
    }

    impl<'a> Request<'a> {
        /// Creates a new `Request` with the given room ID.
        pub fn new(room_id: &'a RoomId) -> Self {
            Self { room_id }
        }
    }

    impl Response {
        /// Creates a new `Response` with the given room state.
        pub fn new(room_state: Vec<Raw<AnyStateEvent>>) -> Self {
            Self { room_state }
        }
    }
}