Struct ruma_client_api::to_device::send_event_to_device::v3::Request

#[non_exhaustive]
pub struct Request<'a> {
    pub event_type: &'a str,
    pub txn_id: &'a TransactionId,
    pub messages: Messages,
}

Data for a request to the send_event_to_device API endpoint.

Send an event to a device or devices.

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.

event_type: &'a str

Type of event being sent to each device.

txn_id: &'a TransactionId

A request identifier unique to the access token used to send the request.

messages: Messages

Messages to send.

Different message events can be sent to different devices in the same request, but all events within one request must be of the same type.

Implementations

impl<'a> Request<'a>

pub fn new_raw(
    event_type: &'a str,
    txn_id: &'a TransactionId,
    messages: Messages
) -> Self

Creates a new Request with the given event type, transaction ID and raw messages.

Trait Implementations

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

fn clone(&self) -> Request<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

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.

const METADATA: Metadata = self::METADATA

Metadata about the endpoint.

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.