ruma_client_api/media/
get_media_preview.rs

Help
1//! `GET /_matrix/media/*/preview_url`
2//!
3//! Get a preview for a URL.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixmediav3preview_url
9
10    use ruma_common::{
11        api::{request, response, Metadata},
12        metadata, MilliSecondsSinceUnixEpoch,
13    };
14    use serde::Serialize;
15    use serde_json::value::{to_raw_value as to_raw_json_value, RawValue as RawJsonValue};
16
17    const METADATA: Metadata = metadata! {
18        method: GET,
19        rate_limited: true,
20        authentication: AccessToken,
21        history: {
22            1.0 => "/_matrix/media/r0/preview_url",
23            1.1 => "/_matrix/media/v3/preview_url",
24            1.11 => deprecated,
25        }
26    };
27
28    /// Request type for the `get_media_preview` endpoint.
29    #[request(error = crate::Error)]
30    #[deprecated = "\
31      Since Matrix 1.11, clients should use `authenticated_media::get_media_preview::v1::Request` \
32      instead if the homeserver supports it.\
33    "]
34    pub struct Request {
35        /// URL to get a preview of.
36        #[ruma_api(query)]
37        pub url: String,
38
39        /// Preferred point in time (in milliseconds) to return a preview for.
40        #[ruma_api(query)]
41        #[serde(skip_serializing_if = "Option::is_none")]
42        pub ts: Option<MilliSecondsSinceUnixEpoch>,
43    }
44
45    /// Response type for the `get_media_preview` endpoint.
46    #[response(error = crate::Error)]
47    #[derive(Default)]
48    pub struct Response {
49        /// OpenGraph-like data for the URL.
50        ///
51        /// Differences from OpenGraph: the image size in bytes is added to the `matrix:image:size`
52        /// field, and `og:image` returns the MXC URI to the image, if any.
53        #[ruma_api(body)]
54        pub data: Option<Box<RawJsonValue>>,
55    }
56
57    #[allow(deprecated)]
58    impl Request {
59        /// Creates a new `Request` with the given url.
60        pub fn new(url: String) -> Self {
61            Self { url, ts: None }
62        }
63    }
64
65    impl Response {
66        /// Creates an empty `Response`.
67        pub fn new() -> Self {
68            Self { data: None }
69        }
70
71        /// Creates a new `Response` with the given OpenGraph data (in a
72        /// `serde_json::value::RawValue`).
73        pub fn from_raw_value(data: Box<RawJsonValue>) -> Self {
74            Self { data: Some(data) }
75        }
76
77        /// Creates a new `Response` with the given OpenGraph data (in any kind of serializable
78        /// object).
79        pub fn from_serialize<T: Serialize>(data: &T) -> serde_json::Result<Self> {
80            Ok(Self { data: Some(to_raw_json_value(data)?) })
81        }
82    }
83
84    #[cfg(test)]
85    mod tests {
86        use assert_matches2::assert_matches;
87        use serde_json::{
88            from_value as from_json_value, json,
89            value::{to_raw_value as to_raw_json_value, RawValue as RawJsonValue},
90        };
91
92        // Since BTreeMap<String, Box<RawJsonValue>> deserialization doesn't seem to
93        // work, test that Option<RawJsonValue> works
94        #[test]
95        fn raw_json_deserialize() {
96            type OptRawJson = Option<Box<RawJsonValue>>;
97
98            assert_matches!(from_json_value::<OptRawJson>(json!(null)).unwrap(), None);
99            from_json_value::<OptRawJson>(json!("test")).unwrap().unwrap();
100            from_json_value::<OptRawJson>(json!({ "a": "b" })).unwrap().unwrap();
101        }
102
103        // For completeness sake, make sure serialization works too
104        #[test]
105        fn raw_json_serialize() {
106            to_raw_json_value(&json!(null)).unwrap();
107            to_raw_json_value(&json!("string")).unwrap();
108            to_raw_json_value(&json!({})).unwrap();
109            to_raw_json_value(&json!({ "a": "b" })).unwrap();
110        }
111    }
112}
ruma_client_api/media/get_media_preview.rs

ruma_client_api/media/
get_media_preview.rs
