Struct TokenSet 

pub struct TokenSet<S: ValidationState = Validated> { /* private fields */ }

The set of tokens returned by a successful OAuth 2.0 authorization or refresh flow.

Obtain a TokenSet by calling crate::CliTokenClient::run_authorization_flow or crate::CliTokenClient::refresh. Persist it with crate::TokenStore.

Serializes expires_at as a Unix timestamp (u64) or null when the provider did not return expires_in.

Example

use loopauth::{TokenSet, Unvalidated};

let json = r#"{
  "access_token": "tok123",
  "refresh_token": "ref456",
  "expires_at": 9999999999,
  "token_type": "Bearer",
  "oidc": null,
  "scopes": ["openid", "email"]
}"#;
let tokens: TokenSet<Unvalidated> = serde_json::from_str(json).unwrap();

assert_eq!(tokens.access_token().as_str(), "tok123");
assert_eq!(tokens.refresh_token().unwrap().as_str(), "ref456");
assert_eq!(tokens.token_type(), "Bearer");
assert_eq!(tokens.scopes().len(), 2);
assert!(!tokens.is_expired());

Implementations

impl<S: ValidationState> TokenSet<S>

pub const fn access_token(&self) -> &AccessToken

Returns the access token.

pub const fn refresh_token(&self) -> Option<&RefreshToken>

Returns the refresh token, if present.

pub fn token_type(&self) -> &str

Returns the token type (e.g., “Bearer”).

pub const fn expires_at(&self) -> Option<SystemTime>

Returns the time at which the access token expires, if the provider returned one.

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

Returns the raw ID token JWT string, if present.

pub fn scopes(&self) -> &[OAuth2Scope]

Returns the scopes granted with this token set.

pub fn is_expired(&self) -> bool

Returns true if the token has expired.

Returns false when the provider did not return an expiry time.

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

Returns true if the token expires within the given threshold duration, or if the token has already expired.

Returns false when the provider did not return an expiry time.

impl TokenSet<Unvalidated>

pub fn into_validated(self) -> TokenSet<Validated>

Convert an unvalidated token set to a validated one.

Callers that deserialize a stored TokenSet from JSON will receive a TokenSet<Unvalidated>. Call this to opt into the Validated state so that OIDC methods such as TokenSet::oidc are available.

impl TokenSet<Validated>

pub const fn oidc(&self) -> Option<&Token>

Returns the OIDC token, if present. Only available on validated token sets.

Trait Implementations

impl<S: Clone + ValidationState> Clone for TokenSet<S>

fn clone(&self) -> TokenSet<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug + ValidationState> Debug for TokenSet<S>

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TokenSet<Unvalidated>

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<S: ValidationState> Serialize for TokenSet<S>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.