Struct yup_oauth2::storage::TokenInfo

pub struct TokenInfo {
    pub access_token: Option<String>,
    pub refresh_token: Option<String>,
    pub expires_at: Option<OffsetDateTime>,
    pub id_token: Option<String>,
}

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.

Fields

access_token: Option<String>

used when authorizing calls to oauth2 enabled services.

refresh_token: Option<String>

used to refresh an expired access_token.

expires_at: Option<OffsetDateTime>

The time when the token expires.

id_token: Option<String>

Optionally included by the OAuth2 server and may contain information to verify the identity used to obtain the access token. Specifically Google API:s include this if the additional scopes “email” and/or “profile” are used. In that case the content is an JWT token.

Implementations

impl TokenInfo

pub fn is_expired(&self) -> bool

Returns true if we are expired.

Trait Implementations

impl Clone for TokenInfo

fn clone(&self) -> TokenInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TokenInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TokenInfo

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<TokenInfo> for AccessToken

fn from(_: TokenInfo) -> Self

Converts to this type from the input type.

impl PartialEq for TokenInfo

fn eq(&self, other: &TokenInfo) -> 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 TokenInfo

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TokenInfo