Struct Response

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

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

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

room_version: Option<RoomVersionId>

The version of the room where the server is trying to leave.

If not provided, the room version is assumed to be either “1” or “2”.

event: Box<RawValue>

An unsigned template event.

Note that events have a different format depending on the room version - check the room version specification for precise event formats.

Implementations

impl Response

pub fn new( room_version: Option<RoomVersionId>, event: Box<RawValue>, ) -> Response

Creates a new Response with:

• the version of the room where the server is trying to leave.
• an unsigned template event.

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 IncomingResponse for Response

Available on crate feature client only.

type EndpointError = MatrixError

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

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

where T: AsRef<[u8]>,

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

impl OutgoingResponse for Response

Available on crate feature server only.

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

where T: Default + BufMut,

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