Struct Request 

#[non_exhaustive]
pub struct Request {
    pub room_id: OwnedRoomId,
    pub event_type: MessageLikeEventType,
    pub txn_id: OwnedTransactionId,
    pub body: Raw<AnyMessageLikeEventContent>,
    pub timestamp: Option<MilliSecondsSinceUnixEpoch>,
    pub sticky_duration_ms: Option<StickyDurationMs>,
}

Available on crate features client or server only.

Request type for the create_message_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: MessageLikeEventType

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.

body: Raw<AnyMessageLikeEventContent>

The event content to send.

timestamp: Option<MilliSecondsSinceUnixEpoch>

Timestamp to use for the origin_server_ts of the event.

This is called timestamp massaging and can only be used by Appservices.

Note that this does not change the position of the event in the timeline.

sticky_duration_ms: Option<StickyDurationMs>

Available on crate feature unstable-msc4354 only.

The duration to stick the event for.

Valid values are the integer range 0-3600000 (1 hour). The presence of this field indicates that the event should be sticky, this will give this event additional delivery guarantees.

Caller must first check that the server supports sticky events (via /versions), or it will be no-op.

See MSC4354 sticky events.

Implementations

impl Request

pub fn new<T>( room_id: OwnedRoomId, txn_id: OwnedTransactionId, content: &T, ) -> Result<Self>

where T: MessageLikeEventContent,

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

Errors

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

pub fn new_raw( room_id: OwnedRoomId, txn_id: OwnedTransactionId, event_type: MessageLikeEventType, body: Raw<AnyMessageLikeEventContent>, ) -> Self

Creates a new Request with the given room id, transaction id, event type 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

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<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: 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 Body = RequestBody

HTTP body type pre-serialization.

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_inner( self, base_url: &str, path_builder_input: <<Self as Metadata>::PathBuilder as PathBuilder>::Input<'_>, ) -> Result<Request<Self::Body>, IntoHttpError>

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