Struct ruma::api::client::state::send_state_event::v3::Request

pub struct Request<'a> {
    pub room_id: &'a RoomId,
    pub event_type: StateEventType,
    pub state_key: &'a str,
    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.

Data for a request to the send_state_event API endpoint.

Send a state event to a room associated with a given state key.

Fields

room_id: &'a RoomId

The room to set the state in.

event_type: StateEventType

The type of event to send.

state_key: &'a str

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<'a> Request<'a>

pub fn new<T, K>(
    room_id: &'a RoomId,
    state_key: &'a K,
    content: &'a T
) -> Result<Request<'a>, Error>where
    T: StateEventContent,
    K: AsRef<str> + ?Sized,
    <T as StateEventContent>::StateKey: Borrow<K>,

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][serde::Serialize] implementation can fail.

pub fn new_raw(
    room_id: &'a RoomId,
    event_type: StateEventType,
    state_key: &'a str,
    body: Raw<AnyStateEventContent>
) -> Request<'a>

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

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

Formats the value using the given formatter.

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

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.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

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.