ruma_client_api/backup/
get_latest_backup_info.rs

Help
1//! `GET /_matrix/client/*/room_keys/version`
2//!
3//! Get information about the latest backup.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3room_keysversion
9
10    use js_int::UInt;
11    use ruma_common::{
12        api::{request, response, Metadata},
13        metadata,
14        serde::Raw,
15    };
16    use serde::{ser, Deserialize, Deserializer, Serialize};
17    use serde_json::value::to_raw_value as to_raw_json_value;
18
19    use crate::backup::{
20        get_backup_info::v3::{AlgorithmWithData, RefResponseBodyRepr, ResponseBodyRepr},
21        BackupAlgorithm,
22    };
23
24    const METADATA: Metadata = metadata! {
25        method: GET,
26        rate_limited: true,
27        authentication: AccessToken,
28        history: {
29            unstable => "/_matrix/client/unstable/room_keys/version",
30            1.0 => "/_matrix/client/r0/room_keys/version",
31            1.1 => "/_matrix/client/v3/room_keys/version",
32        }
33    };
34
35    /// Request type for the `get_latest_backup_info` endpoint.
36    #[request(error = crate::Error)]
37    #[derive(Default)]
38    pub struct Request {}
39
40    /// Response type for the `get_latest_backup_info` endpoint.
41    #[response(error = crate::Error)]
42    #[ruma_api(manual_body_serde)]
43    pub struct Response {
44        /// The algorithm used for storing backups.
45        pub algorithm: Raw<BackupAlgorithm>,
46
47        /// The number of keys stored in the backup.
48        pub count: UInt,
49
50        /// An opaque string representing stored keys in the backup.
51        ///
52        /// Clients can compare it with the etag value they received in the request of their last
53        /// key storage request.
54        pub etag: String,
55
56        /// The backup version.
57        pub version: String,
58    }
59
60    impl Request {
61        /// Creates an empty `Request`.
62        pub fn new() -> Self {
63            Self {}
64        }
65    }
66
67    impl Response {
68        /// Creates a new `Response` with the given algorithm, key count, etag and version.
69        pub fn new(
70            algorithm: Raw<BackupAlgorithm>,
71            count: UInt,
72            etag: String,
73            version: String,
74        ) -> Self {
75            Self { algorithm, count, etag, version }
76        }
77    }
78
79    impl<'de> Deserialize<'de> for ResponseBody {
80        fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
81        where
82            D: Deserializer<'de>,
83        {
84            let ResponseBodyRepr { algorithm, auth_data, count, etag, version } =
85                ResponseBodyRepr::deserialize(deserializer)?;
86
87            let algorithm = Raw::from_json(
88                to_raw_json_value(&AlgorithmWithData { algorithm, auth_data }).unwrap(),
89            );
90
91            Ok(Self { algorithm, count, etag, version })
92        }
93    }
94
95    impl Serialize for ResponseBody {
96        fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
97        where
98            S: serde::Serializer,
99        {
100            let ResponseBody { algorithm, count, etag, version } = self;
101            let AlgorithmWithData { algorithm, auth_data } =
102                algorithm.deserialize_as().map_err(ser::Error::custom)?;
103
104            let repr = RefResponseBodyRepr {
105                algorithm: &algorithm,
106                auth_data: &auth_data,
107                count: *count,
108                etag,
109                version,
110            };
111
112            repr.serialize(serializer)
113        }
114    }
115}
ruma_client_api/backup/get_latest_backup_info.rs

ruma_client_api/backup/
get_latest_backup_info.rs
