Struct OAuth2Gate 

pub struct OAuth2Gate<R, G>
where
    R: AccessHierarchy + Eq + Display + Send + Sync + 'static,
    G: Eq + Clone + Send + Sync + 'static,
{ /* private fields */ }

Public builder for configuring OAuth2 routes and session issuance.

Implementations

impl<R, G> OAuth2Gate<R, G>

where R: AccessHierarchy + Eq + Display + Send + Sync + 'static, G: Eq + Clone + Send + Sync + 'static,

pub fn new() -> Self

Create a new, empty builder.

pub fn auth_url(self, url: impl Into<String>) -> Self

Set the authorization endpoint URL.

pub fn token_url(self, url: impl Into<String>) -> Self

Set the token endpoint URL.

pub fn client_id(self, id: impl Into<String>) -> Self

Set the OAuth2 client ID.

pub fn client_secret(self, secret: impl Into<String>) -> Self

Set the OAuth2 client secret (optional for public clients).

pub fn redirect_url(self, url: impl Into<String>) -> Self

Set the redirect URL that your provider will call after user authorization.

pub fn add_scope(self, scope: impl Into<String>) -> Self

Add a scope to request from the provider.

pub fn with_cookie_names( self, state_cookie: impl Into<String>, pkce_cookie: impl Into<String>, ) -> Self

Set custom cookie names for state/PKCE (primarily for multi-provider setups).

This also updates the underlying cookie templates to use the provided names.

pub fn with_state_cookie_template(self, template: CookieTemplate) -> Self

Configure the state cookie template directly.

pub fn configure_state_cookie_template<F>(self, f: F) -> OAuth2Result<Self>

where F: FnOnce(CookieTemplate) -> CookieTemplate,

Convenience to configure the state cookie template via the high-level builder.

pub fn with_pkce_cookie_template(self, template: CookieTemplate) -> Self

Configure the PKCE cookie template directly.

pub fn configure_pkce_cookie_template<F>(self, f: F) -> OAuth2Result<Self>

where F: FnOnce(CookieTemplate) -> CookieTemplate,

Convenience to configure the PKCE cookie template via the high-level builder.

pub fn with_cookie_template(self, template: CookieTemplate) -> Self

Configure the auth cookie template used to store the first-party JWT.

pub fn configure_cookie_template<F>(self, f: F) -> OAuth2Result<Self>

where F: FnOnce(CookieTemplate) -> CookieTemplate,

Convenience to configure the auth cookie template via the high-level builder.

pub fn with_post_login_redirect(self, url: impl Into<String>) -> Self

Configure a post-login redirect URL (e.g., “/”).

pub fn with_account_mapper<F>(self, f: F) -> Self

where for<'a> F: Send + Sync + 'static + Fn(&'a StandardTokenResponse<EmptyExtraTokenFields, BasicTokenType>) -> Pin<Box<dyn Future<Output = OAuth2Result<Account<R, G>>> + Send + 'a>>,

Provide an async account mapper that converts the token response to an Account<R, G>.

This allows performing async I/O (e.g., calling a provider user info endpoint) without blocking.

pub fn with_account_inserter<F, Fut>(self, f: F) -> Self

where F: Fn(Account<R, G>) -> Fut + Send + Sync + 'static, Fut: Future<Output = OAuth2Result<Account<R, G>>> + Send + 'static,

Provide an async account inserter that persists or loads an account before JWT issuance.

The closure is called after mapping the provider token to an Account and before encoding the JWT. It should return the persisted or loaded Account (with a stable account_id).

pub fn with_account_repository<AccRepo>( self, account_repository: Arc<AccRepo>, ) -> Self

where AccRepo: AccountRepository<R, G> + Send + Sync + 'static,

Convenience: insert into an AccountRepository on first login (idempotent).

Queries by user_id; if missing, stores the provided account. Returns the existing or stored account.

pub fn with_jwt_codec<C>( self, issuer: &str, codec: Arc<C>, ttl_secs: u64, ) -> Self

where C: Codec<Payload = JwtClaims<Account<R, G>>> + Send + Sync + 'static,

Provide a JWT codec and issuer; sets up a type-erased encoder closure.

This helper uses your provided codec to mint a first-party session JWT from an Account<R, G>. The ttl_secs here sets expiry and overrides with_jwt_ttl_secs.

pub fn routes(&self, base_path: &str) -> OAuth2Result<Router<()>>

Build and return an axum Router with /login and /callback routes nested under base_path.

Example:

• base_path: “/auth” → routes are “/auth/login” and “/auth/callback”

Trait Implementations

impl<R, G> Clone for OAuth2Gate<R, G>

where R: AccessHierarchy + Eq + Display + Send + Sync + 'static + Clone, G: Eq + Clone + Send + Sync + 'static + Clone,

fn clone(&self) -> OAuth2Gate<R, G>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<R, G> Debug for OAuth2Gate<R, G>

where R: AccessHierarchy + Eq + Display + Send + Sync + 'static, G: Eq + Clone + Send + Sync + 'static,

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

Formats the value using the given formatter.

impl<R, G> Default for OAuth2Gate<R, G>

where R: AccessHierarchy + Eq + Display + Send + Sync + 'static, G: Eq + Clone + Send + Sync + 'static,

fn default() -> Self

Returns the “default value” for a type.