Struct ruma_client_api::media::get_content::v3::Request
source · #[non_exhaustive]pub struct Request {
pub server_name: OwnedServerName,
pub media_id: String,
pub allow_remote: bool,
pub timeout_ms: Duration,
pub allow_redirect: bool,
}
👎Deprecated: Since Matrix 1.11, clients should use
authenticated_media::get_content::v1::Request
instead if the homeserver supports it.Expand description
Request type for the get_media_content
endpoint.
Fields (Non-exhaustive)§
This struct is marked as 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
👎Deprecated: Since Matrix 1.11, clients should use
authenticated_media::get_content::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::v1::Request
instead if the homeserver supports it.The media ID from the mxc:// URI (the path component).
allow_remote: bool
👎Deprecated: Since Matrix 1.11, clients should use
authenticated_media::get_content::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::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::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.
Implementations§
Trait Implementations§
source§impl OutgoingRequest for Request
impl OutgoingRequest for Request
§type EndpointError = Error
type EndpointError = Error
A type capturing the expected error conditions the server can return.
§type IncomingResponse = Response
type IncomingResponse = Response
Response type returned when the request is successful.
source§fn try_into_http_request<T: Default + BufMut>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
considering_versions: &[MatrixVersion],
) -> Result<Request<T>, IntoHttpError>
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
. 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
Mutably borrows from an owned value. Read more
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)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)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,
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§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>
Tries to convert this request into an
http::Request
and appends a virtual user_id
to
assert Appservice identity.