ruma_client_api/session/
logout.rs

Help
1//! `POST /_matrix/client/*/logout`
2//!
3//! Log out of the homeserver.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3logout
9
10    use ruma_common::{
11        api::{response, Metadata},
12        metadata,
13    };
14
15    const METADATA: Metadata = metadata! {
16        method: POST,
17        rate_limited: false,
18        authentication: AccessToken,
19        history: {
20            1.0 => "/_matrix/client/r0/logout",
21            1.1 => "/_matrix/client/v3/logout",
22        }
23    };
24
25    /// Request type for the `logout` endpoint.
26    #[derive(Debug, Clone, Default)]
27    #[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
28    pub struct Request {}
29
30    impl Request {
31        /// Creates an empty `Request`.
32        pub fn new() -> Self {
33            Self {}
34        }
35    }
36
37    #[cfg(feature = "client")]
38    impl ruma_common::api::OutgoingRequest for Request {
39        type EndpointError = crate::Error;
40        type IncomingResponse = Response;
41
42        const METADATA: Metadata = METADATA;
43
44        fn try_into_http_request<T: Default + bytes::BufMut>(
45            self,
46            base_url: &str,
47            access_token: ruma_common::api::SendAccessToken<'_>,
48            considering_versions: &'_ [ruma_common::api::MatrixVersion],
49        ) -> Result<http::Request<T>, ruma_common::api::error::IntoHttpError> {
50            let url = METADATA.make_endpoint_url(considering_versions, base_url, &[], "")?;
51
52            http::Request::builder()
53                .method(METADATA.method)
54                .uri(url)
55                .header(
56                    http::header::AUTHORIZATION,
57                    format!(
58                        "Bearer {}",
59                        access_token
60                            .get_required_for_endpoint()
61                            .ok_or(ruma_common::api::error::IntoHttpError::NeedsAuthentication)?,
62                    ),
63                )
64                .body(T::default())
65                .map_err(Into::into)
66        }
67    }
68
69    #[cfg(feature = "server")]
70    impl ruma_common::api::IncomingRequest for Request {
71        type EndpointError = crate::Error;
72        type OutgoingResponse = Response;
73
74        const METADATA: Metadata = METADATA;
75
76        fn try_from_http_request<B, S>(
77            request: http::Request<B>,
78            _path_args: &[S],
79        ) -> Result<Self, ruma_common::api::error::FromHttpRequestError>
80        where
81            B: AsRef<[u8]>,
82            S: AsRef<str>,
83        {
84            if request.method() != METADATA.method {
85                return Err(ruma_common::api::error::FromHttpRequestError::MethodMismatch {
86                    expected: METADATA.method,
87                    received: request.method().clone(),
88                });
89            }
90
91            Ok(Self {})
92        }
93    }
94
95    /// Response type for the `logout` endpoint.
96    #[response(error = crate::Error)]
97    #[derive(Default)]
98    pub struct Response {}
99
100    impl Response {
101        /// Creates an empty `Response`.
102        pub fn new() -> Self {
103            Self {}
104        }
105    }
106}
ruma_client_api/session/logout.rs

ruma_client_api/session/
logout.rs
