ruma_client_api/media/
create_content.rs

Help
1//! `POST /_matrix/media/*/upload`
2//!
3//! Upload content to the media store.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#post_matrixmediav3upload
9
10    use http::header::CONTENT_TYPE;
11    use ruma_common::{
12        api::{request, response, Metadata},
13        metadata, OwnedMxcUri,
14    };
15
16    const METADATA: Metadata = metadata! {
17        method: POST,
18        rate_limited: true,
19        authentication: AccessToken,
20        history: {
21            1.0 => "/_matrix/media/r0/upload",
22            1.1 => "/_matrix/media/v3/upload",
23        }
24    };
25
26    /// Request type for the `create_media_content` endpoint.
27    #[request(error = crate::Error)]
28    pub struct Request {
29        /// The name of the file being uploaded.
30        #[ruma_api(query)]
31        #[serde(skip_serializing_if = "Option::is_none")]
32        pub filename: Option<String>,
33
34        /// The content type of the file being uploaded.
35        #[ruma_api(header = CONTENT_TYPE)]
36        pub content_type: Option<String>,
37
38        /// Should the server return a blurhash or not.
39        ///
40        /// This uses the unstable prefix in
41        /// [MSC2448](https://github.com/matrix-org/matrix-spec-proposals/pull/2448).
42        #[ruma_api(query)]
43        #[cfg(feature = "unstable-msc2448")]
44        #[serde(
45            default,
46            skip_serializing_if = "ruma_common::serde::is_default",
47            rename = "xyz.amorgan.generate_blurhash"
48        )]
49        pub generate_blurhash: bool,
50
51        /// The file contents to upload.
52        #[ruma_api(raw_body)]
53        pub file: Vec<u8>,
54    }
55
56    /// Response type for the `create_media_content` endpoint.
57    #[response(error = crate::Error)]
58    pub struct Response {
59        /// The MXC URI for the uploaded content.
60        pub content_uri: OwnedMxcUri,
61
62        /// The [BlurHash](https://blurha.sh) for the uploaded content.
63        ///
64        /// This uses the unstable prefix in
65        /// [MSC2448](https://github.com/matrix-org/matrix-spec-proposals/pull/2448).
66        #[cfg(feature = "unstable-msc2448")]
67        #[serde(
68            rename = "xyz.amorgan.blurhash",
69            alias = "blurhash",
70            skip_serializing_if = "Option::is_none"
71        )]
72        pub blurhash: Option<String>,
73    }
74
75    impl Request {
76        /// Creates a new `Request` with the given file contents.
77        pub fn new(file: Vec<u8>) -> Self {
78            Self {
79                file,
80                filename: None,
81                content_type: None,
82                #[cfg(feature = "unstable-msc2448")]
83                generate_blurhash: false,
84            }
85        }
86    }
87
88    impl Response {
89        /// Creates a new `Response` with the given MXC URI.
90        pub fn new(content_uri: OwnedMxcUri) -> Self {
91            Self {
92                content_uri,
93                #[cfg(feature = "unstable-msc2448")]
94                blurhash: None,
95            }
96        }
97    }
98}
ruma_client_api/media/create_content.rs

ruma_client_api/media/
create_content.rs
