Struct ruma::api::client::media::get_content_thumbnail::v3::Request

pub struct Request<'a> {
    pub media_id: &'a str,
    pub server_name: &'a ServerName,
    pub method: Option<Method>,
    pub width: UInt,
    pub height: UInt,
    pub allow_remote: bool,
    pub max_stall_ms: Option<UInt>,
}

Available on (crate features client-api-c or client-api-s) and (crate features client or server) and crate feature api only.

Data for a request to the get_content_thumbnail API endpoint.

Get a thumbnail of content from the media store.

Fields

media_id: &'a str

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

server_name: &'a ServerName

The server name from the mxc:// URI (the authoritory 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.

max_stall_ms: Option<UInt>

Available on crate feature unstable-msc2246 only.

How long to wait for the media to be uploaded

This uses the unstable prefix in MSC2246

Implementations

impl<'a> Request<'a>

pub fn new(
    media_id: &'a str,
    server_name: &'a ServerName,
    width: UInt,
    height: UInt
) -> Request<'a>

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

pub fn from_url(
    url: &'a MxcUri,
    width: UInt,
    height: UInt
) -> Result<Request<'a>, Error>

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

Trait Implementations

impl<'a> Clone for Request<'a>

fn clone(&self) -> Request<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Request<'a>

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

Formats the value using the given formatter.

impl<'a> OutgoingRequest for Request<'a>

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 = self::METADATA

Metadata about the endpoint.

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

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

impl<'a> OutgoingNonAuthRequest for Request<'a>

Available on crate feature client only.