ruma_federation_api/event/
get_event.rs

1//! `GET /_matrix/federation/*/event/{eventId}`
2//!
3//! Retrieves a single event.
4
5pub mod v1 {
6    //! `/v1/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/server-server-api/#get_matrixfederationv1eventeventid
9
10    use ruma_common::{
11        api::{request, response, Metadata},
12        metadata, MilliSecondsSinceUnixEpoch, OwnedEventId, OwnedServerName,
13    };
14    use serde_json::value::RawValue as RawJsonValue;
15
16    const METADATA: Metadata = metadata! {
17        method: GET,
18        rate_limited: false,
19        authentication: ServerSignatures,
20        history: {
21            1.0 => "/_matrix/federation/v1/event/:event_id",
22        }
23    };
24
25    /// Request type for the `get_event` endpoint.
26    #[request]
27    pub struct Request {
28        /// The event ID to get.
29        #[ruma_api(path)]
30        pub event_id: OwnedEventId,
31    }
32
33    /// Response type for the `get_event` endpoint.
34    #[response]
35    pub struct Response {
36        /// The `server_name` of the homeserver sending this transaction.
37        pub origin: OwnedServerName,
38
39        /// Time on originating homeserver when this transaction started.
40        pub origin_server_ts: MilliSecondsSinceUnixEpoch,
41
42        /// The event.
43        #[serde(rename = "pdus", with = "ruma_common::serde::single_element_seq")]
44        pub pdu: Box<RawJsonValue>,
45    }
46
47    impl Request {
48        /// Creates a new `Request` with the given event id.
49        pub fn new(event_id: OwnedEventId) -> Self {
50            Self { event_id }
51        }
52    }
53
54    impl Response {
55        /// Creates a new `Response` with the given server name, timestamp, and event.
56        pub fn new(
57            origin: OwnedServerName,
58            origin_server_ts: MilliSecondsSinceUnixEpoch,
59            pdu: Box<RawJsonValue>,
60        ) -> Self {
61            Self { origin, origin_server_ts, pdu }
62        }
63    }
64}