ruma_common/
media.rs

1//! Common types and functions for the [content repository].
2//!
3//! [content repository]: https://spec.matrix.org/latest/client-server-api/#content-repository
4
5use std::time::Duration;
6
7use ruma_macros::{OrdAsRefStr, PartialEqAsRefStr, PartialOrdAsRefStr};
8
9use crate::{serde::StringEnum, PrivOwnedStr};
10
11/// The desired resizing method for a thumbnail.
12#[doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/src/doc/string_enum.md"))]
13#[derive(Clone, StringEnum, PartialEqAsRefStr, Eq, PartialOrdAsRefStr, OrdAsRefStr)]
14#[ruma_enum(rename_all = "snake_case")]
15#[non_exhaustive]
16pub enum Method {
17    /// Crop the original to produce the requested image dimensions.
18    Crop,
19
20    /// Maintain the original aspect ratio of the source image.
21    Scale,
22
23    #[doc(hidden)]
24    _Custom(PrivOwnedStr),
25}
26
27/// The default duration that the client should be willing to wait to start receiving data.
28pub fn default_download_timeout() -> Duration {
29    Duration::from_secs(20)
30}
31
32/// Whether the given duration is the default duration that the client should be willing to wait to
33/// start receiving data.
34pub fn is_default_download_timeout(timeout: &Duration) -> bool {
35    timeout.as_secs() == 20
36}