Struct tame_oauth::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<SystemTime>,
}

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 has reached its 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.

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<SystemTime>

timestamp is seconds since epoch indicating when the token will expire in absolute terms.

Implementations

impl Token

pub fn has_expired(&self) -> bool

Returns true if we are expired.

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 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 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: &Rhs) -> bool

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

impl TryInto<HeaderValue> for Token

type Error = Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<HeaderValue, Error>

Performs the conversion.

impl Eq for Token

impl StructuralEq for Token

impl StructuralPartialEq for Token