Struct ruma_client_api::r0::keys::claim_keys::Request [−][src]
pub struct Request { pub timeout: Option<Duration>, pub one_time_keys: BTreeMap<UserId, BTreeMap<DeviceIdBox, DeviceKeyAlgorithm>>, }
Expand description
Data for a request to the claim_keys
API endpoint.
Claims one-time keys for use in pre-key messages.
Fields
timeout: Option<Duration>
The time (in milliseconds) to wait when downloading keys from remote servers. 10 seconds is the recommended default.
one_time_keys: BTreeMap<UserId, BTreeMap<DeviceIdBox, DeviceKeyAlgorithm>>
The keys to be claimed.
Implementations
pub fn new(
one_time_keys: BTreeMap<UserId, BTreeMap<DeviceIdBox, DeviceKeyAlgorithm>>
) -> Self
pub fn new(
one_time_keys: BTreeMap<UserId, BTreeMap<DeviceIdBox, DeviceKeyAlgorithm>>
) -> Self
Creates a new Request
with the given key claims and the recommended 10 second timeout.
Trait Implementations
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.
fn try_from_http_request<T: AsRef<[u8]>>(
request: Request<T>
) -> Result<Self, FromHttpRequestError>
fn try_from_http_request<T: AsRef<[u8]>>(
request: Request<T>
) -> Result<Self, FromHttpRequestError>
Tries to turn the given http::Request
into this request type.
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 RefUnwindSafe for Request
impl UnwindSafe for Request
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