Struct ruma_client_api::r0::keys::get_keys::Request [−][src]
pub struct Request<'a> { pub timeout: Option<Duration>, pub device_keys: BTreeMap<UserId, Vec<DeviceIdBox>>, pub token: Option<&'a str>, }
Expand description
Data for a request to the get_keys
API endpoint.
Returns the current devices and identity keys for the given users.
Fields
timeout: Option<Duration>
The time (in milliseconds) to wait when downloading keys from remote servers. 10 seconds is the recommended default.
device_keys: BTreeMap<UserId, Vec<DeviceIdBox>>
The keys to be downloaded. An empty list indicates all devices for the corresponding user.
token: Option<&'a str>
If the client is fetching keys as a result of a device update received in a sync request, this should be the ‘since’ token of that sync request, or any later sync token. This allows the server to ensure its response contains the keys advertised by the notification in that sync.
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.
fn try_into_http_request<T: Default + BufMut>(
self,
base_url: &str,
access_token: SendAccessToken<'_>
) -> Result<Request<T>, IntoHttpError>
fn try_into_http_request<T: Default + BufMut>(
self,
base_url: &str,
access_token: SendAccessToken<'_>
) -> Result<Request<T>, IntoHttpError>
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
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