Struct Response

#[non_exhaustive]
pub struct Response {
    pub txn_id: Option<String>,
    pub pos: String,
    pub lists: BTreeMap<String, List>,
    pub rooms: BTreeMap<OwnedRoomId, Room>,
    pub extensions: Extensions,
}

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

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

txn_id: Option<String>

Matches the txn_id sent by the request (see Request::txn_id).

pos: String

The token to supply in the pos parameter of the next /sync request (see Request::pos).

lists: BTreeMap<String, List>

Resulting details of the lists.

rooms: BTreeMap<OwnedRoomId, Room>

The updated rooms.

extensions: Extensions

Extensions.

Implementations

impl Response

pub fn new(pos: String) -> Response

Creates a new Response with the given pos.

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

fn from(value: Response) -> Response

Converts to this type from the input 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.

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.