Struct Response

#[non_exhaustive]
pub struct Response {
    pub initial: bool,
    pub txn_id: Option<String>,
    pub pos: String,
    pub lists: BTreeMap<String, SyncList>,
    pub rooms: BTreeMap<OwnedRoomId, SlidingSyncRoom>,
    pub extensions: Extensions,
    pub delta_token: Option<String>,
}

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, SyncList>

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

rooms: BTreeMap<OwnedRoomId, SlidingSyncRoom>

The updates on rooms.

extensions: Extensions

Extensions API.

delta_token: Option<String>

The delta token to store for session recovery.

The delta token is a future bandwidth optimisation to resume from an earlier session. If you received a delta token in your last response you can persist and it when establishing a new sessions to “resume” from the last state and not resend information you had stored. If you send a delta token, the server expects you to have stored the last state, if there is no delta token present the server will resend all information necessary to calculate the state.

Please consult “Bandwidth optimisations for persistent clients” of the MSC for further details, expectations of the implementation and limitations to consider before implementing this.

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

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.