Struct tame_oauth::Token

source ·
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>,
}
Expand description

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§

Returns true if we are expired.

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Deserialize this value from the given Serde deserializer. Read more
This method tests for self and other values to be equal, and is used by ==.
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
The type returned in the event of a conversion error.
Performs the conversion.

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.