Struct ruma::api::client::sync::sync_events::v3::IncomingRequest
source · [−]pub struct IncomingRequest {
pub filter: Option<IncomingFilter>,
pub since: Option<String>,
pub full_state: bool,
pub set_presence: PresenceState,
pub timeout: Option<Duration>,
}
Available on (crate features
client-api-c
or client-api-s
) and (crate features client
or server
) and crate feature api
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
sourceimpl Debug for IncomingRequest
impl Debug for IncomingRequest
sourceimpl IncomingRequest for IncomingRequest
Available on crate feature server
only.
impl IncomingRequest for IncomingRequest
Available on crate feature
server
only.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.
sourcefn try_from_http_request<B, S>(
request: Request<B>,
path_args: &[S]
) -> Result<IncomingRequest, FromHttpRequestError>where
B: AsRef<[u8]>,
S: AsRef<str>,
fn try_from_http_request<B, S>(
request: Request<B>,
path_args: &[S]
) -> Result<IncomingRequest, FromHttpRequestError>where
B: AsRef<[u8]>,
S: AsRef<str>,
Tries to turn the given
http::Request
into this request type,
together with the corresponding path arguments. Read moreAuto Trait Implementations
impl RefUnwindSafe for IncomingRequest
impl Send for IncomingRequest
impl Sync for IncomingRequest
impl Unpin for IncomingRequest
impl UnwindSafe for IncomingRequest
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more