Struct yup_oauth2::Token

pub struct Token {
    pub access_token: String,
    pub refresh_token: String,
    pub token_type: String,
    pub expires_in: Option<i64>,
    pub expires_in_timestamp: Option<i64>,
}

Represents a token as returned by OAuth2 servers.

It is produced by all authentication flows. It authenticates certain operations, and must be refreshed once it reached it's expiry date.

The type is tuned to be suitable for direct de-serialization from server replies, as well as for serialization for later reuse. This is the reason for the two fields dealing with expiry - once in relative in and once in absolute terms.

Utility methods make common queries easier, see expired().

Fields

access_token: String

used when authenticating calls to oauth2 enabled services.

refresh_token: String

used to refresh an expired access_token.

token_type: String

The token type as string - usually 'Bearer'.

expires_in: Option<i64>

access_token will expire after this amount of time. Prefer using expiry_date()

expires_in_timestamp: Option<i64>

timestamp is seconds since epoch indicating when the token will expire in absolute terms. use expiry_date() to convert to DateTime.

Methods

impl Token

pub fn expired(&self) -> bool

Returns true if we are expired.

Panics

• if our access_token is unset

pub fn expiry_date(&self) -> DateTime<Utc>

Returns a DateTime object representing our expiry date.

pub fn set_expiry_absolute(&mut self) -> &mut Token

Adjust our stored expiry format to be absolute, using the current time.

Trait Implementations

impl Clone for Token

fn clone(&self) -> Token

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<Token> for Token

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

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

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

This method tests for !=.

impl Debug for Token

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

Formats the value using the given formatter.

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