Struct ruma_client_api::keys::claim_keys::v3::Request

#[non_exhaustive]
pub struct Request {
    pub timeout: Option<Duration>,
    pub one_time_keys: BTreeMap<OwnedUserId, BTreeMap<OwnedDeviceId, DeviceKeyAlgorithm>>,
}

Data for a request to the claim_keys API endpoint.

Claims one-time keys for use in pre-key messages.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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<OwnedUserId, BTreeMap<OwnedDeviceId, DeviceKeyAlgorithm>>

The keys to be claimed.

Implementations

impl Request

pub fn new(
    one_time_keys: BTreeMap<OwnedUserId, BTreeMap<OwnedDeviceId, DeviceKeyAlgorithm>>
) -> Self

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

Trait Implementations

impl Clone for Request

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

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

Formats the value using the given formatter.

impl OutgoingRequest for Request

type EndpointError = Error

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

type IncomingResponse = Response

Response type returned when the request is successful.

const METADATA: Metadata = self::METADATA

Metadata about the endpoint.

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

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