Struct TokenClaims 

pub struct TokenClaims {
    pub subject: String,
    pub roles: Vec<String>,
    pub permissions: Vec<String>,
    pub extra: BTreeMap<String, String>,
    pub expires_in: Option<Duration>,
}

Claims a caller hands to an ITokenIssuer.

Values are deliberately plain (String / Vec<String>) so the issuer does not need to know the application’s claim structs. Anything that is not a first-class field — tenant_id, name, email, custom scopes — goes into TokenClaims::extra and is embedded verbatim.

Fields

subject: String

Subject (sub) — the stable user identifier. Required.

roles: Vec<String>

Roles to embed (roles claim).

permissions: Vec<String>

Fine-grained permissions to embed (permissions claim).

extra: BTreeMap<String, String>

Additional string claims, embedded verbatim (e.g. tenant_id).

The issuer owns sub / jti / exp / iat: a key collision in extra must not be able to override those.

expires_in: Option<Duration>

Requested lifetime. None means the issuer’s configured default.

Implementations

impl TokenClaims

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

Claims for subject with no roles, permissions or extra claims.

pub fn with_roles<I, S>(self, roles: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Set the roles claim.

pub fn with_permissions<I, S>(self, permissions: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Set the permissions claim.

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

Add one extra string claim.

pub fn expires_in(self, lifetime: Duration) -> Self

Override the issuer’s default lifetime.

Trait Implementations

impl Clone for TokenClaims

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenClaims

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

Formats the value using the given formatter.

impl Default for TokenClaims

fn default() -> Self

Returns the “default value” for a type.

impl Eq for TokenClaims

impl PartialEq for TokenClaims

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for TokenClaims