ruma_federation_api/backfill/
get_backfill.rs

Help
1//! `GET /_matrix/federation/*/backfill/{roomId}`
2//!
3//! Get more history from another homeserver.
4
5pub mod v1 {
6    //! `/v1/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/server-server-api/#get_matrixfederationv1backfillroomid
9
10    use js_int::UInt;
11    use ruma_common::{
12        api::{request, response, Metadata},
13        metadata, MilliSecondsSinceUnixEpoch, OwnedEventId, OwnedRoomId, OwnedServerName,
14    };
15    use serde_json::value::RawValue as RawJsonValue;
16
17    const METADATA: Metadata = metadata! {
18        method: GET,
19        rate_limited: false,
20        authentication: ServerSignatures,
21        history: {
22            1.0 => "/_matrix/federation/v1/backfill/:room_id",
23        }
24    };
25
26    /// Request type for the `get_backfill` endpoint.
27    #[request]
28    pub struct Request {
29        /// The room ID to backfill.
30        #[ruma_api(path)]
31        pub room_id: OwnedRoomId,
32
33        /// The event IDs to backfill from.
34        #[ruma_api(query)]
35        pub v: Vec<OwnedEventId>,
36
37        /// The maximum number of PDUs to retrieve, including the given events.
38        #[ruma_api(query)]
39        pub limit: UInt,
40    }
41
42    /// Response type for the `get_backfill` endpoint.
43    #[response]
44    pub struct Response {
45        /// The `server_name` of the homeserver sending this transaction.
46        pub origin: OwnedServerName,
47
48        /// POSIX timestamp in milliseconds on originating homeserver when this transaction
49        /// started.
50        pub origin_server_ts: MilliSecondsSinceUnixEpoch,
51
52        /// List of persistent updates to rooms.
53        pub pdus: Vec<Box<RawJsonValue>>,
54    }
55
56    impl Request {
57        /// Creates a new `Request` with:
58        /// * the given room id.
59        /// * the event IDs to backfill from.
60        /// * the maximum number of PDUs to retrieve, including the given events.
61        pub fn new(room_id: OwnedRoomId, v: Vec<OwnedEventId>, limit: UInt) -> Self {
62            Self { room_id, v, limit }
63        }
64    }
65
66    impl Response {
67        /// Creates a new `Response` with:
68        /// * the `server_name` of the homeserver.
69        /// * the timestamp in milliseconds of when this transaction started.
70        /// * the list of persistent updates to rooms.
71        pub fn new(
72            origin: OwnedServerName,
73            origin_server_ts: MilliSecondsSinceUnixEpoch,
74            pdus: Vec<Box<RawJsonValue>>,
75        ) -> Self {
76            Self { origin, origin_server_ts, pdus }
77        }
78    }
79}
ruma_federation_api/backfill/get_backfill.rs

ruma_federation_api/backfill/
get_backfill.rs
