Struct ruma_client_api::sync::sync_events::v5::Response

#[non_exhaustive]
pub struct Response {
    pub initial: bool,
    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 or server) and crate feature unstable-simplified-msc3575 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.

initial: bool

Whether this response describes an initial sync (i.e. after the pos token has been discard by the server?).

txn_id: Option<String>

Matches the txn_id sent by the request. Please see Request::txn_id.

pos: String

The token to supply in the pos param of the next /sync request.

lists: BTreeMap<String, List>

Updates on the order of rooms, mapped by the names we asked for.

rooms: BTreeMap<OwnedRoomId, Room>

The updates on rooms.

extensions: Extensions

Extensions API.

Implementations

impl Response

pub fn new(pos: String) -> Self

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

Formats the value using the given formatter.

impl From<Response> for Response

fn from(value: Response) -> Self

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: AsRef<[u8]>>( response: Response<T>, ) -> Result<Self, FromHttpResponseError<Error>>

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