Struct ruma::api::client::session::login::v3::Response

#[non_exhaustive]
pub struct Response {
    pub user_id: OwnedUserId,
    pub access_token: String,
    pub home_server: Option<OwnedServerName>,
    pub device_id: OwnedDeviceId,
    pub well_known: Option<DiscoveryInfo>,
}

Data in the response from the login API 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 fully-qualified Matrix ID that has been registered.

access_token: String

An access token for the account.

home_server: Option<OwnedServerName>

The hostname of the homeserver on which the account has been registered.

Deprecated: Clients should instead use the user_id.server_name() method if they require it.

device_id: OwnedDeviceId

ID of the logged-in device.

Will be the same as the corresponding parameter in the request, if one was specified.

well_known: Option<DiscoveryInfo>

Client configuration provided by the server.

If present, clients SHOULD use the provided object to reconfigure themselves.

Implementations

impl Response

pub fn new(
    user_id: OwnedUserId,
    access_token: String,
    device_id: OwnedDeviceId
) -> Response

Creates a new Response with the given user ID, access token and device 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

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.