Struct Response

#[non_exhaustive]
pub struct Response {
    pub expires_in: Duration,
    pub login_token: String,
}

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 login 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.

expires_in: Duration

The time remaining in milliseconds until the homeserver will no longer accept the token.

2 minutes is recommended as a default.

login_token: String

The login token for the m.login.token login flow.

Implementations

impl Response

pub fn new(expires_in: Duration, login_token: String) -> Response

Creates a new Response with the given expiration duration and login token.

pub fn with_default_expiration_duration(login_token: String) -> Response

Creates a new Response with the default expiration duration and the given login token.

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.