logo
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
55
56
57

//! `GET /_matrix/federation/*/state/{roomId}`
//!
//! Retrieves a snapshot of a room's state at a given event.

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

    use ruma_common::{api::ruma_api, EventId, RoomId};
    use serde_json::value::RawValue as RawJsonValue;

    ruma_api! {
        metadata: {
            description: "Retrieves a snapshot of a room's state at a given event.",
            method: GET,
            name: "get_room_state",
            stable_path: "/_matrix/federation/v1/state/:room_id",
            rate_limited: false,
            authentication: ServerSignatures,
            added: 1.0,
        }

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

            /// An event ID in the room to retrieve the state at.
            #[ruma_api(query)]
            pub event_id: &'a EventId,
        }

        response: {
            /// The full set of authorization events that make up the state of the
            /// room, and their authorization events, recursively.
            pub auth_chain: Vec<Box<RawJsonValue>>,

            /// The fully resolved state of the room at the given event.
            pub pdus: Vec<Box<RawJsonValue>>,
        }
    }

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

    impl Response {
        /// Creates a new `Response` with the given auth chain and room state.
        pub fn new(auth_chain: Vec<Box<RawJsonValue>>, pdus: Vec<Box<RawJsonValue>>) -> Self {
            Self { auth_chain, pdus }
        }
    }
}