Struct ruma_client_api::authenticated_media::get_content::v1::Request

pub struct Request {
    pub server_name: OwnedServerName,
    pub media_id: String,
    pub timeout_ms: Duration,
}

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

timeout_ms: Duration

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.

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_uri(uri: &MxcUri) -> Result<Self, IdParseError>

Creates a new Request with the given URI.

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.