Struct Request 

#[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.

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

Request type for the get_media_content endpoint.

Fields (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

impl Request

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

Creates a new Request with the given media ID and server name.

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

Creates a new Request with the given url.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a duplicate 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<(), Error>

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.

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.

fn check_request_method(method: &Method) -> Result<(), FromHttpRequestError>

Check whether the given HTTP method from an incoming request is compatible with the expected METHOD of this endpoint.

impl Metadata for Request

const METHOD: Method = ::ruma_common::exports::http::Method::GET

The HTTP method used by this endpoint.

const RATE_LIMITED: bool = false

Whether or not this endpoint is rate limited by the server.

const PATH_BUILDER: VersionHistory

All info pertaining to an endpoint’s path.

type Authentication = NoAccessToken

What authentication scheme the server uses for this endpoint.

type PathBuilder = VersionHistory

The type used to build an endpoint’s path.

fn empty_request_body<B>() -> B

where B: Default + BufMut,

Returns an empty request body for this Matrix request.

fn make_endpoint_url( path_builder_input: <Self::PathBuilder as PathBuilder>::Input<'_>, base_url: &str, path_args: &[&dyn Display], query_string: &str, ) -> Result<String, IntoHttpError>

Generate the endpoint URL for this endpoint.

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.

fn try_into_http_request<T>( self, base_url: &str, authentication_input: <<Request as Metadata>::Authentication as AuthScheme>::Input<'_>, path_builder_input: <<Request as Metadata>::PathBuilder as PathBuilder>::Input<'_>, ) -> Result<Request<T>, IntoHttpError>

where T: Default + BufMut + AsRef<[u8]>,

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