Struct ruma::api::client::r0::keys::claim_keys::Request

pub struct Request {
    pub timeout: Option<Duration>,
    pub one_time_keys: BTreeMap<UserId, BTreeMap<Box<DeviceId, Global>, DeviceKeyAlgorithm>>,
}

This is supported on crate feature api and (crate features client-api or client-api-c or client-api-s) only.

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<Box<DeviceId, Global>, DeviceKeyAlgorithm>>

The keys to be claimed.

Implementations

impl Request

pub fn new(
    one_time_keys: BTreeMap<UserId, BTreeMap<Box<DeviceId, Global>, DeviceKeyAlgorithm>>
) -> Request

Creates a new Request with the given key claims and the recommended 10 second timeout.

Trait Implementations

impl Clone for Request

pub fn clone(&self) -> Request

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Request

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl IncomingRequest for Request

type EndpointError = Error

A type capturing the error conditions that can be returned in the response.

type OutgoingResponse = Response

Response type to return when the request is successful.

pub const METADATA: Metadata

Metadata about the endpoint.

pub fn try_from_http_request<T>(
    request: Request<T>
) -> Result<Request, FromHttpRequestError> where
    T: AsRef<[u8]>, 

Tries to turn the given http::Request into this request type.

impl Outgoing for Request

type Incoming = Request

The ‘Incoming’ variant of Self.

impl OutgoingRequest for Request

type EndpointError = Error

A type capturing the expected error conditions the server can return.

type IncomingResponse = <Response as Outgoing>::Incoming

Response type returned when the request is successful.

pub const METADATA: Metadata

Metadata about the endpoint.

pub fn try_into_http_request<T>(
    self,
    base_url: &str,
    access_token: SendAccessToken<'_>
) -> Result<Request<T>, IntoHttpError> where
    T: Default + BufMut, 

Tries to convert this request into an http::Request.