#[non_exhaustive]pub struct Request {
pub conn_id: Option<String>,
pub pos: Option<String>,
pub timeout: Option<Duration>,
pub set_presence: PresenceState,
pub lists: BTreeMap<String, List>,
pub room_subscriptions: BTreeMap<OwnedRoomId, RoomSubscription>,
pub extensions: Extensions,
}unstable-msc4186 and (crate features client or server) only.Expand description
Request type for the /sync endpoint.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.conn_id: Option<String>A unique string identifier for this connection to the server.
Only one connection is allowed per given conn_id, empty or not.
pos: Option<String>A point in time to continue a sync from.
This is the pos from the previous response. None starts a new connection.
timeout: Option<Duration>The maximum time to poll before responding to this request.
None or zero means the server responds immediately. Ignored when Self::pos is
None.
set_presence: PresenceStateControls whether the client is automatically marked as online by polling this API.
Defaults to PresenceState::Online.
lists: BTreeMap<String, List>Lists of rooms we are interested in, keyed by an opaque identifier.
The server rejects requests with more than 100 lists.
room_subscriptions: BTreeMap<OwnedRoomId, RoomSubscription>Specific rooms we are interested in.
It is useful to receive updates from rooms that are possibly out of range of all the
lists (see Self::lists).
The server rejects requests with more than 100 room subscriptions.
extensions: ExtensionsExtensions configuration.
Implementations§
Trait Implementations§
Source§impl IncomingRequest for Request
Available on crate feature server only.
impl IncomingRequest for Request
server only.Source§type EndpointError = Error
type EndpointError = Error
Source§type OutgoingResponse = Response
type OutgoingResponse = Response
Source§fn try_from_http_request_inner(
request: Request<&[u8]>,
path_args: &[&str],
) -> Result<Self, DeserializationError>
fn try_from_http_request_inner( request: Request<&[u8]>, path_args: &[&str], ) -> Result<Self, DeserializationError>
http::Request into this request type,
together with the corresponding path arguments. Read moreSource§impl Metadata for Request
impl Metadata for Request
Source§const METHOD: Method = ::ruma_common::exports::http::Method::POST
const METHOD: Method = ::ruma_common::exports::http::Method::POST
Source§const RATE_LIMITED: bool = false
const RATE_LIMITED: bool = false
Source§const PATH_BUILDER: VersionHistory
const PATH_BUILDER: VersionHistory
Source§type Authentication = AccessToken
type Authentication = AccessToken
Source§type PathBuilder = VersionHistory
type PathBuilder = VersionHistory
Source§fn make_endpoint_url(
path_builder_input: <Self::PathBuilder as PathBuilder>::Input<'_>,
base_url: &str,
path_args: &[&dyn Display],
query_string: &str,
) -> Result<String, IntoHttpError>
fn make_endpoint_url( path_builder_input: <Self::PathBuilder as PathBuilder>::Input<'_>, base_url: &str, path_args: &[&dyn Display], query_string: &str, ) -> Result<String, IntoHttpError>
Source§fn required_client_scopes() -> &'static [OAuthClientScope]where
Self::Authentication: ClientScopedAuthScheme,
fn required_client_scopes() -> &'static [OAuthClientScope]where
Self::Authentication: ClientScopedAuthScheme,
Source§impl OutgoingRequest for Request
Available on crate feature client only.
impl OutgoingRequest for Request
client only.Source§type EndpointError = Error
type EndpointError = Error
Source§type IncomingResponse = Response
type IncomingResponse = Response
Source§fn try_into_http_request_inner(
self,
base_url: &str,
path_builder_input: <<Self as Metadata>::PathBuilder as PathBuilder>::Input<'_>,
) -> Result<Request<Self::Body>, IntoHttpError>
fn try_into_http_request_inner( self, base_url: &str, path_builder_input: <<Self as Metadata>::PathBuilder as PathBuilder>::Input<'_>, ) -> Result<Request<Self::Body>, IntoHttpError>
http::Request. Read moreAuto Trait Implementations§
impl Forget for Request
impl Freeze for Request
impl Move for Request
impl RefUnwindSafe for Request
impl Send for Request
impl Sync for Request
impl Unpin for Request
impl UnsafeUnpin 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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> DropFlavorWrapper<T> for T
impl<T> DropFlavorWrapper<T> for T
Source§impl<T, UT> HandleAlloc<UT> for T
impl<T, UT> HandleAlloc<UT> for T
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> IncomingRequestExt for Twhere
T: IncomingRequest,
impl<T> IncomingRequestExt for Twhere
T: IncomingRequest,
Source§fn try_from_http_request(
request: Request<&[u8]>,
path_args: &[&str],
) -> Result<Self, FromHttpRequestError>
fn try_from_http_request( request: Request<&[u8]>, path_args: &[&str], ) -> Result<Self, FromHttpRequestError>
http::Request into this request type.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> ⓘ
impl<T> JsonCastable<CanonicalJsonValue> for T
impl<T> JsonCastable<Value> for T
Source§impl<T> OutgoingRequestAppserviceExt for Twhere
T: OutgoingRequest,
<T as Metadata>::Authentication: for<'a> AuthScheme<Input<'a> = SendAccessToken<'a>>,
impl<T> OutgoingRequestAppserviceExt for Twhere
T: OutgoingRequest,
<T as Metadata>::Authentication: for<'a> AuthScheme<Input<'a> = SendAccessToken<'a>>,
Source§fn try_into_http_request_with_identity<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
identity: AppserviceUserIdentity<'_>,
path_builder_input: <Self::PathBuilder as PathBuilder>::Input<'_>,
) -> Result<Request<T>, IntoHttpError>
fn try_into_http_request_with_identity<T>( self, base_url: &str, access_token: SendAccessToken<'_>, identity: AppserviceUserIdentity<'_>, path_builder_input: <Self::PathBuilder as PathBuilder>::Input<'_>, ) -> Result<Request<T>, IntoHttpError>
http::Request and adds the given
AppserviceUserIdentity to it, if the identity is not empty.Source§impl<T> OutgoingRequestExt for Twhere
T: OutgoingRequest,
impl<T> OutgoingRequestExt for Twhere
T: OutgoingRequest,
Source§fn try_into_http_request<T>(
self,
base_url: &str,
authentication_input: <Self::Authentication as AuthScheme>::Input<'_>,
path_builder_input: <Self::PathBuilder as PathBuilder>::Input<'_>,
) -> Result<Request<T>, IntoHttpError>
fn try_into_http_request<T>( self, base_url: &str, authentication_input: <Self::Authentication as AuthScheme>::Input<'_>, path_builder_input: <Self::PathBuilder as PathBuilder>::Input<'_>, ) -> Result<Request<T>, IntoHttpError>
http::Request. Read more