Skip to main content

TimelockBuilder

Struct TimelockBuilder 

Source
pub struct TimelockBuilder { /* private fields */ }
Expand description

Fluent builder for [timelock] / timelock_async key derivation.

Provides a readable alternative to the 7-positional-argument timelock() function. Create a builder via TimelockBuilder::encrypt (encryption path, _at) or TimelockBuilder::decrypt (decryption path, _now), optionally configure it with setter methods, then call derive or derive_async.

§Encryption (key-at path)

All of time, salts, and kdf are required. cadence, precision, and format are optional and fall back to sensible defaults:

let salts = TimeLockSalts::generate();
let kdf   = KdfPreset::Balanced.params();

let key = TimelockBuilder::encrypt()
    .time(TimeLockTime::new(14, 37).unwrap())
    .salts(salts)
    .kdf(kdf)
    .derive()
    .unwrap();

§Decryption (key-now path)

Pass the TimeLockParams header stored in the ciphertext. No other configuration is required; all settings are read from params.

let key = TimelockBuilder::decrypt(header).derive().unwrap();

Implementations§

Source§

impl TimelockBuilder

Source

pub fn encrypt() -> Self

Begin configuring an encryption (key-at) derivation.

Requires enc-timelock-keygen-input (or async variant) to call derive / derive_async.

Source

pub fn decrypt(params: TimeLockParams) -> Self

Begin configuring a decryption (key-now) derivation from a stored header.

Requires enc-timelock-keygen-now (or async variant) to call derive / derive_async.

Source

pub fn cadence(self, cadence: TimeLockCadence) -> Self

Set the calendar cadence (default: TimeLockCadence::None).

Source

pub fn time(self, time: TimeLockTime) -> Self

Set the explicit lock time (required for the encryption path).

Source

pub fn precision(self, precision: TimePrecision) -> Self

Set the time precision (default: TimePrecision::Minute).

Source

pub fn format(self, format: TimeFormat) -> Self

Set the clock format (default: TimeFormat::Hour24).

Source

pub fn salts(self, salts: TimeLockSalts) -> Self

Set the KDF salts (required for the encryption path).

Source

pub fn kdf(self, kdf: KdfParams) -> Self

Set the KDF parameters (required for the encryption path).

Source

pub fn derive(self) -> Result<TimeLockKey, TimeLockError>

Derive the key synchronously.

Delegates directly to [timelock].

Source

pub async fn derive_async(self) -> Result<TimeLockKey, TimeLockError>

Derive the key asynchronously.

Delegates directly to timelock_async. The blocking KDF work is offloaded to a Tokio blocking thread.

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> 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, 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