Struct Request 

#[non_exhaustive]
pub struct Request {
    pub filter: Option<Filter>,
    pub since: Option<String>,
    pub full_state: bool,
    pub set_presence: PresenceState,
    pub revised_presence: bool,
    pub timeout: Option<Duration>,
    pub use_state_after: bool,
}

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

filter: Option<Filter>

A filter represented either as its full JSON definition or the ID of a saved filter.

since: Option<String>

A point in time to continue a sync from.

Should be a token from the next_batch field of a previous /sync request.

full_state: bool

Controls whether to include the full state for all rooms the user is a member of.

set_presence: PresenceState

Controls whether the client is automatically marked as online by polling this API.

Defaults to PresenceState::Online.

revised_presence: bool

Available on crate feature unstable-msc4532 only.

Whether to use MSC4532’s revised presence states in responses (if the server supports them).

Defaults to false.

This uses the unstable prefix defined in MSC4532.

timeout: Option<Duration>

The maximum time to poll in milliseconds before returning this request.

use_state_after: bool

Controls whether to receive state changes between the previous sync and the start of the timeline, or between the previous sync and the end of the timeline.

Implementations

impl Request

pub fn new() -> Request

Creates an empty Request.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a duplicate 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 IncomingRequest for Request

Available on crate feature server only.

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_inner( request: Request<&[u8]>, path_args: &[&str], ) -> Result<Request, DeserializationError>

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

impl Metadata for Request

const METHOD: Method = ::ruma_common::exports::http::Method::GET

The HTTP method used by this endpoint.

const RATE_LIMITED: bool = false

Whether or not this endpoint is rate limited by the server.

const PATH_BUILDER: VersionHistory

All info pertaining to an endpoint’s path.

type Authentication = AccessToken

What authentication scheme the server uses for this endpoint.

type PathBuilder = VersionHistory

The type used to build an endpoint’s path.

fn make_endpoint_url( path_builder_input: <Self::PathBuilder as PathBuilder>::Input<'_>, base_url: &str, path_args: &[&dyn Display], query_string: &str, ) -> Result<String, IntoHttpError>

Generate the endpoint URL for this endpoint.

fn required_client_scopes() -> &'static [OAuthClientScope]

where Self::Authentication: ClientScopedAuthScheme,

The OAuth scopes which grant access to this endpoint.

impl OutgoingRequest for Request

Available on crate feature client only.

type Body = EmptyBody<ruma_client_api::::sync::sync_events::v3::__request_impls::{impl#0}::Body::{constant#0}>

HTTP body type pre-serialization.

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_inner( self, base_url: &str, path_builder_input: <<Request as Metadata>::PathBuilder as PathBuilder>::Input<'_>, ) -> Result<Request<<Request as OutgoingRequest>::Body>, IntoHttpError>

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