ruma_client_api/discovery/
discover_homeserver.rs

Help
1//! `GET /.well-known/matrix/client` ([spec])
2//!
3//! [spec]: https://spec.matrix.org/latest/client-server-api/#getwell-knownmatrixclient
4//!
5//! Get discovery information about the domain.
6
7use ruma_common::{
8    api::{request, response, Metadata},
9    metadata,
10};
11use serde::{Deserialize, Serialize};
12
13const METADATA: Metadata = metadata! {
14    method: GET,
15    rate_limited: false,
16    authentication: None,
17    history: {
18        1.0 => "/.well-known/matrix/client",
19    }
20};
21
22/// Request type for the `client_well_known` endpoint.
23#[request(error = crate::Error)]
24#[derive(Default)]
25pub struct Request {}
26
27/// Response type for the `client_well_known` endpoint.
28#[response(error = crate::Error)]
29pub struct Response {
30    /// Information about the homeserver to connect to.
31    #[serde(rename = "m.homeserver")]
32    pub homeserver: HomeserverInfo,
33
34    /// Information about the identity server to connect to.
35    #[serde(rename = "m.identity_server", skip_serializing_if = "Option::is_none")]
36    pub identity_server: Option<IdentityServerInfo>,
37
38    /// Information about the tile server to use to display location data.
39    #[cfg(feature = "unstable-msc3488")]
40    #[serde(
41        rename = "org.matrix.msc3488.tile_server",
42        alias = "m.tile_server",
43        skip_serializing_if = "Option::is_none"
44    )]
45    pub tile_server: Option<TileServerInfo>,
46
47    /// Information about the authentication server to connect to when using OpenID Connect.
48    #[cfg(feature = "unstable-msc2965")]
49    #[serde(
50        rename = "org.matrix.msc2965.authentication",
51        alias = "m.authentication",
52        skip_serializing_if = "Option::is_none"
53    )]
54    pub authentication: Option<AuthenticationServerInfo>,
55}
56
57impl Request {
58    /// Creates an empty `Request`.
59    pub fn new() -> Self {
60        Self {}
61    }
62}
63
64impl Response {
65    /// Creates a new `Response` with the given `HomeserverInfo`.
66    pub fn new(homeserver: HomeserverInfo) -> Self {
67        Self {
68            homeserver,
69            identity_server: None,
70            #[cfg(feature = "unstable-msc3488")]
71            tile_server: None,
72            #[cfg(feature = "unstable-msc2965")]
73            authentication: None,
74        }
75    }
76}
77
78/// Information about a discovered homeserver.
79#[derive(Clone, Debug, Deserialize, Hash, Serialize)]
80#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
81pub struct HomeserverInfo {
82    /// The base URL for the homeserver for client-server connections.
83    pub base_url: String,
84}
85
86impl HomeserverInfo {
87    /// Creates a new `HomeserverInfo` with the given `base_url`.
88    pub fn new(base_url: String) -> Self {
89        Self { base_url }
90    }
91}
92
93/// Information about a discovered identity server.
94#[derive(Clone, Debug, Deserialize, Hash, Serialize)]
95#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
96pub struct IdentityServerInfo {
97    /// The base URL for the identity server for client-server connections.
98    pub base_url: String,
99}
100
101impl IdentityServerInfo {
102    /// Creates an `IdentityServerInfo` with the given `base_url`.
103    pub fn new(base_url: String) -> Self {
104        Self { base_url }
105    }
106}
107
108/// Information about a discovered map tile server.
109#[cfg(feature = "unstable-msc3488")]
110#[derive(Clone, Debug, Deserialize, Hash, Serialize)]
111#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
112pub struct TileServerInfo {
113    /// The URL of a map tile server's `style.json` file.
114    ///
115    /// See the [Mapbox Style Specification](https://docs.mapbox.com/mapbox-gl-js/style-spec/) for more details.
116    pub map_style_url: String,
117}
118
119#[cfg(feature = "unstable-msc3488")]
120impl TileServerInfo {
121    /// Creates a `TileServerInfo` with the given map style URL.
122    pub fn new(map_style_url: String) -> Self {
123        Self { map_style_url }
124    }
125}
126
127/// Information about a discovered authentication server.
128#[cfg(feature = "unstable-msc2965")]
129#[derive(Clone, Debug, Deserialize, Hash, Serialize)]
130#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
131pub struct AuthenticationServerInfo {
132    /// The OIDC Provider that is trusted by the homeserver.
133    pub issuer: String,
134
135    /// The URL where the user is able to access the account management
136    /// capabilities of the OIDC Provider.
137    #[serde(skip_serializing_if = "Option::is_none")]
138    pub account: Option<String>,
139}
140
141#[cfg(feature = "unstable-msc2965")]
142impl AuthenticationServerInfo {
143    /// Creates an `AuthenticationServerInfo` with the given `issuer` and an optional `account`.
144    pub fn new(issuer: String, account: Option<String>) -> Self {
145        Self { issuer, account }
146    }
147}
ruma_client_api/discovery/discover_homeserver.rs

ruma_client_api/discovery/
discover_homeserver.rs
