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

pub struct Request<'a> {
    pub user_id: &'a UserId,
    pub event_type: GlobalAccountDataEventType,
    pub data: Raw<AnyGlobalAccountDataEventContent>,
}

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 set_global_account_data API endpoint.

Sets global account data.

Fields

user_id: &'a UserId

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

pub fn new<T>(user_id: &'a UserId, data: &'a T) -> Result<Request<'a>, 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][serde::Serialize] implementation can fail.

pub fn new_raw(
    user_id: &'a UserId,
    event_type: GlobalAccountDataEventType,
    data: Raw<AnyGlobalAccountDataEventContent>
) -> Request<'a>

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

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