Struct Request

#[non_exhaustive]
pub struct Request {
    pub user_id: OwnedUserId,
    pub room_id: OwnedRoomId,
    pub event_type: RoomAccountDataEventType,
    pub data: Raw<AnyRoomAccountDataEventContent>,
}

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

user_id: OwnedUserId

The ID of the user to set account_data for.

The access token must be authorized to make requests for this user ID.

room_id: OwnedRoomId

The ID of the room to set account_data on.

event_type: RoomAccountDataEventType

The event type of the account_data to set.

Custom types should be namespaced to avoid clashes.

data: Raw<AnyRoomAccountDataEventContent>

Arbitrary JSON to store as config data.

To create a RawJsonValue, use serde_json::value::to_raw_value.

Implementations

impl Request

pub fn new<T>( user_id: OwnedUserId, room_id: OwnedRoomId, data: &T, ) -> Result<Request, Error>

where T: RoomAccountDataEventContent,

Creates a new Request with the given data, event type, room ID and user ID.

Errors

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

pub fn new_raw( user_id: OwnedUserId, room_id: OwnedRoomId, event_type: RoomAccountDataEventType, data: Raw<AnyRoomAccountDataEventContent>, ) -> Request

Creates a new Request with the given raw data, event type, room ID and user ID.

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.