Struct Request 

#[non_exhaustive]
pub struct Request {
    pub transaction_id: OwnedTransactionId,
    pub origin: OwnedServerName,
    pub origin_server_ts: MilliSecondsSinceUnixEpoch,
    pub pdus: Vec<Box<RawValue>>,
    pub edus: Vec<Raw<Edu>>,
}

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

transaction_id: OwnedTransactionId

A transaction ID unique between sending and receiving homeservers.

origin: OwnedServerName

The server_name of the homeserver sending this transaction.

origin_server_ts: MilliSecondsSinceUnixEpoch

POSIX timestamp in milliseconds on the originating homeserver when this transaction started.

pdus: Vec<Box<RawValue>>

List of persistent updates to rooms.

Must not be more than 50 items.

With the compat-optional-pdus feature, this field is optional in deserialization, defaulting to an empty Vec.

edus: Vec<Raw<Edu>>

List of ephemeral messages.

Must not be more than 100 items.

Implementations

impl Request

pub fn new( transaction_id: OwnedTransactionId, origin: OwnedServerName, origin_server_ts: MilliSecondsSinceUnixEpoch, ) -> Self

Creates a new Request with the given transaction ID, origin, timestamp.

The PDU and EDU lists will start off empty.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a duplicate 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.

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<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.

fn check_request_method(method: &Method) -> Result<(), FromHttpRequestError>

Check whether the given HTTP method from an incoming request is compatible with the expected METHOD of this endpoint.

impl Metadata for Request

const METHOD: Method = ::ruma_common::exports::http::Method::PUT

The HTTP method used by this endpoint.

const RATE_LIMITED: bool = false

Whether or not this endpoint is rate limited by the server.

const PATH_BUILDER: SinglePath

All info pertaining to an endpoint’s path.

type Authentication = ServerSignatures

What authentication scheme the server uses for this endpoint.

type PathBuilder = SinglePath

The type used to build an endpoint’s path.

fn empty_request_body<B>() -> B

where B: Default + BufMut,

Returns an empty request body for this Matrix request.

fn make_endpoint_url( path_builder_input: <Self::PathBuilder as PathBuilder>::Input<'_>, base_url: &str, path_args: &[&dyn Display], query_string: &str, ) -> Result<String, IntoHttpError>

Generate the endpoint URL for this endpoint.

impl OutgoingRequest for Request

Available on crate feature client only.

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: Default + BufMut + AsRef<[u8]>>( self, base_url: &str, authentication_input: <<Self as Metadata>::Authentication as AuthScheme>::Input<'_>, path_builder_input: <<Self as Metadata>::PathBuilder as PathBuilder>::Input<'_>, ) -> Result<Request<T>, IntoHttpError>

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