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

pub struct Request {
    pub filter: Option<Filter>,
    pub since: Option<String>,
    pub full_state: Option<bool>,
    pub set_presence: Option<SetPresence>,
    pub timeout: Option<UInt>,
}

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

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.

full_state: Option<bool>

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

set_presence: Option<SetPresence>

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

timeout: Option<UInt>

The maximum time to poll in milliseconds before returning this 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

Formats the value using the given formatter.

impl Endpoint for Request

type Response = Response

Data returned in a successful response from the endpoint.

const METADATA: Metadata

Metadata for the #name endpoint.

impl Outgoing for Request

type Incoming = Self

The 'Incoming' variant of Self.

impl TryFrom<Request<Vec<u8>>> for Request

type Error = Error

The type returned in the event of a conversion error.

fn try_from(request: Request<Vec<u8>>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Request> for Request<Vec<u8>>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(request: Request) -> Result<Self, Self::Error>

Performs the conversion.