Struct ruma_client_api::presence::set_presence::v3::Request

#[non_exhaustive]
pub struct Request<'a> {
    pub user_id: &'a UserId,
    pub presence: PresenceState,
    pub status_msg: Option<&'a str>,
}

Data for a request to the set_presence API endpoint.

Set presence status for this user.

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: &'a UserId

The user whose presence state will be updated.

presence: PresenceState

The new presence state.

status_msg: Option<&'a str>

The status message to attach to this state.

Implementations

impl<'a> Request<'a>

pub fn new(user_id: &'a UserId, presence: PresenceState) -> Self

Creates a new Request with the given user ID and presence state.

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