Struct Token 

pub struct Token { /* private fields */ }

A bearer token, shared behind one pointer so that it stays cheap to clone and embed.

Implementations

impl Token

pub fn expose_secret(&self) -> &str

The token itself, to send as a bearer credential or store.

pub fn resource(&self) -> Option<&str>

The resource the token is for, such as the API URL to call, when its token response named one. Clients read this rather than the token’s claims (RFC 9068 §6).

pub fn with_resource(self, resource: Option<String>) -> Self

Record the resource that the token’s response named.

pub fn unverified_claims<T: DeserializeOwned>(&self) -> CredentialResult<T>

Decode the claims of a JWT without verifying its signature.

Use the claims only to manage the token, such as deciding when to refresh it; the service that accepts the token is the one that verifies it.

pub fn remaining_lifetime(&self) -> CredentialResult<Duration>

How long until the token expires, without validating its signature.

Zero once expired, rather than underflowing.

pub fn is_expired(&self) -> CredentialResult<bool>

True if the token has expired or will within 30 seconds. Such a token is unusable.

pub fn needs_refresh(&self) -> CredentialResult<bool>

True if the token expires within a minute. It is still usable, but a fresh one should be fetched proactively.

Trait Implementations

impl Clone for Token

fn clone(&self) -> Self

Returns a duplicate 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<'_>) -> FmtResult

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Token

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Token

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

Formats the value using the given formatter.

impl Eq for Token

impl From<&str> for Token

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for Token

fn from(value: String) -> Self

Converts to this type from the input type.

impl Hash for Token

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Token

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Token

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.