Struct Identity 

pub struct Identity { /* private fields */ }

The authenticated caller of the current request: an object (a type and an id) — never a set like group:eng#member.

Implementations

impl Identity

pub fn new(subject: impl AsRef<str>, source: &'static str) -> Identity

A caller you name in code: "service:billing" (a type, :, an id) or a bare id, which gets the type user. source says who vouched ("jwt", "oidc", "saml", "basic", "forward", "mcp", or your own). For a value that came from outside, use Identity::user.

pub fn user(id: &str, source: &'static str) -> Option<Identity>

The user whose id is id exactly — what authenticators use for a value from a token, a header or a login. A : stays part of the id (user:a:b). None when id can’t name an object: empty, over 256 characters, or holding #, @, a space or a control character — so a token whose sub is group:eng#member can’t pass as that group.

pub fn with_claims(self, claims: impl AsRef<str>) -> Identity

The same, carrying the token’s or assertion’s claims (a JSON object).

pub fn from_claims( claims: &str, claim: &str, source: &'static str, ) -> Option<Identity>

An identity from a JSON claims object: its claim ("sub" usually) as the subject id. None when the claim is missing or not a string.

pub fn current() -> Option<Identity>

The caller of the request being served on this thread or task.

pub fn subject(&self) -> &str

type:id, e.g. user:alice.

pub fn subject_type(&self) -> &str

The type part of the subject (user).

pub fn subject_id(&self) -> &str

The id part of the subject (alice).

pub fn as_subject(&self) -> Subject

The caller as a tuple subject: an object, never a set.

pub fn source(&self) -> &'static str

Which authenticator vouched for it.

pub fn claims(&self) -> Option<&str>

The raw claims JSON, when the authenticator had any.

pub fn claim(&self, name: &str) -> Option<String>

One claim as a string (top-level members only).

Trait Implementations

impl Clone for Identity

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 Identity

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

Formats the value using the given formatter.

impl Eq for Identity

impl PartialEq for Identity

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Identity