Struct ruma_client_api::state::send_state_event::v3::Request

#[non_exhaustive]
pub struct Request<'a> {
    pub room_id: &'a RoomId,
    pub event_type: StateEventType,
    pub state_key: &'a str,
    pub body: Raw<AnyStateEventContent>,
}

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 (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: &'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.

Implementations

impl<'a> Request<'a>

pub fn new<T>(
    room_id: &'a RoomId,
    state_key: &'a str,
    content: &'a T
) -> Result<Self> where
    T: StateEventContent, 

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: &'a RoomId,
    event_type: StateEventType,
    state_key: &'a str,
    body: Raw<AnyStateEventContent>
) -> Self

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

Formats the value using the given formatter.

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

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: Default + BufMut>(
    self,
    base_url: &str,
    access_token: SendAccessToken<'_>,
    considering_versions: &[MatrixVersion]
) -> Result<Request<T>, IntoHttpError>

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