ruma_federation_api/authenticated_media/
get_content.rs

Help
1//! `GET /_matrix/federation/*/media/download/{mediaId}`
2//!
3//! Retrieve content from the media store.
4
5pub mod v1 {
6    //! `/v1/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/server-server-api/#get_matrixfederationv1mediadownloadmediaid
9
10    use std::time::Duration;
11
12    use ruma_common::{
13        api::{request, Metadata},
14        metadata,
15    };
16
17    use crate::authenticated_media::{ContentMetadata, FileOrLocation};
18
19    const METADATA: Metadata = metadata! {
20        method: GET,
21        rate_limited: true,
22        authentication: ServerSignatures,
23        history: {
24            unstable => "/_matrix/federation/unstable/org.matrix.msc3916.v2/media/download/:media_id",
25            1.11 => "/_matrix/federation/v1/media/download/:media_id",
26        }
27    };
28
29    /// Request type for the `get_content` endpoint.
30    #[request]
31    pub struct Request {
32        /// The media ID from the `mxc://` URI (the path component).
33        #[ruma_api(path)]
34        pub media_id: String,
35
36        /// The maximum duration that the client is willing to wait to start receiving data, in the
37        /// case that the content has not yet been uploaded.
38        ///
39        /// The default value is 20 seconds.
40        #[ruma_api(query)]
41        #[serde(
42            with = "ruma_common::serde::duration::ms",
43            default = "ruma_common::media::default_download_timeout",
44            skip_serializing_if = "ruma_common::media::is_default_download_timeout"
45        )]
46        pub timeout_ms: Duration,
47    }
48
49    impl Request {
50        /// Creates a new `Request` with the given media ID.
51        pub fn new(media_id: String) -> Self {
52            Self { media_id, timeout_ms: ruma_common::media::default_download_timeout() }
53        }
54    }
55
56    /// Response type for the `get_content` endpoint.
57    #[derive(Debug, Clone)]
58    #[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
59    pub struct Response {
60        /// The metadata of the media.
61        pub metadata: ContentMetadata,
62
63        /// The content of the media.
64        pub content: FileOrLocation,
65    }
66
67    impl Response {
68        /// Creates a new `Response` with the given metadata and content.
69        pub fn new(metadata: ContentMetadata, content: FileOrLocation) -> Self {
70            Self { metadata, content }
71        }
72    }
73
74    #[cfg(feature = "client")]
75    impl ruma_common::api::IncomingResponse for Response {
76        type EndpointError = ruma_common::api::error::MatrixError;
77
78        fn try_from_http_response<T: AsRef<[u8]>>(
79            http_response: http::Response<T>,
80        ) -> Result<Self, ruma_common::api::error::FromHttpResponseError<Self::EndpointError>>
81        {
82            use ruma_common::api::EndpointError;
83
84            if http_response.status().as_u16() < 400 {
85                let (metadata, content) =
86                    crate::authenticated_media::try_from_multipart_mixed_response(http_response)?;
87                Ok(Self { metadata, content })
88            } else {
89                Err(ruma_common::api::error::FromHttpResponseError::Server(
90                    ruma_common::api::error::MatrixError::from_http_response(http_response),
91                ))
92            }
93        }
94    }
95
96    #[cfg(feature = "server")]
97    impl ruma_common::api::OutgoingResponse for Response {
98        fn try_into_http_response<T: Default + bytes::BufMut>(
99            self,
100        ) -> Result<http::Response<T>, ruma_common::api::error::IntoHttpError> {
101            crate::authenticated_media::try_into_multipart_mixed_response(
102                &self.metadata,
103                &self.content,
104            )
105        }
106    }
107}
ruma_federation_api/authenticated_media/get_content.rs

ruma_federation_api/authenticated_media/
get_content.rs
