[]Struct matrix_sdk_base::api::r0::keys::get_keys::Request

#[non_exhaustive]pub struct Request<'a> {
    pub timeout: Option<Duration>,
    pub device_keys: BTreeMap<UserId, Vec<Box<DeviceId, Global>, Global>>,
    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<UserId, Vec<Box<DeviceId, 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

impl<'_> Request<'_>

pub fn new() -> Request<'_>

Creates an empty Request.

Trait Implementations

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

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

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

impl<'a> Outgoing for Request<'a>

type Incoming = IncomingRequest

The 'Incoming' variant of Self.

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

type EndpointError = Error

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

type IncomingResponse = <Response as Outgoing>::Incoming

Response type returned when the request is successful.

pub const METADATA: Metadata

Metadata for the get_keys API endpoint.

Auto Trait Implementations

impl<'a> RefUnwindSafe for Request<'a>[src]

impl<'a> Send for Request<'a>[src]

impl<'a> Sync for Request<'a>[src]

impl<'a> Unpin for Request<'a>[src]

impl<'a> UnwindSafe for Request<'a>[src]

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> AsyncTraitDeps for T where
    T: Send + Sync + Debug
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Conv for T

impl<T> Conv for T

impl<T> FmtForward for T

impl<T> From<T> for T[src]

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Pipe for T where
    T: ?Sized

impl<T> Pipe for T

impl<T> PipeAsRef for T

impl<T> PipeBorrow for T

impl<T> PipeDeref for T

impl<T> PipeRef for T

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> Tap for T

impl<T> Tap for T

impl<T, U> TapAsRef<U> for T where
    U: ?Sized

impl<T, U> TapBorrow<U> for T where
    U: ?Sized

impl<T> TapDeref for T

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> TryConv for T

impl<T> TryConv for T

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,