Struct Request

#[non_exhaustive]
pub struct Request {
    pub pos: Option<String>,
    pub delta_token: Option<String>,
    pub conn_id: Option<String>,
    pub txn_id: Option<String>,
    pub timeout: Option<Duration>,
    pub lists: BTreeMap<String, SyncRequestList>,
    pub room_subscriptions: BTreeMap<OwnedRoomId, RoomSubscription>,
    pub unsubscribe_rooms: Vec<OwnedRoomId>,
    pub extensions: ExtensionsConfig,
}

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-msc3575 only.

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

pos: Option<String>

A point in time to continue a sync from.

Should be a token from the pos field of a previous /sync response.

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.

conn_id: Option<String>

A unique string identifier for this connection to the server.

Optional. If this is missing, only one sliding sync connection can be made to the server at any one time. Clients need to set this to allow more than one connection concurrently, so the server can distinguish between connections. This is NOT STICKY and must be provided with every request, if your client needs more than one concurrent connection.

Limitation: it must not contain more than 16 chars, due to it being required with every request.

txn_id: Option<String>

Allows clients to know what request params reached the server, functionally similar to txn IDs on /send for events.

timeout: Option<Duration>

The maximum time to poll before responding to this request.

lists: BTreeMap<String, SyncRequestList>

The list configurations of rooms we are interested in mapped by name.

room_subscriptions: BTreeMap<OwnedRoomId, RoomSubscription>

Specific rooms and event types that we want to receive events from.

unsubscribe_rooms: Vec<OwnedRoomId>

Specific rooms we no longer want to receive events from.

extensions: ExtensionsConfig

Extensions API.

Implementations

impl Request

pub fn new() -> Request

Creates an empty Request.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Request

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Request

fn default() -> Request

Returns the “default value” for a type.

impl From<Request> for Request

Available on crate feature unstable-msc4186 only.

fn from(value: Request) -> Request

Converts to this type from the input type.

impl IncomingRequest for Request

Available on crate feature server only.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

type EndpointError = Error

A type capturing the error conditions that can be returned in the response.

type OutgoingResponse = Response

Response type to return when the request is successful.

fn try_from_http_request<B, S>( request: Request<B>, path_args: &[S], ) -> Result<Request, FromHttpRequestError>

where B: AsRef<[u8]>, S: AsRef<str>,

Tries to turn the given http::Request into this request type, together with the corresponding path arguments.

impl OutgoingRequest for Request

Available on crate feature client only.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

type EndpointError = Error

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

type IncomingResponse = Response

Response type returned when the request is successful.

fn try_into_http_request<T>( self, base_url: &str, access_token: SendAccessToken<'_>, considering_versions: &[MatrixVersion], ) -> Result<Request<T>, IntoHttpError>

where T: Default + BufMut,

Tries to convert this request into an http::Request.