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>,
    pub refresh_token: Option<String>,
    pub expires_in: Option<Duration>,
}
Available on crate features client or server only.
Expand description

Response type for the login endpoint.

Fields§

§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>
👎Deprecated: Since Matrix Client-Server API r0.4.0. Clients should instead use the <code>user_id.server_name()</code> method if they require it.

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

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

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

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

Implementations§

source§

impl Response

source

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

Creates a new Response with the given user ID, access token and device ID.

Trait Implementations§

source§

impl Clone for Response

source§

fn clone(&self) -> Response

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Response

source§

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

Formats the value using the given formatter. Read more
source§

impl IncomingResponse for Response

Available on crate feature client only.
§

type EndpointError = Error

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

fn try_from_http_response<T: AsRef<[u8]>>( response: Response<T> ) -> Result<Self, FromHttpResponseError<Error>>

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

impl OutgoingResponse for Response

Available on crate feature server only.
source§

fn try_into_http_response<T: Default + BufMut>( self ) -> Result<Response<T>, IntoHttpError>

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

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more