ruma-client-api 0.24.0

Types for the endpoints in the Matrix client-server API.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

//! `GET /_matrix/client/versions` ([spec])
//!
//! Get the versions of the client-server API supported by this homeserver.
//!
//! [spec]: https://spec.matrix.org/v1.18/client-server-api/#get_matrixclientversions

use std::collections::BTreeMap;

use ruma_common::{
    api::{SupportedVersions, auth_scheme::AccessTokenOptional, request, response},
    metadata,
};
#[cfg(feature = "unstable-msc4383")]
use serde::{Deserialize, Serialize};

metadata! {
    method: GET,
    rate_limited: false,
    authentication: AccessTokenOptional,
    path: "/_matrix/client/versions",
}

/// Request type for the `api_versions` endpoint.
#[request]
#[derive(Default)]
pub struct Request {}

/// Response type for the `api_versions` endpoint.
#[response]
pub struct Response {
    /// A list of Matrix client API protocol versions supported by the homeserver.
    pub versions: Vec<String>,

    /// Experimental features supported by the server.
    ///
    /// Servers can enable some unstable features only for some users, so this
    /// list might differ when an access token is provided.
    #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
    pub unstable_features: BTreeMap<String, bool>,

    /// Information about the homeserver implementation, with the same shape as
    /// the object returned by `GET /_matrix/federation/v1/version`.
    ///
    /// This uses the unstable prefix defined in [MSC4383].
    ///
    /// [MSC4383]: https://github.com/matrix-org/matrix-spec-proposals/pull/4383
    #[cfg(feature = "unstable-msc4383")]
    #[serde(rename = "net.zemos.msc4383.server", default, skip_serializing_if = "Option::is_none")]
    pub server: Option<Server>,
}

/// Identifying information about the homeserver implementation.
///
/// This uses the unstable prefix defined in [MSC4383].
///
/// [MSC4383]: https://github.com/matrix-org/matrix-spec-proposals/pull/4383
#[cfg(feature = "unstable-msc4383")]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
pub struct Server {
    /// Arbitrary name that identifies this implementation.
    pub name: String,

    /// Version of this implementation.
    ///
    /// The version format depends on the implementation.
    pub version: String,
}

#[cfg(feature = "unstable-msc4383")]
impl Server {
    /// Creates a `Server` with the given implementation `name` and `version`.
    pub fn new(name: String, version: String) -> Self {
        Self { name, version }
    }
}

impl Request {
    /// Creates an empty `Request`.
    pub fn new() -> Self {
        Self {}
    }
}

impl Response {
    /// Creates a new `Response` with the given `versions`.
    pub fn new(versions: Vec<String>) -> Self {
        Self {
            versions,
            unstable_features: BTreeMap::new(),
            #[cfg(feature = "unstable-msc4383")]
            server: None,
        }
    }

    /// Convert this `Response` into a [`SupportedVersions`] that can be used with
    /// `OutgoingRequest::try_into_http_request()`.
    ///
    /// Matrix versions that can't be parsed to a `MatrixVersion`, and features with the boolean
    /// value set to `false` are discarded.
    pub fn as_supported_versions(&self) -> SupportedVersions {
        SupportedVersions::from_parts(&self.versions, &self.unstable_features)
    }
}