Struct ruma_client_api::keys::get_keys::v3::IncomingRequest

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

Available on crate features client or server only.

‘Incoming’ variant of Request.

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.

Trait Implementations

impl Debug for IncomingRequest

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

Formats the value using the given formatter.

impl IncomingRequest for IncomingRequest

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