Struct ruma_client_api::r0::sync::sync_events::Request

#[non_exhaustive]pub struct Request<'a> {
    pub filter: Option<&'a Filter<'a>>,
    pub since: Option<&'a str>,
    pub full_state: bool,
    pub set_presence: &'a PresenceState,
    pub timeout: Option<Duration>,
}

Data for a request to the sync API endpoint.

Get all new events from all rooms since the last sync or a given point of time.

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<&'a Filter<'a>>

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

since: Option<&'a str>

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: &'a PresenceState

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

Defaults to PresenceState::Online.

timeout: Option<Duration>

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

Implementations

impl Request<'_>

pub fn new() -> Self

Creates an empty Request.

Trait Implementations

impl<'a> Clone for Request<'a>

pub fn clone(&self) -> Request<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Request<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Request<'a>

pub fn default() -> Request<'a>

Returns the "default value" for a type.

impl<'a> Outgoing for Request<'a>

type Incoming = IncomingRequest

The 'Incoming' variant of Self.

impl<'a> OutgoingRequest for Request<'a>

type EndpointError = Error

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

type IncomingResponse = <Response as Outgoing>::Incoming

Response type returned when the request is successful.

pub const METADATA: Metadata

Metadata for the sync API endpoint.

pub fn try_into_http_request(
    self,
    base_url: &str,
    access_token: Option<&str>
) -> Result<Request<Vec<u8>>, IntoHttpError>

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