Struct ruma_client_api::authenticated_media::get_content_thumbnail::v1::Request

#[non_exhaustive]
pub struct Request {
    pub server_name: OwnedServerName,
    pub media_id: String,
    pub method: Option<Method>,
    pub width: UInt,
    pub height: UInt,
    pub timeout_ms: Duration,
    pub animated: Option<bool>,
}

Request type for the get_content_thumbnail endpoint.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

server_name: OwnedServerName

The server name from the mxc:// URI (the authoritory component).

media_id: String

The media ID from the mxc:// URI (the path component).

method: Option<Method>

The desired resizing method.

width: UInt

The desired width of the thumbnail.

The actual thumbnail may not match the size specified.

height: UInt

The desired height of the thumbnail.

The actual thumbnail may not match the size specified.

timeout_ms: Duration

The maximum duration that the client is willing to wait to start receiving data, in the case that the content has not yet been uploaded.

The default value is 20 seconds.

animated: Option<bool>

Whether the server should return an animated thumbnail.

When Some(true), the server should return an animated thumbnail if possible and supported. When Some(false), the server must not return an animated thumbnail. When None, the server should not return an animated thumbnail.

Implementations

impl Request

pub fn new( media_id: String, server_name: OwnedServerName, width: UInt, height: UInt, ) -> Self

Creates a new Request with the given media ID, server name, desired thumbnail width and desired thumbnail height.

pub fn from_uri( uri: &MxcUri, width: UInt, height: UInt, ) -> Result<Self, IdParseError>

Creates a new Request with the given URI, desired thumbnail width and desired thumbnail height.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Request

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl OutgoingRequest for Request

type EndpointError = Error

A type capturing the expected error conditions the server can return.

type IncomingResponse = Response

Response type returned when the request is successful.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

fn try_into_http_request<T: Default + BufMut>( self, base_url: &str, access_token: SendAccessToken<'_>, considering_versions: &[MatrixVersion], ) -> Result<Request<T>, IntoHttpError>

Tries to convert this request into an http::Request.