Struct matrix_sdk_base::ruma::api::client::config::set_global_account_data::v3::Request

#[non_exhaustive]
pub struct Request {
    pub user_id: OwnedUserId,
    pub event_type: GlobalAccountDataEventType,
    pub data: Raw<AnyGlobalAccountDataEventContent>,
}

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

Request type for the set_global_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.

event_type: GlobalAccountDataEventType

The event type of the account_data to set.

Custom types should be namespaced to avoid clashes.

data: Raw<AnyGlobalAccountDataEventContent>

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, data: &T) -> Result<Request, Error>

where T: GlobalAccountDataEventContent,

Creates a new Request with the given data, event type 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, event_type: GlobalAccountDataEventType, data: Raw<AnyGlobalAccountDataEventContent>, ) -> Request

Creates a new Request with the given raw data, event type 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 OutgoingRequest for Request

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.