Struct Request

#[non_exhaustive]
pub struct Request {
    pub room_id: OwnedRoomId,
    pub event_type: StateEventType,
    pub state_key: String,
    pub body: Raw<AnyStateEventContent>,
    pub timestamp: Option<MilliSecondsSinceUnixEpoch>,
}

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

Request type for the send_state_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 set the state in.

event_type: StateEventType

The type of event to send.

state_key: String

The state_key for the state to send.

body: Raw<AnyStateEventContent>

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.

Implementations

impl Request

pub fn new<T, K>( room_id: OwnedRoomId, state_key: &K, content: &T, ) -> Result<Request, Error>

where T: StateEventContent, <T as StateEventContent>::StateKey: Borrow<K>, K: AsRef<str> + ?Sized,

Creates a new Request with the given room id, state key 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, event_type: StateEventType, state_key: String, body: Raw<AnyStateEventContent>, ) -> Request

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

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

impl OutgoingRequest for Request

Available on crate feature client only.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

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

where T: Default + BufMut,

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