Struct Request

#[non_exhaustive]
pub struct Request {
    pub server_name: OwnedServerName,
    pub media_id: String,
    pub filename: 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_as_filename::v1::Request instead if the homeserver supports it.

Available on crate features client or server only.

Request type for the get_media_content_as_filename 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_as_filename::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_as_filename::v1::Request instead if the homeserver supports it.

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

filename: String

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

The filename to return in the Content-Disposition header.

allow_remote: bool

👎Deprecated: Since Matrix 1.11, clients should use authenticated_media::get_content_as_filename::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_as_filename::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_as_filename::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, filename: String, ) -> Self

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

pub fn from_url(url: &MxcUri, filename: String) -> Result<Self, IdParseError>

Creates a new Request with the given url and filename.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a copy 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

Formats the value using the given formatter.

impl IncomingRequest for Request

Available on crate feature server only.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

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<Self, 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.

impl OutgoingRequest for Request

Available on crate feature client only.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

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: 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.