Struct ruma_client_api::media::get_content::v3::Request

pub struct Request {
    pub server_name: OwnedServerName,
    pub media_id: String,
    pub allow_remote: bool,
    pub max_stall_ms: Option<UInt>,
}

Available on crate features client or server only.

Request type for the get_media_content endpoint.

Fields

server_name: OwnedServerName

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

media_id: String

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

allow_remote: bool

Whether to fetch media deemed remote.

Used to prevent routing loops. Defaults to true.

max_stall_ms: Option<UInt>

Available on crate feature unstable-msc2246 only.

How long to wait for the media to be uploaded

This uses the unstable prefix in MSC2246

Implementations

impl Request

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

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

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

Creates a new Request with the given url.

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.

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.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

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.

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.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

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.