pub struct Request<'a> {
pub pos: Option<&'a str>,
pub txn_id: Option<&'a str>,
pub timeout: Option<Duration>,
pub lists: &'a [SyncRequestList],
pub room_subscriptions: BTreeMap<OwnedRoomId, RoomSubscription, Global>,
pub unsubscribe_rooms: &'a [OwnedRoomId],
pub extensions: ExtensionsConfig,
}
Available on (crate features
client-api-c
or client-api-s
) and (crate features client
or server
) and crate feature api
and crate feature unstable-msc3575
only.Expand description
Data for a request to the sync
API endpoint.
Get all new events in a sliding window of rooms since the last sync or a given point of time.
Fields
pos: Option<&'a str>
A point in time to continue a sync from.
Should be a token from the pos
field of a previous /sync
response.
txn_id: Option<&'a str>
Allows clients to know what request params reached the server, functionally similar to txn IDs on /send for events.
timeout: Option<Duration>
The maximum time to poll before responding to this request.
lists: &'a [SyncRequestList]
The lists of rooms we’re interested in.
room_subscriptions: BTreeMap<OwnedRoomId, RoomSubscription, Global>
Specific rooms and event types that we want to receive events from.
unsubscribe_rooms: &'a [OwnedRoomId]
Specific rooms we no longer want to receive events from.
extensions: ExtensionsConfig
Extensions API.
Implementations
Trait Implementations
sourceimpl<'a> OutgoingRequest for Request<'a>
Available on crate feature client
only.
impl<'a> OutgoingRequest for Request<'a>
Available on crate feature
client
only.type EndpointError = Error
type EndpointError = Error
A type capturing the expected error conditions the server can return.
type IncomingResponse = Response
type IncomingResponse = Response
Response type returned when the request is successful.
sourcefn try_into_http_request<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
considering_versions: &[MatrixVersion]
) -> Result<Request<T>, IntoHttpError>where
T: Default + BufMut,
fn try_into_http_request<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
considering_versions: &[MatrixVersion]
) -> Result<Request<T>, IntoHttpError>where
T: Default + BufMut,
Tries to convert this request into an
http::Request
. Read moreAuto Trait Implementations
impl<'a> RefUnwindSafe for Request<'a>
impl<'a> Send for Request<'a>
impl<'a> Sync for Request<'a>
impl<'a> Unpin for Request<'a>
impl<'a> UnwindSafe for Request<'a>
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
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> OutgoingRequestAppserviceExt for Twhere
T: OutgoingRequest,
impl<T> OutgoingRequestAppserviceExt for Twhere
T: OutgoingRequest,
sourcefn 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>where
T: Default + BufMut,
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>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