Struct Claims 

#[non_exhaustive]
pub struct Claims { /* private fields */ }

JWT claims structure.

Fields are intentionally crate-private. Construct via Claims::builder and read via the accessor methods. The custom map is gated by Claims::get_claim / Claims::sanitized_custom so reserved JWT claim names (iss, aud, nbf, jti, …) can never be retrieved as custom data, even when serde’s #[serde(flatten)] lets them in.

Implementations

impl Claims

pub fn sub(&self) -> &str

Get the subject (raw sub claim).

pub fn iat(&self) -> i64

Get the issued-at Unix timestamp.

pub fn exp(&self) -> i64

Get the expiration Unix timestamp.

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

Get the audience (aud claim), if set.

pub fn roles(&self) -> &[String]

Get the user roles.

pub fn into_roles(self) -> Vec<String>

Consume the claims and return the owned roles vector.

pub fn into_sub(self) -> String

Consume the claims and return the owned subject string.

pub fn user_id(&self) -> Option<Uuid>

Get the user ID as UUID.

pub fn is_expired(&self) -> bool

Check if the token is expired.

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

Check if the user has a role.

pub fn get_claim(&self, key: &str) -> Option<&Value>

Get a custom claim value.

Returns None for reserved JWT claims (iss, aud, nbf, jti, etc.) to prevent claim injection via #[serde(flatten)].

pub fn sanitized_custom(&self) -> HashMap<String, Value>

Get custom claims with reserved JWT claims filtered out.

Prevents claim injection where standard JWT claims like iss, aud, or jti end up in the custom claims map via #[serde(flatten)].

pub fn tenant_id(&self) -> Option<Uuid>

Get the tenant ID if present in claims.

pub fn builder() -> ClaimsBuilder

Create a builder for constructing claims.

Trait Implementations

impl Clone for Claims

fn clone(&self) -> Claims

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Claims

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Claims

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Claims

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

where __S: Serializer,

Serialize this value into the given Serde serializer.