Struct jwt_compact::prelude::TimeOptions

#[non_exhaustive]
pub struct TimeOptions<F = fn() -> DateTime<Utc>> {
    pub leeway: Duration,
    pub clock_fn: F,
}

Time-related options for token creation and validation.

If the clock crate feature is on (and it’s on by default), TimeOptions can be created using the Default impl or Self::from_leeway(). If the feature is off, you can still create options using a generic constructor.

Examples

// Default options.
let default_options = TimeOptions::default();
let options_with_custom_leeway =
    TimeOptions::from_leeway(Duration::seconds(5));
// Options that have a fixed time. Can be useful for testing.
let clock_time = Utc::now();
let options_with_stopped_clock =
    TimeOptions::new(Duration::seconds(10), move || clock_time);

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.

leeway: Duration

Leeway to use during validation.

clock_fn: F

Source of the current timestamps.

Implementations

impl<F: Fn() -> DateTime<Utc>> TimeOptions<F>

pub fn new(leeway: Duration, clock_fn: F) -> Self

Creates options based on the specified time leeway and clock function.

impl TimeOptions

pub fn from_leeway(leeway: Duration) -> Self

This is supported on crate feature clock only.

Creates options based on the specified time leeway. The clock source is Utc::now().

Trait Implementations

impl<F: Clone> Clone for TimeOptions<F>

fn clone(&self) -> TimeOptions<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for TimeOptions<F>

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

Formats the value using the given formatter.

impl Default for TimeOptions

Creates options with a default leeway (60 seconds) and the Utc::now() clock.

This impl is supported on crate feature clock only.

fn default() -> Self

Returns the “default value” for a type.

impl<F: Copy> Copy for TimeOptions<F>