Struct Token

pub struct Token {
    pub token: String,
    pub token_type: String,
    pub expires_at: Option<Instant>,
    pub metadata: Option<HashMap<String, String>>,
}

Represents an auth token.

Fields

token: String

The actual token string.

This is the value used in Authorization: header.

token_type: String

The type of the token.

The most common type is "Bearer" but other types may appear in the future.

expires_at: Option<Instant>

The instant at which the token expires.

If None, the token does not expire.

Note that the Instant is not valid across processes. It is recommended to let the authentication library refresh tokens within a process instead of handling expirations yourself. If you do need to copy an expiration across processes, consider converting it to a time::OffsetDateTime first:

expires_at.map(|i| time::OffsetDateTime::now_utc() + (i - std::time::Instant::now()));

metadata: Option<HashMap<String, String>>

Optional metadata associated with the token.

This might include information like granted scopes or other claims.

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 PartialEq for Token

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Token