Struct Response

#[non_exhaustive]
pub struct Response {
    pub data: Option<Box<RawValue>>,
}

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

Response type for the get_media_preview 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.

data: Option<Box<RawValue>>

OpenGraph-like data for the URL.

Differences from OpenGraph: the image size in bytes is added to the matrix:image:size field, and og:image returns the MXC URI to the image, if any.

Implementations

impl Response

pub fn new() -> Response

Creates an empty Response.

pub fn from_raw_value(data: Box<RawValue>) -> Response

Creates a new Response with the given OpenGraph data (in a serde_json::value::RawValue).

pub fn from_serialize<T>(data: &T) -> Result<Response, Error>

where T: Serialize,

Creates a new Response with the given OpenGraph data (in any kind of serializable object).

Trait Implementations

impl Clone for Response

fn clone(&self) -> Response

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Response

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Response

fn default() -> Response

Returns the “default value” for a type.

impl IncomingResponse for Response

Available on crate feature client only.

type EndpointError = Error

A type capturing the expected error conditions the server can return.

fn try_from_http_response<T>( response: Response<T>, ) -> Result<Response, FromHttpResponseError<Error>>

where T: AsRef<[u8]>,

Tries to convert the given http::Response into this response type.