Struct Response

#[non_exhaustive]
pub struct Response {
    pub access_token: Option<String>,
    pub user_id: OwnedUserId,
    pub device_id: Option<OwnedDeviceId>,
    pub refresh_token: Option<String>,
    pub expires_in: Option<Duration>,
}

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

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

access_token: Option<String>

An access token for the account.

This access token can then be used to authorize other requests.

Required if the request’s inhibit_login was set to false.

user_id: OwnedUserId

The fully-qualified Matrix ID that has been registered.

device_id: Option<OwnedDeviceId>

ID of the registered device.

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

Required if the request’s inhibit_login was set to false.

refresh_token: Option<String>

A refresh token for the account.

This token can be used to obtain a new access token when it expires by calling the refresh_token endpoint.

Omitted if the request’s inhibit_login was set to true.

expires_in: Option<Duration>

The lifetime of the access token, in milliseconds.

Once the access token has expired, a new access token can be obtained by using the provided refresh token. If no refresh token is provided, the client will need to re-login to obtain a new access token.

If this is None, the client can assume that the access token will not expire.

Omitted if the request’s inhibit_login was set to true.

Implementations

impl Response

pub fn new(user_id: OwnedUserId) -> 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 = UiaaResponse

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

fn try_from_http_response<T>( response: Response<T>, ) -> Result<Response, FromHttpResponseError<UiaaResponse>>

where T: AsRef<[u8]>,

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

impl OutgoingResponse for Response

Available on crate feature server only.

fn try_into_http_response<T>(self) -> Result<Response<T>, IntoHttpError>

where T: Default + BufMut,

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