Struct ruma_client_api::r0::keys::get_keys::Request

pub struct Request {
    pub timeout: Option<Duration>,
    pub device_keys: HashMap<UserId, Vec<DeviceId>>,
    pub token: Option<String>,
}

Data for a request to the get_keys API endpoint.

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

Fields

timeout: Option<Duration>

The time (in milliseconds) to wait when downloading keys from remote servers. 10 seconds is the recommended default.

device_keys: HashMap<UserId, Vec<DeviceId>>

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.

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

type Response = Response

Data returned in a successful response from the endpoint.

type ResponseError = Error

Error type returned when response from endpoint fails.

const METADATA: Metadata

Metadata for the #name endpoint.

impl Outgoing for Request

type Incoming = Self

The 'Incoming' variant of Self.

impl TryFrom<Request<Vec<u8>>> for Request

type Error = FromHttpRequestError

The type returned in the event of a conversion error.

fn try_from(request: Request<Vec<u8>>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Request> for Request<Vec<u8>>

type Error = IntoHttpError

The type returned in the event of a conversion error.

fn try_from(request: Request) -> Result<Self, Self::Error>

Performs the conversion.