Struct Response 

#[non_exhaustive]
pub struct Response {
    pub status_msg: Option<String>,
    pub status: PresenceStatus,
    pub currently_active: Option<bool>,
    pub last_active_ago: Option<Duration>,
    pub presence: PresenceState,
}

Available on crate features client or server only.

Response type for the get_presence 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.

status_msg: Option<String>

👎Deprecated:

Deprecated when MSC4532 is enabled, use status instead

The state message for this user if one was set.

If the unstable-msc4532 feature is enabled, this field will always have the same value as status.msg after deserialization.

status: PresenceStatus

Available on crate feature unstable-msc4532 only.

The status information for this user’s presence.

This field uses the unstable prefix defined in MSC4532.

If this field is not present at deserialization, the value of status_msg will be used instead.

currently_active: Option<bool>

👎Deprecated:

Deprecated when MSC4532 is enabled, use PresenceState::currently_active instead

Whether the user is currently active or not.

If the unstable-msc4532 feature is enabled and presence is a MSC4532 presence state, this field will be ignored and will always have the same value as PresenceState::currently_active after deserialization.

last_active_ago: Option<Duration>

The length of time in milliseconds since an action was performed by the user.

presence: PresenceState

The user’s presence state.

Implementations

impl Response

pub fn new(presence: PresenceState) -> Self

Creates a new Response with the given presence state.

Trait Implementations

impl Clone for Response

Available on non-ruma_unstable_exhaustive_types only.

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Response

Available on non-ruma_unstable_exhaustive_types only.

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl IncomingResponse for Response

Available on crate feature client only.

type EndpointError = Error

A type capturing the expected error conditions the server can return.

fn try_from_http_response_inner( response: Response<&[u8]>, ) -> Result<Self, DeserializationError>

Tries to convert the given http::Response into this response type.

impl OutgoingResponse for Response

Available on crate feature server only.

type Body = ResponseBody

HTTP body type pre-serialization.

fn try_into_http_response_inner( self, ) -> Result<Response<Self::Body>, IntoHttpError>

Tries to convert this response into an http::Response.