Struct AuthTokenBuilder 

pub struct AuthTokenBuilder { /* private fields */ }

Builder for creating AuthToken instances with fluent API.

Reduces cognitive load when constructing tokens with many optional fields. Required fields are set in new(), optional fields via builder methods.

Example

use auth_framework::tokens::{AuthToken, TokenMetadata};
use auth_framework::types::{Scopes, Permissions, Roles};
use chrono::{Utc, Duration};

let token = AuthToken::builder("user123", "token456", "access_token_here")
    .scopes(Scopes::new(vec!["read".to_string(), "write".to_string()]))
    .permissions(Permissions::new(vec!["admin".to_string()]))
    .roles(Roles::new(vec!["user".to_string()]))
    .expires_at(Utc::now() + Duration::hours(1))
    .client_id("client123")
    .build();

Implementations

impl AuthTokenBuilder

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

Create a new builder with required fields.

Sets sensible defaults for optional fields:

• issued_at: current time
• expires_at: 1 hour from now
• scopes, permissions, roles: empty collections
• auth_method: “unknown”
• metadata: default (empty)

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

Set the token type (e.g., “bearer”).

Example

use auth_framework::tokens::AuthToken;

let token = AuthToken::builder("t1", "u1", "access")
    .token_type("bearer")
    .build();
assert_eq!(token.token_type.as_deref(), Some("bearer"));

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

Set the subject claim.

Example

use auth_framework::tokens::AuthToken;

let token = AuthToken::builder("t1", "u1", "access")
    .subject("user@example.com")
    .build();
assert_eq!(token.subject.as_deref(), Some("user@example.com"));

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

Set the token issuer.

Example

use auth_framework::tokens::AuthToken;

let token = AuthToken::builder("t1", "u1", "access")
    .issuer("auth.example.com")
    .build();
assert_eq!(token.issuer.as_deref(), Some("auth.example.com"));

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

Set the refresh token.

Example

use auth_framework::tokens::AuthToken;

let token = AuthToken::builder("t1", "u1", "access")
    .refresh_token("refresh_token_value")
    .build();
assert!(token.refresh_token.is_some());

pub fn issued_at(self, issued_at: DateTime<Utc>) -> Self

Set the issued timestamp.

Example

use auth_framework::tokens::AuthToken;
use chrono::Utc;

let now = Utc::now();
let token = AuthToken::builder("t1", "u1", "access")
    .issued_at(now)
    .build();
assert_eq!(token.issued_at, now);

pub fn expires_at(self, expires_at: DateTime<Utc>) -> Self

Set the expiration timestamp.

Example

use auth_framework::tokens::AuthToken;
use chrono::{Utc, Duration};

let expires = Utc::now() + Duration::hours(2);
let token = AuthToken::builder("t1", "u1", "access")
    .expires_at(expires)
    .build();

pub fn scopes(self, scopes: Scopes) -> Self

Set the granted scopes.

Example

use auth_framework::tokens::AuthToken;
use auth_framework::types::Scopes;

let token = AuthToken::builder("t1", "u1", "access")
    .scopes(Scopes::new(vec!["read".into(), "write".into()]))
    .build();

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

Set the authentication method.

Example

use auth_framework::tokens::AuthToken;

let token = AuthToken::builder("t1", "u1", "access")
    .auth_method("password")
    .build();
assert_eq!(token.auth_method, "password");

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

Set the client ID.

Example

use auth_framework::tokens::AuthToken;

let token = AuthToken::builder("t1", "u1", "access")
    .client_id("client-app")
    .build();
assert_eq!(token.client_id.as_deref(), Some("client-app"));

pub fn user_profile(self, user_profile: ProviderProfile) -> Self

Set the user profile.

Example

use auth_framework::tokens::AuthToken;
use auth_framework::providers::ProviderProfile;

let profile = ProviderProfile { /* ... */ };
let token = AuthToken::builder("t1", "u1", "access")
    .user_profile(profile)
    .build();

pub fn permissions(self, permissions: Permissions) -> Self

Set the user permissions.

Example

use auth_framework::tokens::AuthToken;
use auth_framework::types::Permissions;

let token = AuthToken::builder("t1", "u1", "access")
    .permissions(Permissions::new(vec!["admin".into()]))
    .build();

pub fn roles(self, roles: Roles) -> Self

Set the user roles.

Example

use auth_framework::tokens::AuthToken;
use auth_framework::types::Roles;

let token = AuthToken::builder("t1", "u1", "access")
    .roles(Roles::new(vec!["editor".into()]))
    .build();

pub fn metadata(self, metadata: TokenMetadata) -> Self

Set the token metadata.

Example

use auth_framework::tokens::{AuthToken, TokenMetadata};

let meta = TokenMetadata::builder().issued_ip("10.0.0.1").build();
let token = AuthToken::builder("t1", "u1", "access")
    .metadata(meta)
    .build();

pub fn build(self) -> AuthToken

Build the AuthToken instance.

Example

use auth_framework::tokens::AuthToken;

let token = AuthToken::builder("t1", "u1", "access").build();
assert_eq!(token.user_id, "u1");

Trait Implementations

impl Clone for AuthTokenBuilder

fn clone(&self) -> AuthTokenBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthTokenBuilder

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

Formats the value using the given formatter.