ruwuma/ruma-client-api/src/r0/media/get_content_thumbnail.rs

88 lines
2.7 KiB
Rust

//! [GET /_matrix/media/r0/thumbnail/{serverName}/{mediaId}](https://matrix.org/docs/spec/client_server/r0.6.0#get-matrix-media-r0-thumbnail-servername-mediaid)
use js_int::UInt;
use ruma_api::ruma_api;
use ruma_identifiers::ServerName;
use serde::{Deserialize, Serialize};
/// The desired resizing method.
#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum Method {
/// Crop the original to produce the requested image dimensions.
Crop,
/// Maintain the original aspect ratio of the source image.
Scale,
}
ruma_api! {
metadata: {
description: "Get a thumbnail of content from the media store.",
method: GET,
name: "get_content_thumbnail",
path: "/_matrix/media/r0/thumbnail/:server_name/:media_id",
rate_limited: true,
requires_authentication: false,
}
request: {
/// The media ID from the mxc:// URI (the path component).
#[ruma_api(path)]
pub media_id: &'a str,
/// The server name from the mxc:// URI (the authoritory component).
#[ruma_api(path)]
pub server_name: &'a ServerName,
/// The desired resizing method.
#[ruma_api(query)]
#[serde(skip_serializing_if = "Option::is_none")]
pub method: Option<Method>,
/// The *desired* width of the thumbnail. The actual thumbnail may not match the size
/// specified.
#[ruma_api(query)]
pub width: UInt,
/// The *desired* height of the thumbnail. The actual thumbnail may not match the size
/// specified.
#[ruma_api(query)]
pub height: UInt,
/// Whether to fetch media deemed remote.
///
/// Used to prevent routing loops. Defaults to `true`.
#[ruma_api(query)]
#[serde(default = "ruma_serde::default_true", skip_serializing_if = "ruma_serde::is_true")]
pub allow_remote: bool,
}
response: {
/// The content type of the thumbnail.
#[ruma_api(header = CONTENT_TYPE)]
pub content_type: String,
/// A thumbnail of the requested content.
#[ruma_api(raw_body)]
pub file: Vec<u8>,
}
error: crate::Error
}
impl<'a> Request<'a> {
/// Creates a new `Request` with the given media ID, server name, desired thumbnail width and
/// desired thumbnail height.
pub fn new(media_id: &'a str, server_name: &'a ServerName, width: UInt, height: UInt) -> Self {
Self { media_id, server_name, method: None, width, height, allow_remote: true }
}
}
impl Response {
/// Creates a new `Response` with the given content type and thumbnail.
pub fn new(content_type: String, file: Vec<u8>) -> Self {
Self { content_type, file }
}
}