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>,
}
client-api-c
or client-api-s
) and (crate features client
or server
) and crate feature api
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>
user_id.server_name()
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
impl Response
sourcepub fn new(
user_id: OwnedUserId,
access_token: String,
device_id: OwnedDeviceId,
) -> 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§
source§impl IncomingResponse for Response
Available on crate feature client
only.
impl IncomingResponse for Response
client
only.source§type EndpointError = Error
type EndpointError = Error
source§fn try_from_http_response<T>(
response: Response<T>,
) -> Result<Response, FromHttpResponseError<Error>>
fn try_from_http_response<T>( response: Response<T>, ) -> Result<Response, FromHttpResponseError<Error>>
http::Response
into this response type.source§impl OutgoingResponse for Response
Available on crate feature server
only.
impl OutgoingResponse for Response
server
only.source§fn try_into_http_response<T>(self) -> Result<Response<T>, IntoHttpError>
fn try_into_http_response<T>(self) -> Result<Response<T>, IntoHttpError>
http::Response
. Read moreAuto Trait Implementations§
impl Freeze for Response
impl RefUnwindSafe for Response
impl Send for Response
impl Sync for Response
impl Unpin for Response
impl UnwindSafe for Response
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
source§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more