Struct Response

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

Available on crate feature api and (crate features client-api-c or client-api-s) only.

Response type for the get_state_events_for_key endpoint, either the Raw AnyStateEvent or AnyStateEventContent.

While it’s possible to access the raw value directly, it’s recommended you use the provided helper methods to access it, and From to create it.

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.

event_or_content: Box<RawValue>

The full event (content) of the state event.

Implementations

impl Response

pub fn new(event_or_content: Box<RawValue>) -> Response

Creates a new Response with the given event (content).

pub fn into_event(self) -> Raw<AnyStateEvent>

Returns an unchecked Raw<AnyStateEvent>.

This method should only be used if you specified the format in the request to be StateEventFormat::Event

pub fn into_content(self) -> Raw<AnyStateEventContent>

Returns an unchecked Raw<AnyStateEventContent>.

This method should only be used if you did not specify the format in the request, or set it to be StateEventFormat::Content

Since the inner type of the Raw does not implement Deserialize, you need to use .deserialize_as_unchecked::<T>() or .cast_ref_unchecked::<T>().deserialize_with_type() to deserialize it.

Trait Implementations

impl Clone for Response

fn clone(&self) -> Response

Returns a duplicate 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 From<Raw<AnyStateEvent>> for Response

fn from(value: Raw<AnyStateEvent>) -> Response

Converts to this type from the input type.

impl From<Raw<AnyStateEventContent>> for Response

fn from(value: Raw<AnyStateEventContent>) -> Response

Converts to this type from the input type.

impl IncomingResponse for Response

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.

impl OutgoingResponse for Response

fn try_into_http_response<T>(self) -> Result<Response<T>, IntoHttpError>

where T: Default + BufMut,

Tries to convert this response into an http::Response.