Struct Request

#[non_exhaustive]
pub struct Request {
    pub device_id: OwnedDeviceId,
    pub initial_device_display_name: Option<String>,
    pub device_data: Raw<DehydratedDeviceData>,
    pub device_keys: Raw<DeviceKeys>,
    pub one_time_keys: BTreeMap<OwnedOneTimeKeyId, Raw<OneTimeKey>>,
    pub fallback_keys: BTreeMap<OwnedOneTimeKeyId, Raw<OneTimeKey>>,
}

Available on (crate features client or server) and crate feature unstable-msc3814 only.

Request type for the PUT dehydrated_device endpoint.

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.

device_id: OwnedDeviceId

The unique ID of the device.

initial_device_display_name: Option<String>

The display name of the device.

device_data: Raw<DehydratedDeviceData>

The data of the dehydrated device, containing the serialized and encrypted private parts of the DeviceKeys.

device_keys: Raw<DeviceKeys>

Identity keys for the dehydrated device.

one_time_keys: BTreeMap<OwnedOneTimeKeyId, Raw<OneTimeKey>>

One-time public keys for “pre-key” messages.

fallback_keys: BTreeMap<OwnedOneTimeKeyId, Raw<OneTimeKey>>

Fallback public keys for “pre-key” messages.

Implementations

impl Request

pub fn new( device_id: OwnedDeviceId, device_data: Raw<DehydratedDeviceData>, device_keys: Raw<DeviceKeys>, ) -> Self

Creates a new 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 IncomingRequest for Request

Available on crate feature server only.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

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.

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.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

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.

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.