Struct ruma::api::client::r0::sync::sync_events::IncomingRequest [−][src]
pub struct IncomingRequest { pub filter: Option<IncomingFilter>, pub since: Option<String>, pub full_state: bool, pub set_presence: PresenceState, pub timeout: Option<Duration>, }
api
and (crate features client-api
or client-api-c
or client-api-s
) only.Expand description
‘Incoming’ variant of Request.
Fields
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
type EndpointError = Error
type EndpointError = Error
A type capturing the error conditions that can be returned in the response.
type OutgoingResponse = Response
type OutgoingResponse = Response
Response type to return when the request is successful.
pub fn try_from_http_request<T>(
request: Request<T>
) -> Result<IncomingRequest, FromHttpRequestError> where
T: AsRef<[u8]>,
pub fn try_from_http_request<T>(
request: Request<T>
) -> Result<IncomingRequest, FromHttpRequestError> where
T: AsRef<[u8]>,
Tries to turn the given http::Request
into this request type.
Auto Trait Implementations
impl RefUnwindSafe for IncomingRequest
impl Send for IncomingRequest
impl Sync for IncomingRequest
impl Unpin for IncomingRequest
impl UnwindSafe for IncomingRequest
Blanket Implementations
Mutably borrows from an owned value. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
type Output = T
type Output = T
Should always be Self
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more