Struct jwt_compact::prelude::Claims

#[non_exhaustive]
pub struct Claims<T> {
    pub expiration: Option<DateTime<Utc>>,
    pub not_before: Option<DateTime<Utc>>,
    pub issued_at: Option<DateTime<Utc>>,
    pub custom: T,
}

Claims encoded in a token.

Claims are comprised of a “standard” part (exp, nbf and iat claims as per JWT spec), and custom fields. iss, sub and aud claims are not in the standard part due to a variety of data types they can be reasonably represented by.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct {{ .. }} syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

expiration: Option<DateTime<Utc>>

Expiration time of the token.

not_before: Option<DateTime<Utc>>

Minimum time at which token is valid.

issued_at: Option<DateTime<Utc>>

Time of token issuance.

custom: T

Custom claims.

Implementations

impl Claims<Empty>

pub fn empty() -> Self

Creates an empty claims instance.

impl<T> Claims<T>

pub fn new(custom_claims: T) -> Self

Creates a new instance with the provided custom claims.

pub fn set_duration<F>(
    self,
    options: &TimeOptions<F>,
    duration: Duration
) -> Self where
    F: Fn() -> DateTime<Utc>, 

Sets the expiration claim so that the token has the specified duration. The current timestamp is taken from options.

pub fn set_duration_and_issuance<F>(
    self,
    options: &TimeOptions<F>,
    duration: Duration
) -> Self where
    F: Fn() -> DateTime<Utc>, 

Atomically sets issued_at and expiration claims: first to the current time (taken from options), and the second to match the specified duration of the token.

pub fn set_not_before(self, moment: DateTime<Utc>) -> Self

Sets the nbf claim.

pub fn validate_expiration<F>(
    &self,
    options: &TimeOptions<F>
) -> Result<&Self, ValidationError> where
    F: Fn() -> DateTime<Utc>, 

Validates the expiration claim.

This method will return an error if the claims do not feature an expiration time, or if it is in the past (subject to the provided options).

pub fn validate_maturity<F>(
    &self,
    options: &TimeOptions<F>
) -> Result<&Self, ValidationError> where
    F: Fn() -> DateTime<Utc>, 

Validates the maturity time (nbf claim).

This method will return an error if the claims do not feature a maturity time, or if it is in the future (subject to the provided options).

Trait Implementations

impl<T: Clone> Clone for Claims<T>

fn clone(&self) -> Claims<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Claims<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Claims<T> where
    T: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T: PartialEq> PartialEq<Claims<T>> for Claims<T>

fn eq(&self, other: &Claims<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Claims<T>) -> bool

This method tests for !=.

impl<T> Serialize for Claims<T> where
    T: Serialize, 

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

Serialize this value into the given Serde serializer.

impl<T> StructuralPartialEq for Claims<T>