ruma_identity_service_api/discovery/
get_supported_versions.rs

Help
1//! `GET /_matrix/identity/versions` ([spec])
2//!
3//! Get the versions of the identity service API supported by this endpoint.
4//!
5//! Note: This endpoint was only implemented in/after 1.1, so a 404 could indicate the server only
6//! supports 1.0 endpoints. Please use [`server_status`](super::get_server_status) to
7//! double-check.
8//!
9//! Note: This endpoint does not contain an unstable variant for 1.0.
10//!
11//! [spec]: https://spec.matrix.org/latest/identity-service-api/#get_matrixidentityversions
12
13use std::collections::BTreeSet;
14
15use ruma_common::{
16    api::{request, response, MatrixVersion, Metadata},
17    metadata,
18};
19
20const METADATA: Metadata = metadata! {
21    method: GET,
22    rate_limited: false,
23    authentication: None,
24    history: {
25        1.1 => "/_matrix/identity/versions",
26    }
27};
28
29/// Request type for the `versions` endpoint.
30#[request]
31#[derive(Default)]
32pub struct Request {}
33
34/// Response type for the `versions` endpoint.
35#[response]
36pub struct Response {
37    /// A list of Matrix client API protocol versions supported by the endpoint.
38    pub versions: Vec<String>,
39}
40
41impl Request {
42    /// Creates an empty `Request`.
43    pub fn new() -> Self {
44        Self {}
45    }
46}
47
48impl Response {
49    /// Creates a new `Response` with the given `versions`.
50    pub fn new(versions: Vec<String>) -> Self {
51        Self { versions }
52    }
53
54    /// Extracts known Matrix versions from this response.
55    ///
56    /// Matrix versions that Ruma cannot parse, or does not know about, are discarded.
57    ///
58    /// The versions returned will be sorted from oldest to latest. Use [`.find()`][Iterator::find]
59    /// or [`.rfind()`][DoubleEndedIterator::rfind] to look for a minimum or maximum version to use
60    /// given some constraint.
61    pub fn known_versions(&self) -> BTreeSet<MatrixVersion> {
62        self.versions
63            .iter()
64            // Parse, discard unknown versions
65            .flat_map(|s| s.parse::<MatrixVersion>())
66            // Collect to BTreeSet
67            .collect()
68    }
69}
ruma_identity_service_api/discovery/get_supported_versions.rs

ruma_identity_service_api/discovery/
get_supported_versions.rs
