Struct AuthIdentity 

pub struct AuthIdentity {
    pub subject: String,
    pub roles: Vec<String>,
    pub claims: BTreeMap<String, Value>,
}

Authentication Identity

Represents an authenticated user’s identity within the NestForge framework. Contains the subject (typically user ID), roles, and additional custom claims.

Fields

• subject: The unique identifier for the user (e.g., user ID, email)
• roles: List of role names the user possesses
• claims: Additional key-value pairs for custom authentication data

Usage

This type is automatically populated by the framework’s authentication middleware and can be accessed in handlers via the AuthUser extractor.

Fields

subject: String

roles: Vec<String>

claims: BTreeMap<String, Value>

Implementations

impl AuthIdentity

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

Creates a new authentication identity.

Arguments

• subject: The unique identifier for the user

Example

let identity = AuthIdentity::new("user-123");

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

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

Adds roles to the authentication identity.

Arguments

• roles: An iterator of role names to assign

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

Adds a custom claim to the authentication identity.

Arguments

• key: The claim key
• value: The claim value

pub fn has_role(&self, role: &str) -> bool

Checks if the identity has a specific role.

Arguments

• role: The role name to check

Returns true if the role is present in the identity’s roles.

pub fn require_role(&self, role: &str) -> Result<(), HttpException>

Requires a specific role, returning an error if not present.

Arguments

• role: The required role name

Returns Ok if the role is present, or a forbidden HttpException if not.

Trait Implementations

impl Clone for AuthIdentity

fn clone(&self) -> AuthIdentity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthIdentity

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

Formats the value using the given formatter.

impl Default for AuthIdentity

fn default() -> AuthIdentity

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AuthIdentity

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AuthIdentity

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.