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

pub struct Request {
    pub timeout: Option<Duration>,
    pub device_keys: BTreeMap<OwnedUserId, Vec<OwnedDeviceId>>,
    pub token: Option<String>,
}

Available on crate features client or server only.

Request type for the get_keys endpoint.

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<OwnedUserId, Vec<OwnedDeviceId>>

The keys to be downloaded.

An empty list indicates all devices for the corresponding user.

token: Option<String>

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 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 Default for Request

fn default() -> Request

Returns the “default value” for a type.

impl IncomingRequest for Request

Available on crate feature server only.

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.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

fn try_from_http_request<B, S>(
    request: Request<B>,
    path_args: &[S]
) -> Result<Self, FromHttpRequestError>where
    B: AsRef<[u8]>,
    S: AsRef<str>,

Tries to turn the given http::Request into this request type, together with the corresponding path arguments.

impl OutgoingRequest for Request

Available on crate feature client only.

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 = 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.