Struct OAuth2Token 

pub struct OAuth2Token { /* private fields */ }

Available on crate feature oauth2 only.

An OAuth2 access token with expiration tracking.

Implementations

impl OAuth2Token

pub fn new(access_token: impl Into<String>) -> Self

Creates a new OAuth2 token.

pub fn with_expiry( access_token: impl Into<String>, expires_in: Duration, ) -> Self

Creates a new OAuth2 token with an expiration time.

pub fn with_refresh_token(self, refresh_token: impl Into<String>) -> Self

Sets the refresh token.

pub fn access_token(&self) -> &str

Returns the access token value.

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

Returns the refresh token if available.

pub fn is_expired(&self) -> bool

Checks if the token is expired.

Returns false if the token has no expiration time.

pub fn should_refresh(&self, threshold: Duration) -> bool

Checks if the token should be refreshed.

Returns true if the token will expire within the given threshold.

pub fn time_until_expiry(&self) -> Option<Duration>

Returns the time until expiration, if known.

Trait Implementations

impl Clone for OAuth2Token

fn clone(&self) -> OAuth2Token

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OAuth2Token

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

Formats the value using the given formatter.

impl Drop for OAuth2Token

fn drop(&mut self)

Executes the destructor for this type.

impl Zeroize for OAuth2Token

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.