ruma_client_api/state/
get_state_events_for_key.rs

Help
1//! `GET /_matrix/client/*/rooms/{roomId}/state/{eventType}/{stateKey}`
2//!
3//! Get state events associated with a given key.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3roomsroomidstateeventtypestatekey
9
10    use ruma_common::{
11        api::{response, Metadata},
12        metadata,
13        serde::Raw,
14        OwnedRoomId,
15    };
16    use ruma_events::{AnyStateEventContent, StateEventType};
17
18    const METADATA: Metadata = metadata! {
19        method: GET,
20        rate_limited: false,
21        authentication: AccessToken,
22        history: {
23            1.0 => "/_matrix/client/r0/rooms/:room_id/state/:event_type/:state_key",
24            1.1 => "/_matrix/client/v3/rooms/:room_id/state/:event_type/:state_key",
25        }
26    };
27
28    /// Request type for the `get_state_events_for_key` endpoint.
29    #[derive(Clone, Debug)]
30    #[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
31    pub struct Request {
32        /// The room to look up the state for.
33        pub room_id: OwnedRoomId,
34
35        /// The type of state to look up.
36        pub event_type: StateEventType,
37
38        /// The key of the state to look up.
39        pub state_key: String,
40    }
41
42    impl Request {
43        /// Creates a new `Request` with the given room ID, event type and state key.
44        pub fn new(room_id: OwnedRoomId, event_type: StateEventType, state_key: String) -> Self {
45            Self { room_id, event_type, state_key }
46        }
47    }
48
49    /// Response type for the `get_state_events_for_key` endpoint.
50    #[response(error = crate::Error)]
51    pub struct Response {
52        /// The content of the state event.
53        ///
54        /// Since the inner type of the `Raw` does not implement `Deserialize`, you need to use
55        /// [`Raw::deserialize_as`] to deserialize it.
56        #[ruma_api(body)]
57        pub content: Raw<AnyStateEventContent>,
58    }
59
60    impl Response {
61        /// Creates a new `Response` with the given content.
62        pub fn new(content: Raw<AnyStateEventContent>) -> Self {
63            Self { content }
64        }
65    }
66
67    #[cfg(feature = "client")]
68    impl ruma_common::api::OutgoingRequest for Request {
69        type EndpointError = crate::Error;
70        type IncomingResponse = Response;
71
72        const METADATA: Metadata = METADATA;
73
74        fn try_into_http_request<T: Default + bytes::BufMut>(
75            self,
76            base_url: &str,
77            access_token: ruma_common::api::SendAccessToken<'_>,
78            considering_versions: &'_ [ruma_common::api::MatrixVersion],
79        ) -> Result<http::Request<T>, ruma_common::api::error::IntoHttpError> {
80            use http::header;
81
82            http::Request::builder()
83                .method(http::Method::GET)
84                .uri(METADATA.make_endpoint_url(
85                    considering_versions,
86                    base_url,
87                    &[&self.room_id, &self.event_type, &self.state_key],
88                    "",
89                )?)
90                .header(header::CONTENT_TYPE, "application/json")
91                .header(
92                    header::AUTHORIZATION,
93                    format!(
94                        "Bearer {}",
95                        access_token
96                            .get_required_for_endpoint()
97                            .ok_or(ruma_common::api::error::IntoHttpError::NeedsAuthentication)?,
98                    ),
99                )
100                .body(T::default())
101                .map_err(Into::into)
102        }
103    }
104
105    #[cfg(feature = "server")]
106    impl ruma_common::api::IncomingRequest for Request {
107        type EndpointError = crate::Error;
108        type OutgoingResponse = Response;
109
110        const METADATA: Metadata = METADATA;
111
112        fn try_from_http_request<B, S>(
113            _request: http::Request<B>,
114            path_args: &[S],
115        ) -> Result<Self, ruma_common::api::error::FromHttpRequestError>
116        where
117            B: AsRef<[u8]>,
118            S: AsRef<str>,
119        {
120            // FIXME: find a way to make this if-else collapse with serde recognizing trailing
121            // Option
122            let (room_id, event_type, state_key): (OwnedRoomId, StateEventType, String) =
123                if path_args.len() == 3 {
124                    serde::Deserialize::deserialize(serde::de::value::SeqDeserializer::<
125                        _,
126                        serde::de::value::Error,
127                    >::new(
128                        path_args.iter().map(::std::convert::AsRef::as_ref),
129                    ))?
130                } else {
131                    let (a, b) =
132                        serde::Deserialize::deserialize(serde::de::value::SeqDeserializer::<
133                            _,
134                            serde::de::value::Error,
135                        >::new(
136                            path_args.iter().map(::std::convert::AsRef::as_ref),
137                        ))?;
138
139                    (a, b, "".into())
140                };
141
142            Ok(Self { room_id, event_type, state_key })
143        }
144    }
145}
ruma_client_api/state/get_state_events_for_key.rs

ruma_client_api/state/
get_state_events_for_key.rs
