Struct Request 

#[non_exhaustive]
pub struct Request {
    pub room_id: OwnedRoomId,
    pub event_type: TimelineEventType,
    pub txn_id: OwnedTransactionId,
    pub delay: Duration,
    pub state_key: Option<String>,
    pub content: Raw<AnyTimelineEventContent>,
}

Available on crate feature api and crate feature unstable-msc4140 and (crate features client-api-c or client-api-s) and (crate features client or server) only.

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

room_id: OwnedRoomId

The room to send the event to.

event_type: TimelineEventType

The type of event to send.

txn_id: OwnedTransactionId

The transaction ID for this event.

Clients should generate a unique ID across requests within the same session. A session is identified by an access token, and persists when the access token is refreshed.

It will be used by the server to ensure idempotency of requests.

delay: Duration

The duration that the server should wait before sending this event

state_key: Option<String>

The State Key if the event is a state event, nothing otherwise

content: Raw<AnyTimelineEventContent>

The event content to send.

Implementations

impl Request

pub fn new( room_id: OwnedRoomId, txn_id: OwnedTransactionId, delay: Duration, state_key: Option<String>, content: &AnyTimelineEventContent, ) -> Result<Request, Error>

Creates a new Request with the given room id, transaction id, delay_parameters and event content.

Errors

Since Request stores the request body in serialized form, this function can fail if Ts ::serde::Serialize implementation can fail.

pub fn new_raw( event_type: TimelineEventType, room_id: OwnedRoomId, txn_id: OwnedTransactionId, delay: Duration, state_key: Option<String>, content: Raw<AnyTimelineEventContent>, ) -> Result<Request, Error>

Creates a new Request with the given room id, transaction id, event type, delay_parameters and raw event content.

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

Formats the value using the given formatter.

impl IncomingRequest for Request

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.

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.

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

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

const PATH_BUILDER: VersionHistory

All info pertaining to an endpoint’s path.

type Authentication = AccessToken

What authentication scheme the server uses for this endpoint.

type PathBuilder = VersionHistory

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 = 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>( self, base_url: &str, authentication_input: <<Request as Metadata>::Authentication as AuthScheme>::Input<'_>, path_builder_input: <<Request as Metadata>::PathBuilder as PathBuilder>::Input<'_>, ) -> Result<Request<T>, IntoHttpError>

where T: Default + BufMut + AsRef<[u8]>,

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