Struct ruma_client_api::media::get_content_thumbnail::v3::Request

pub struct Request {
    pub server_name: OwnedServerName,
    pub media_id: String,
    pub method: Option<Method>,
    pub width: UInt,
    pub height: UInt,
    pub allow_remote: bool,
    pub timeout_ms: Duration,
    pub allow_redirect: bool,
    pub animated: bool,
}

Available on crate features client or server only.

Request type for the get_content_thumbnail endpoint.

Fields

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.

allow_remote: bool

Whether to fetch media deemed remote.

Used to prevent routing loops. Defaults to true.

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.

allow_redirect: bool

Whether the server may return a 307 or 308 redirect response that points at the relevant media content.

Unless explicitly set to true, the server must return the media content itself.

animated: bool

Available on crate feature unstable-msc2705 only.

Whether the server should return an animated thumbnail.

When true, the server should return an animated thumbnail if possible and supported. Otherwise it must not return an animated thumbnail.

Defaults to false.

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_url( url: &MxcUri, width: UInt, height: UInt ) -> Result<Self, IdParseError>

Creates a new Request with the given url, 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 IncomingRequest for Request

Available on crate feature server only.

type EndpointError = Error

A type capturing the error conditions that can be returned in the response.

type OutgoingResponse = Response

Response type to return when the request is successful.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

fn try_from_http_request<B, S>( request: Request<B>, path_args: &[S] ) -> Result<Self, FromHttpRequestError>

where B: AsRef<[u8]>, S: AsRef<str>,

Tries to turn the given http::Request into this request type, together with the corresponding path arguments.

impl OutgoingRequest for Request

Available on crate feature client only.

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.