Struct Request

#[non_exhaustive]
pub struct Request {
    pub txn_id: OwnedTransactionId,
    pub events: Vec<Raw<AnyTimelineEvent>>,
    pub device_lists: DeviceLists,
    pub device_one_time_keys_count: BTreeMap<OwnedUserId, BTreeMap<OwnedDeviceId, BTreeMap<OneTimeKeyAlgorithm, UInt>>>,
    pub device_unused_fallback_key_types: BTreeMap<OwnedUserId, BTreeMap<OwnedDeviceId, Vec<OneTimeKeyAlgorithm>>>,
    pub ephemeral: Vec<Edu>,
    pub to_device: Vec<Raw<AnyToDeviceEvent>>,
}

Available on crate feature api and (crate features appservice-api-c or appservice-api-s) only.

Request type for the push_events 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.

txn_id: OwnedTransactionId

The transaction ID for this set of events.

Homeservers generate these IDs and they are used to ensure idempotency of results.

events: Vec<Raw<AnyTimelineEvent>>

A list of events.

device_lists: DeviceLists

Available on crate feature unstable-msc3202 only.

Information on E2E device updates.

device_one_time_keys_count: BTreeMap<OwnedUserId, BTreeMap<OwnedDeviceId, BTreeMap<OneTimeKeyAlgorithm, UInt>>>

Available on crate feature unstable-msc3202 only.

The number of unclaimed one-time keys currently held on the server for this device, for each algorithm.

device_unused_fallback_key_types: BTreeMap<OwnedUserId, BTreeMap<OwnedDeviceId, Vec<OneTimeKeyAlgorithm>>>

Available on crate feature unstable-msc3202 only.

A list of key algorithms for which the server has an unused fallback key for the device.

ephemeral: Vec<Edu>

Available on crate feature unstable-msc2409 only.

A list of EDUs.

to_device: Vec<Raw<AnyToDeviceEvent>>

Available on crate feature unstable-msc2409 only.

A list of to-device messages.

Implementations

impl Request

pub fn new( txn_id: OwnedTransactionId, events: Vec<Raw<AnyTimelineEvent>>, ) -> Request

Creates an Request with the given transaction ID and list of events.

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<(), Error>

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 = MatrixError

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<Request, 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 = MatrixError

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>( self, base_url: &str, access_token: SendAccessToken<'_>, considering_versions: &[MatrixVersion], ) -> Result<Request<T>, IntoHttpError>

where T: Default + BufMut,

Tries to convert this request into an http::Request.