logo
pub struct Request<'a> {
    pub timeout: Option<Duration>,
    pub device_keys: BTreeMap<OwnedUserId, Vec<OwnedDeviceId, Global>, Global>,
    pub token: Option<&'a str>,
}
Available on (crate features client-api-c or client-api-s) and (crate features client or server) and crate feature api only.
Expand description

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

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

Creates an empty Request.

Trait Implementations

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Returns the “default value” for a type. Read more
A type capturing the expected error conditions the server can return.
Response type returned when the request is successful.
Metadata about the endpoint.
Tries to convert this request into an http::Request. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Tries to convert this request into an http::Request and appends a virtual user_id to assert Appservice identity. Read more
Should always be Self
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more