pub struct Request {
pub filter: Option<Filter>,
pub since: Option<String>,
pub full_state: bool,
pub set_presence: PresenceState,
pub timeout: Option<Duration>,
}
Available on crate features
client
or server
only.Expand description
Request type for the sync
endpoint.
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.
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.
Implementations§
Trait Implementations§
Source§impl IncomingRequest for Request
Available on crate feature server
only.
impl IncomingRequest for Request
Available on crate feature
server
only.Source§type EndpointError = Error
type EndpointError = Error
A type capturing the error conditions that can be returned in the response.
Source§type OutgoingResponse = Response
type OutgoingResponse = Response
Response type to return when the request is successful.
Source§impl OutgoingRequest for Request
Available on crate feature client
only.
impl OutgoingRequest for Request
Available on crate feature
client
only.Source§type EndpointError = Error
type EndpointError = Error
A type capturing the expected error conditions the server can return.
Source§type IncomingResponse = Response
type IncomingResponse = Response
Response type returned when the request is successful.
Source§fn try_into_http_request<T: Default + BufMut>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
considering_versions: &[MatrixVersion],
) -> Result<Request<T>, IntoHttpError>
fn try_into_http_request<T: Default + BufMut>( self, base_url: &str, access_token: SendAccessToken<'_>, considering_versions: &[MatrixVersion], ) -> Result<Request<T>, IntoHttpError>
Tries to convert this request into an
http::Request
. Read moreAuto Trait Implementations§
impl Freeze for Request
impl RefUnwindSafe for Request
impl Send for Request
impl Sync for Request
impl Unpin for Request
impl UnwindSafe for Request
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
Source§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> OutgoingRequestAppserviceExt for Twhere
T: OutgoingRequest,
impl<T> OutgoingRequestAppserviceExt for Twhere
T: OutgoingRequest,
Source§fn try_into_http_request_with_user_id<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
user_id: &UserId,
considering_versions: &[MatrixVersion],
) -> Result<Request<T>, IntoHttpError>
fn try_into_http_request_with_user_id<T>( self, base_url: &str, access_token: SendAccessToken<'_>, user_id: &UserId, considering_versions: &[MatrixVersion], ) -> Result<Request<T>, IntoHttpError>
Tries to convert this request into an
http::Request
and appends a virtual user_id
to
assert Appservice identity.