Struct NumericDate 

pub struct NumericDate {
    timestamp: u64,
}

Represents the value of the iat, exp, nbf claims.

According to RFC7519, it should be:

“A JSON numeric value representing the number of seconds from 1970-01-01T00:00:00Z UTC until the specified UTC date/time, ignoring leap seconds. This is equivalent to the IEEE Std 1003.1, 2013 Edition [POSIX.1] definition “Seconds Since the Epoch”, in which each day is accounted for by exactly 86400 seconds, other than that non-integer values can be represented.“

But contrary to this, we reject negative timestamps — and timestamps beyond the invariant upper bound below (the last second of year 9999) — with an error, and silently round down non-negative decimals to the nearest u64.

Invariant

timestamp <= MAX_TIMESTAMP_SECS, the last second of year 9999 and the largest instant representable in RFC3339. Construction and arithmetic go through new_clamp, add_clamp and sub_clamp, which saturate into range; the Deserialize and TryFrom<SystemTime> impls instead reject an out-of-range value with an error.

The bound is a safety property, not just tidiness. The exp/nbf/iat claims are attacker-controlled, and a value near u64::MAX overflows std::time::SystemTime — whose addition panics above i64::MAX seconds — the moment the date is formatted into a log or error message (e.g. the “not yet valid” message built from a bogus far-future nbf). Staying in range also keeps humantime rendering the year correctly. Because the invariant holds, the From<&NumericDate> for SystemTime conversion is total and lossless, so serializing and then deserializing a NumericDate round-trips faithfully.

The range operations are named (*_clamp) rather than +/-/new so the saturating behaviour is explicit at the call site and never silently surprises the reader.

Fields

timestamp: u64

Implementations

impl NumericDate

pub fn new_clamp(timestamp: u64) -> Self

Creates a numeric date from timestamp, the number of seconds since the unix epoch (ignoring leap seconds), saturating at MAX_TIMESTAMP_SECS to uphold the invariant.

pub fn add_clamp(self, secs: u64) -> Self

Adds secs seconds, saturating at MAX_TIMESTAMP_SECS.

pub fn sub_clamp(self, secs: u64) -> Self

Subtracts secs seconds, saturating at zero.

pub fn now() -> Self

Creates a numeric date representing the current moment

pub fn timestamp(&self) -> u64

Returns the number of seconds this date is after the unix epoch.

pub fn date(&self) -> String

Returns the UTC date for this timestamp

Trait Implementations

impl Clone for NumericDate

fn clone(&self) -> NumericDate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NumericDate

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

Formats the value using the given formatter.

impl Default for NumericDate

fn default() -> NumericDate

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NumericDate

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for NumericDate

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

Formats the value using the given formatter.

impl From<&NumericDate> for SystemTime

fn from(nd: &NumericDate) -> Self

Converts to this type from the input type.

impl From<NumericDate> for Epoch

fn from(nd: NumericDate) -> Self

Converts to this type from the input type.

impl Ord for NumericDate

fn cmp(&self, other: &NumericDate) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for NumericDate

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for NumericDate

fn partial_cmp(&self, other: &NumericDate) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for NumericDate

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<SystemTime> for NumericDate

fn try_from(st: SystemTime) -> Result<Self, Self::Error>

Fallible (not From with a clamp) so a far-future SystemTime can never be silently rewritten — even if a future caller feeds in a time that isn’t the (sane) system clock.

type Error = OutOfRange

The type returned in the event of a conversion error.

impl Copy for NumericDate

impl Eq for NumericDate

impl StructuralPartialEq for NumericDate