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

source · 
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: Option<bool>,
}
👎Deprecated: Since Matrix 1.11, clients should use authenticated_media::get_content_thumbnail::v1::Request instead if the homeserver supports it.
Available on (crate features client-api-c or client-api-s) and (crate features client or server) and crate feature api only.
Expand description

Request type for the get_content_thumbnail endpoint.

Fields§

§server_name: OwnedServerName
👎Deprecated: Since Matrix 1.11, clients should use authenticated_media::get_content_thumbnail::v1::Request instead if the homeserver supports it.

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

§media_id: String
👎Deprecated: Since Matrix 1.11, clients should use authenticated_media::get_content_thumbnail::v1::Request instead if the homeserver supports it.

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

§method: Option<Method>
👎Deprecated: Since Matrix 1.11, clients should use authenticated_media::get_content_thumbnail::v1::Request instead if the homeserver supports it.

The desired resizing method.

§width: UInt
👎Deprecated: Since Matrix 1.11, clients should use authenticated_media::get_content_thumbnail::v1::Request instead if the homeserver supports it.

The desired width of the thumbnail.

The actual thumbnail may not match the size specified.

§height: UInt
👎Deprecated: Since Matrix 1.11, clients should use authenticated_media::get_content_thumbnail::v1::Request instead if the homeserver supports it.

The desired height of the thumbnail.

The actual thumbnail may not match the size specified.

§allow_remote: bool
👎Deprecated: Since Matrix 1.11, clients should use authenticated_media::get_content_thumbnail::v1::Request instead if the homeserver supports it.

Whether to fetch media deemed remote.

Used to prevent routing loops. Defaults to true.

§timeout_ms: Duration
👎Deprecated: Since Matrix 1.11, clients should use authenticated_media::get_content_thumbnail::v1::Request instead if the homeserver supports it.

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
👎Deprecated: Since Matrix 1.11, clients should use authenticated_media::get_content_thumbnail::v1::Request instead if the homeserver supports it.

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: Option<bool>
👎Deprecated: Since Matrix 1.11, clients should use authenticated_media::get_content_thumbnail::v1::Request instead if the homeserver supports it.

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§

source§

impl Request

source

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

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

source

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

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

Trait Implementations§

source§

impl Clone for Request

source§

fn clone(&self) -> Request

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Request

source§

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

Formats the value using the given formatter. Read more
source§

impl IncomingRequest for Request

Available on crate feature server only.
source§

const METADATA: Metadata = METADATA

Metadata about the endpoint.
source§

type EndpointError = Error

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

type OutgoingResponse = Response

Response type to return when the request is successful.
source§

fn try_from_http_request<B, S>( request: Request<B>, path_args: &[S], ) -> Result<Request, 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. Read more
source§

impl OutgoingRequest for Request

Available on crate feature client only.
source§

const METADATA: Metadata = METADATA

Metadata about the endpoint.
source§

type EndpointError = Error

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

type IncomingResponse = Response

Response type returned when the request is successful.
source§

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. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

source§

const WITNESS: W = W::MAKE

A constant of the type witness
source§

impl<T> Identity for T
where T: ?Sized,

source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> OutgoingRequestAppserviceExt for T
where T: OutgoingRequest,

source§

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

Tries to convert this request into an http::Request and appends a virtual user_id to assert Appservice identity.
source§

impl<T> Same for T

source§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> ErasedDestructor for T
where T: 'static,

source§

impl<T> MaybeSendSync for T