Struct Request
#[non_exhaustive]pub struct Request {
pub url: String,
pub ts: Option<MilliSecondsSinceUnixEpoch>,
}๐Deprecated: Since Matrix 1.11, clients should use
authenticated_media::get_media_preview::v1::Request instead if the homeserver supports it.Expand description
Request type for the get_media_preview 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.url: String๐Deprecated: Since Matrix 1.11, clients should use
authenticated_media::get_media_preview::v1::Request instead if the homeserver supports it.URL to get a preview of.
ts: Option<MilliSecondsSinceUnixEpoch>๐Deprecated: Since Matrix 1.11, clients should use
authenticated_media::get_media_preview::v1::Request instead if the homeserver supports it.Preferred point in time (in milliseconds) to return a preview for.
Implementationsยง
Trait Implementationsยง
ยงimpl IncomingRequest for Request
impl IncomingRequest for Request
ยงtype EndpointError = Error
type EndpointError = Error
A type capturing the error conditions that can be returned in the response.
ยงtype OutgoingResponse = 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>
fn try_from_http_request<B, S>( request: Request<B>, path_args: &[S], ) -> Result<Request, FromHttpRequestError>
Tries to turn the given
http::Request into this request type,
together with the corresponding path arguments. Read moreยงfn check_request_method(method: &Method) -> Result<(), FromHttpRequestError>
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
impl Metadata for Request
ยงconst METHOD: Method = ::ruma_common::exports::http::Method::GET
const METHOD: Method = ::ruma_common::exports::http::Method::GET
The HTTP method used by this endpoint.
ยงconst RATE_LIMITED: bool = true
const RATE_LIMITED: bool = true
Whether or not this endpoint is rate limited by the server.
ยงconst PATH_BUILDER: VersionHistory
const PATH_BUILDER: VersionHistory
All info pertaining to an endpointโs path.
ยงtype Authentication = AccessToken
type Authentication = AccessToken
What authentication scheme the server uses for this endpoint.
ยงtype PathBuilder = VersionHistory
type PathBuilder = VersionHistory
The type used to build an endpointโs path.
ยงfn empty_request_body<B>() -> B
fn empty_request_body<B>() -> B
Returns an empty request body for this Matrix request. Read more
ยง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>
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
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.
ยง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>
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>
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,
ยงimpl<T> CompatExt for T
impl<T> CompatExt for T
Sourceยงimpl<T, UT> HandleAlloc<UT> for T
impl<T, UT> HandleAlloc<UT> for T
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,
ยงimpl<T> Instrument for T
impl<T> Instrument for T
ยงfn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
ยงfn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Sourceยงimpl<T> IntoEither for T
impl<T> IntoEither for T
Sourceยงfn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSourceยงfn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreยงimpl<T> OutgoingRequestAppserviceExt for Twhere
T: OutgoingRequest,
<T as Metadata>::Authentication: for<'a> AuthScheme<Input<'a> = SendAccessToken<'a>>,
impl<T> OutgoingRequestAppserviceExt for Twhere
T: OutgoingRequest,
<T as Metadata>::Authentication: for<'a> AuthScheme<Input<'a> = SendAccessToken<'a>>,
ยงfn try_into_http_request_with_identity<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
identity: AppserviceUserIdentity<'_>,
path_builder_input: <Self::PathBuilder as PathBuilder>::Input<'_>,
) -> Result<Request<T>, IntoHttpError>
fn try_into_http_request_with_identity<T>( self, base_url: &str, access_token: SendAccessToken<'_>, identity: AppserviceUserIdentity<'_>, path_builder_input: <Self::PathBuilder as PathBuilder>::Input<'_>, ) -> Result<Request<T>, IntoHttpError>
Tries to convert this request into an
http::Request and adds the given
AppserviceUserIdentity to it, if the identity is not empty.