Struct matrix_sdk_base::ruma::api::client::media::get_content_thumbnail::v3::Request
source · #[non_exhaustive]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>,
}
authenticated_media::get_content_thumbnail::v1::Request
instead if the homeserver supports it.api
and (crate features client
or server
) only.Expand description
Request type for the get_content_thumbnail
endpoint.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.server_name: OwnedServerName
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
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>
authenticated_media::get_content_thumbnail::v1::Request
instead if the homeserver supports it.The desired resizing method.
width: UInt
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
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
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
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
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>
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§
Trait Implementations§
source§impl OutgoingRequest for Request
Available on crate feature client
only.
impl OutgoingRequest for Request
client
only.§type EndpointError = Error
type EndpointError = Error
§type IncomingResponse = Response
type IncomingResponse = Response
source§fn try_into_http_request<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
considering_versions: &[MatrixVersion],
) -> Result<Request<T>, IntoHttpError>
fn try_into_http_request<T>( self, base_url: &str, access_token: SendAccessToken<'_>, considering_versions: &[MatrixVersion], ) -> Result<Request<T>, IntoHttpError>
http::Request
. Read moreAuto Trait Implementations§
impl Freeze for Request
impl RefUnwindSafe for Request
impl Send for Request
impl Sync for Request
impl Unpin for Request
impl UnwindSafe for Request
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<T> CompatExt for T
impl<T> CompatExt for T
source§impl<T, UT> HandleAlloc<UT> for T
impl<T, UT> HandleAlloc<UT> for T
source§fn consume_handle(handle: Handle) -> Arc<T>
fn consume_handle(handle: Handle) -> Arc<T>
Arc<>
source§impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
source§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moresource§impl<T> OutgoingRequestAppserviceExt for Twhere
T: OutgoingRequest,
impl<T> OutgoingRequestAppserviceExt for Twhere
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>
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>
http::Request
and appends a virtual user_id
to
assert Appservice identity.