Skip to main content

TimeLockCadence

Enum TimeLockCadence 

Source
pub enum TimeLockCadence {
    None,
    DayOfWeek(Weekday),
    DayOfMonth(u8),
    MonthOfYear(Month),
    DayOfWeekInMonth(Weekday, Month),
    DayOfMonthInMonth(u8, Month),
    DayOfWeekAndDayOfMonth(Weekday, u8),
}
Expand description

Cadence component of a scheduled time-lock — binds key derivation to a recurring calendar pattern in addition to the time-of-day constraint.

Pair with a TimeLockTime (encryption path) to express policies like:

  • “only on Tuesdays at 18:00”DayOfWeek(Weekday::Tuesday) + 18h
  • “only on the 1st at 00:00”DayOfMonth(1) + 0h
  • “every Tuesday in February at 06:00”DayOfWeekInMonth(Weekday::Tuesday, Month::February) + 6h

On the decryption side, pass pack the cadence (along with precision and format) to obtain a TimeLockParams to store in the ciphertext header, then call [derive_key_scheduled_now] with those params.

TimeLockCadence::None is equivalent to a plain [derive_key_at] call — no calendar dimension is mixed into the KDF input.

§Panics

Constructing DayOfMonthInMonth is always valid, but key derivation panics if the stored day exceeds the month’s maximum (e.g. day 29 for February, day 31 for April).

Variants§

§

None

No calendar constraint — behaves like a plain time-lock.

Compact discriminant: 0.

§

DayOfWeek(Weekday)

Valid only on the specified weekday.

Compact discriminant: 1.

§

DayOfMonth(u8)

Valid only on the specified day of any month (1–31).

Days 29–31 simply never match in shorter months.

Compact discriminant: 2.

§

MonthOfYear(Month)

Valid only during the specified month of any year.

Compact discriminant: 3.

§

DayOfWeekInMonth(Weekday, Month)

Valid only on the specified weekday and during the specified month.

Compact discriminant: 4.

§

DayOfMonthInMonth(u8, Month)

Valid only on the specified day of the specified month.

Key derivation panics if the day exceeds the month’s maximum.

Compact discriminant: 5.

§

DayOfWeekAndDayOfMonth(Weekday, u8)

Valid only on the specified weekday and the specified day of month.

Days 29–31 do not match in shorter months.

Compact discriminant: 6.

Implementations§

Source§

impl TimeLockCadence

Source

pub fn variant_id(self) -> u8

Returns the compact variant discriminant stored in TimeLockParams::cadence_variant.

Trait Implementations§

Source§

impl Clone for TimeLockCadence

Source§

fn clone(&self) -> TimeLockCadence

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TimeLockCadence

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for TimeLockCadence

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Copy for TimeLockCadence

Source§

impl Eq for TimeLockCadence

Source§

impl StructuralPartialEq for TimeLockCadence

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more