[−][src]Struct ruma_client_api::r0::sync::sync_events::IncomingRequest

#[non_exhaustive]pub struct IncomingRequest {
    pub filter: Option<IncomingFilter>,
    pub since: Option<String>,
    pub full_state: bool,
    pub set_presence: PresenceState,
    pub timeout: Option<Duration>,
}

'Incoming' variant of Request.

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<IncomingFilter>

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.

timeout: Option<Duration>

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

Trait Implementations

impl Debug for IncomingRequest[src]

impl IncomingRequest for IncomingRequest[src]

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.

pub const METADATA: Metadata[src]

Metadata for the sync API endpoint.

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.