Struct Claims

pub struct Claims {
    pub iat: u64,
    pub exp: Option<u64>,
}

Available on crate feature jwt only.

Claims in JWT are used to represent a set of information about an entity.

Claims are essentially key-value pairs that are encoded as JSON objects and included in the payload of a JWT. They are used to transmit information such as the identity of the entity, the time the JWT was issued, and the expiration time of the JWT, among others.

The Engine API spec requires that just the iat (issued-at) claim is provided. It ignores claims that are optional or additional for this specification.

Fields

iat: u64

The “iat” value MUST be a number containing a NumericDate value. According to the RFC A NumericDate represents the number of seconds since the UNIX_EPOCH.

• RFC-7519 - Spec
• RFC-7519 - Notations

exp: Option<u64>

The “exp” (expiration time) claim identifies the expiration time on or after which the JWT MUST NOT be accepted for processing.

Implementations

impl Claims

pub fn with_current_timestamp() -> Self

Creates a new instance of Claims with the current timestamp as the iat claim.

pub fn is_within_time_window(&self) -> bool

Checks if the iat claim is within the allowed range from the current time.

Trait Implementations

impl Clone for Claims

fn clone(&self) -> Claims

Returns a copy 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 Default for Claims

fn default() -> Self

By default, the iat claim is set to the current timestamp.

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.

impl Copy for Claims