Struct Response

#[non_exhaustive]
pub struct Response {
    pub user_id: OwnedUserId,
    pub device_id: Option<OwnedDeviceId>,
    pub is_guest: bool,
}

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

Response type for the whoami 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 that owns the access token.

device_id: Option<OwnedDeviceId>

The device ID associated with the access token, if any.

is_guest: bool

If true, the user is a guest user.

Implementations

impl Response

pub fn new(user_id: OwnedUserId, is_guest: bool) -> Response

Creates a new Response with the given user ID.

Trait Implementations

impl Clone for Response

fn clone(&self) -> Response

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Response

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

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<T>( response: Response<T>, ) -> Result<Response, FromHttpResponseError<Error>>

where T: AsRef<[u8]>,

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