Struct OAuth2Config 

pub struct OAuth2Config { /* private fields */ }

Available on crate feature oauth2 only.

OAuth2 authentication configuration.

Use OAuth2ConfigBuilder to create instances.

Implementations

impl OAuth2Config

pub fn client_credentials( client_id: impl Into<String>, client_secret: impl Into<SecureString>, token_url: impl AsRef<str>, ) -> Result<OAuth2ConfigBuilder, OAuth2Error>

Creates a builder for client credentials flow.

pub fn pre_acquired( client_id: impl Into<String>, token_url: impl AsRef<str>, access_token: impl Into<String>, ) -> Result<OAuth2ConfigBuilder, OAuth2Error>

Creates a builder for a pre-acquired token.

pub async fn needs_token(&self) -> bool

Checks if a new token should be acquired.

pub async fn get_token(&self) -> Option<OAuth2Token>

Gets the cached token if available and not expired.

pub async fn set_token(&self, token: OAuth2Token)

Stores a token in the cache.

impl OAuth2Config

pub async fn acquire_token(&self) -> Result<OAuth2Token, OAuth2Error>

Acquires a new access token using the configured grant type.

This method handles:

• Client Credentials grant: fetches a new token from the token endpoint
• Pre-Acquired token: returns the cached token if available

Errors

Returns an error if:

• Network request fails
• Token endpoint returns an error
• Response cannot be parsed

pub async fn get_valid_token(&self) -> Result<OAuth2Token, OAuth2Error>

Gets a valid token, acquiring a new one if necessary.

This is the main entry point for getting an access token. It checks the cache first and only acquires a new token if needed.

Trait Implementations

impl Clone for OAuth2Config

fn clone(&self) -> OAuth2Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OAuth2Config

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

Formats the value using the given formatter.