Struct ruma::api::client::r0::sync::sync_events::Request [−][src]
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>, }
api
and (crate features client-api
or client-api-c
or client-api-s
) only.Expand description
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<&'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
Trait Implementations
type Incoming = IncomingRequest
type Incoming = IncomingRequest
The ‘Incoming’ variant of Self
.
type EndpointError = Error
type EndpointError = Error
A type capturing the expected error conditions the server can return.
type IncomingResponse = <Response as Outgoing>::Incoming
type IncomingResponse = <Response as Outgoing>::Incoming
Response type returned when the request is successful.
pub fn try_into_http_request<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>
) -> Result<Request<T>, IntoHttpError> where
T: Default + BufMut,
pub fn try_into_http_request<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>
) -> Result<Request<T>, IntoHttpError> where
T: Default + BufMut,
Tries to convert this request into an http::Request
. Read more
Auto Trait Implementations
impl<'a> RefUnwindSafe for Request<'a>
impl<'a> UnwindSafe for Request<'a>
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
fn try_into_http_request_with_user_id<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
user_id: UserId
) -> Result<Request<T>, IntoHttpError> where
T: Default + BufMut,
fn try_into_http_request_with_user_id<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
user_id: UserId
) -> Result<Request<T>, IntoHttpError> where
T: Default + BufMut,
Tries to convert this request into an http::Request
and appends a virtual user_id
to
assert Appservice identity. 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