Struct matrix_sdk::oidc::types::requests::AccessTokenResponse

pub struct AccessTokenResponse {
    pub access_token: String,
    pub refresh_token: Option<String>,
    pub id_token: Option<String>,
    pub token_type: OAuthAccessTokenType,
    pub expires_in: Option<TimeDelta>,
    pub scope: Option<Scope>,
}

Available on crate feature experimental-oidc only.

A successful response from the Token Endpoint.

Fields

access_token: String

The access token to access the requested scope.

refresh_token: Option<String>

The token to refresh the access token when it expires.

id_token: Option<String>

ID Token value associated with the authenticated session.

token_type: OAuthAccessTokenType

The type of the access token.

expires_in: Option<TimeDelta>

The duration for which the access token is valid.

scope: Option<Scope>

The scope of the access token.

Implementations

impl AccessTokenResponse

pub fn new(access_token: String) -> AccessTokenResponse

Creates a new AccessTokenResponse with the given access token.

pub fn with_refresh_token(self, refresh_token: String) -> AccessTokenResponse

Adds a refresh token to an AccessTokenResponse.

pub fn with_id_token(self, id_token: String) -> AccessTokenResponse

Adds an ID token to an AccessTokenResponse.

pub fn with_scope(self, scope: Scope) -> AccessTokenResponse

Adds a scope to an AccessTokenResponse.

pub fn with_expires_in(self, expires_in: TimeDelta) -> AccessTokenResponse

Adds an expiration duration to an AccessTokenResponse.

Trait Implementations

impl Clone for AccessTokenResponse

fn clone(&self) -> AccessTokenResponse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AccessTokenResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AccessTokenResponse

fn deserialize<__D>( __deserializer: __D, ) -> Result<AccessTokenResponse, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AccessTokenResponse

fn eq(&self, other: &AccessTokenResponse) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for AccessTokenResponse

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for AccessTokenResponse

impl StructuralPartialEq for AccessTokenResponse