Struct ruma_client_api::keys::get_keys::v3::Request

#[non_exhaustive]
pub struct Request<'a> {
    pub timeout: Option<Duration>,
    pub device_keys: BTreeMap<OwnedUserId, Vec<OwnedDeviceId>>,
    pub token: Option<&'a str>,
}

Data for a request to the get_keys API endpoint.

Returns the current devices and identity keys for the given users.

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.

device_keys: BTreeMap<OwnedUserId, Vec<OwnedDeviceId>>

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

impl Request<'_>

pub fn new() -> Self

Creates an empty Request.

Trait Implementations

impl<'a> Clone for Request<'a>

fn clone(&self) -> Request<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Request<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Request<'a>

fn default() -> Request<'a>

Returns the “default value” for a type.

impl<'a> OutgoingRequest for Request<'a>

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.