Struct NumericDate

pub struct NumericDate(/* private fields */);

Represents NumericDate (see https://datatracker.ietf.org/doc/html/rfc7519#section-2) where the range is restricted to those in which microseconds can be exactly represented, which is approximately between the years 1685 and 2255, which was considered to be sufficient for the purposes of this crate. Note that leap seconds are ignored by this type, just as they’re ignored by NumericDate in the JWT standard.

An f64 value has 52 explicit mantissa bits, meaning that the biggest contiguous range of integer values is from -2^53 to 2^53 (52 zeros after the mantissa’s implicit 1). Using this value to represent exact microseconds gives a maximum range of +-2^53 / (1000000 * 60 * 60 * 24 * 365.25) ~= +-285, which is centered around the Unix epoch start date Jan 1, 1970, 00:00:00 UTC, giving the years 1685 to 2255.

Implementations

impl NumericDate

pub const MIN: NumericDate

This is -2^53 / 1_000_000, which is the smallest NumericDate that faithfully represents full microsecond precision.

pub const MAX: NumericDate

This is 2^53 / 1_000_000, which is the largest NumericDate that faithfully represents full microsecond precision.

pub fn as_seconds(self) -> f64

Return the f64-valued number of seconds represented by this NumericDate.

pub fn try_from_seconds( seconds: f64, ) -> Result<Self, NumericDateConversionError>

Try to create NumericDate from a f64 value, returning error upon out-of-range.

Trait Implementations

impl Add<TimeDelta> for NumericDate

Note that this will panic if the addition goes out-of-range.

type Output = NumericDate

The resulting type after applying the + operator.

fn add(self, rhs: Duration) -> Self::Output

Performs the + operation.

impl Clone for NumericDate

fn clone(&self) -> NumericDate

Returns a copy 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<'de> Deserialize<'de> for NumericDate

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<NumericDate> for DateTime<Utc>

fn from(nd: NumericDate) -> Self

Converts to this type from the input type.

impl From<NumericDate> for LocalResult<DateTime<Utc>>

fn from(nd: NumericDate) -> Self

Converts to this type from the input type.

impl From<i32> for NumericDate

fn from(value: i32) -> Self

Converts to this type from the input type.

impl FromStr for NumericDate

type Err = NumericDateConversionError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for NumericDate

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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 Sub<TimeDelta> for NumericDate

Note that this will panic if the addition goes out-of-range.

type Output = NumericDate

The resulting type after applying the - operator.

fn sub(self, rhs: Duration) -> Self::Output

Performs the - operation.

impl Sub for NumericDate

Note that this will panic if the addition goes out-of-range.

type Output = TimeDelta

The resulting type after applying the - operator.

fn sub(self, rhs: NumericDate) -> Self::Output

Performs the - operation.

impl TryFrom<DateTime<FixedOffset>> for NumericDate

type Error = NumericDateConversionError

The type returned in the event of a conversion error.

fn try_from(dtfo: DateTime<FixedOffset>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<DateTime<Utc>> for NumericDate

type Error = NumericDateConversionError

The type returned in the event of a conversion error.

fn try_from(dtu: DateTime<Utc>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<f64> for NumericDate

type Error = NumericDateConversionError

The type returned in the event of a conversion error.

fn try_from(value: f64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i64> for NumericDate

type Error = NumericDateConversionError

The type returned in the event of a conversion error.

fn try_from(value: i64) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for NumericDate

impl Eq for NumericDate

impl StructuralPartialEq for NumericDate