Struct Response

#[non_exhaustive]
pub struct Response {
    pub next_batch: String,
    pub rooms: Rooms,
    pub presence: Presence,
    pub account_data: GlobalAccountData,
    pub to_device: ToDevice,
    pub device_lists: DeviceLists,
    pub device_one_time_keys_count: BTreeMap<OneTimeKeyAlgorithm, UInt>,
    pub device_unused_fallback_key_types: Option<Vec<OneTimeKeyAlgorithm>>,
}

Available on (crate features client-api-c or client-api-s) and (crate features client or server) and crate feature api 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.

next_batch: String

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

rooms: Rooms

Updates to rooms.

presence: Presence

Updates to the presence status of other users.

account_data: GlobalAccountData

The global private data created by this user.

to_device: ToDevice

Messages sent directly between devices.

device_lists: DeviceLists

Information on E2E device updates.

Only present on an incremental sync.

device_one_time_keys_count: BTreeMap<OneTimeKeyAlgorithm, UInt>

For each key algorithm, the number of unclaimed one-time keys currently held on the server for a device.

device_unused_fallback_key_types: Option<Vec<OneTimeKeyAlgorithm>>

The unused fallback key algorithms.

The presence of this field indicates that the server supports fallback keys.

Implementations

impl Response

pub fn new(next_batch: String) -> Response

Creates a new Response with the given batch token.

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 = 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.