Struct Token

pub struct Token {
    pub expires_in: u64,
    pub created_at: DateTime<Utc>,
    pub expires_at: DateTime<Utc>,
    /* private fields */
}

An OAuth2 token.

Fields

expires_in: u64

How long until the current token expires, in seconds.

created_at: DateTime<Utc>

The UTC date and time when the token was created.

expires_at: DateTime<Utc>

The UTC date and time when the token will expire.

Implementations

impl Token

pub fn new( access_token: impl Into<String>, refresh_token: Option<&str>, created_at: DateTime<Utc>, expires_in: u64, scopes: Option<Scopes>, ) -> Self

Create a new token, to be used with one of the from_access_token methods.

pub fn secret(&self) -> &str

Get the current access token secret.

pub fn refresh_secret(&self) -> Option<&str>

Get the current refresh token. Some auth flows may not provide a refresh token, in which case it will return None.

pub fn is_expired(&self) -> bool

Returns true if the access token has expired.

pub fn is_refreshable(&self) -> bool

Returns true if a refresh token is present.

Trait Implementations

impl Clone for Token

fn clone(&self) -> Token

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Token

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Token

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Token

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TokenResponse<BasicTokenType> for Token

fn access_token(&self) -> &AccessToken

REQUIRED. The access token issued by the authorization server.

fn token_type(&self) -> &BasicTokenType

REQUIRED. The type of the token issued as described in Section 7.1. Value is case insensitive and deserialized to the generic TokenType parameter.

fn expires_in(&self) -> Option<Duration>

RECOMMENDED. The lifetime in seconds of the access token. For example, the value 3600 denotes that the access token will expire in one hour from the time the response was generated. If omitted, the authorization server SHOULD provide the expiration time via other means or document the default value.

fn refresh_token(&self) -> Option<&RefreshToken>

OPTIONAL. The refresh token, which can be used to obtain new access tokens using the same authorization grant as described in Section 6.

fn scopes(&self) -> Option<&Vec<Scope>>

OPTIONAL, if identical to the scope requested by the client; otherwise, REQUIRED. The scope of the access token as described by Section 3.3. If included in the response, this space-delimited field is parsed into a Vec of individual scopes. If omitted from the response, this field is None.