Struct ruma_client_api::profile::set_avatar_url::v3::Request

pub struct Request {
    pub user_id: OwnedUserId,
    pub avatar_url: Option<OwnedMxcUri>,
    pub blurhash: Option<String>,
}

Available on crate features client or server only.

Request type for the set_avatar_url endpoint.

Fields

user_id: OwnedUserId

The user whose avatar URL will be set.

avatar_url: Option<OwnedMxcUri>

The new avatar URL for the user.

None is used to unset the avatar.

If you activate the compat feature, this field being an empty string in JSON will result in None here during deserialization.

blurhash: Option<String>

Available on crate feature unstable-msc2448 only.

The BlurHash for the avatar pointed to by avatar_url.

This uses the unstable prefix in MSC2448.

Implementations

impl Request

pub fn new(user_id: OwnedUserId, avatar_url: Option<OwnedMxcUri>) -> Self

Creates a new Request with the given user ID and avatar URL.

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

Formats the value using the given formatter.

impl IncomingRequest for Request

Available on crate feature server only.

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.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

fn try_from_http_request<B, S>( request: Request<B>, path_args: &[S] ) -> Result<Self, 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.

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.