Struct TokenMetadataBuilder 

pub struct TokenMetadataBuilder { /* private fields */ }

Fluent builder for TokenMetadata.

Implementations

impl TokenMetadataBuilder

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

Set the IP address that issued the token.

Example

use auth_framework::tokens::TokenMetadata;

let meta = TokenMetadata::builder().issued_ip("10.0.0.1").build();
assert_eq!(meta.issued_ip.as_deref(), Some("10.0.0.1"));

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

Set the user-agent string of the issuing client.

Example

use auth_framework::tokens::TokenMetadata;

let meta = TokenMetadata::builder().user_agent("curl/8.0").build();
assert_eq!(meta.user_agent.as_deref(), Some("curl/8.0"));

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

Set the device identifier.

Example

use auth_framework::tokens::TokenMetadata;

let meta = TokenMetadata::builder().device_id("phone-123").build();
assert_eq!(meta.device_id.as_deref(), Some("phone-123"));

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

Set the associated session identifier.

Example

use auth_framework::tokens::TokenMetadata;

let meta = TokenMetadata::builder().session_id("sess-abc").build();
assert_eq!(meta.session_id.as_deref(), Some("sess-abc"));

pub fn custom(self, key: impl Into<String>, value: Value) -> Self

Insert a custom metadata entry.

Example

use auth_framework::tokens::TokenMetadata;

let meta = TokenMetadata::builder()
    .custom("region", serde_json::json!("us-east-1"))
    .build();
assert_eq!(meta.custom.get("region").unwrap(), "us-east-1");

pub fn build(self) -> TokenMetadata

Consume the builder and return the finished TokenMetadata.

Example

use auth_framework::tokens::TokenMetadata;

let meta = TokenMetadata::builder()
    .issued_ip("127.0.0.1")
    .user_agent("test-client")
    .build();
assert!(!meta.revoked);

Trait Implementations

impl Clone for TokenMetadataBuilder

fn clone(&self) -> TokenMetadataBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenMetadataBuilder

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

Formats the value using the given formatter.

impl Default for TokenMetadataBuilder

fn default() -> TokenMetadataBuilder

Returns the “default value” for a type.