Skip to main content

DesSaltState

Struct DesSaltState 

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

Caller-owned durable sender state for DES and 3DES privacy.

One value (or its clones) must be shared by every live sender using the same effective localized encryption-key/pre-IV domain. install requires an atomic create-if-absent lease for a new domain, while restart requires an atomic compare-and-set from the supplied previous epoch to the attempted epoch. Those contracts reject a second live process starting from the same durable state.

Implementations§

Source§

impl DesSaltState

Source

pub fn install<E, F>(persist: F) -> Result<Self, DesSaltStateError>
where E: Into<Box<dyn Error + Send + Sync + 'static>>, F: FnMut(&PersistedDesSaltState) -> Result<(), E>,

Install a new DES key domain, persisting boots epoch 1 before use.

The callback must atomically create the durable record only if it does not already exist. A competing installer for the same effective key domain must return an error rather than lease epoch 1 twice.

Source

pub fn restart<E, F>( previous: PersistedDesSaltState, persist: F, ) -> Result<Self, DesSaltStateError>
where E: Into<Box<dyn Error + Send + Sync + 'static>>, F: FnMut(&PersistedDesSaltState) -> Result<(), E>,

Atomically advance persisted state and create a fresh boots epoch.

The callback must compare-and-set durable state from previous to the supplied attempted state; a stale second live owner must return an error.

Source

pub fn engine_boots(&self) -> u32

Return the local generating-engine boots epoch used in DES salts.

Source

pub fn persisted_state(&self) -> PersistedDesSaltState

Return the durable record needed by a later process restart.

Source

pub fn reserve(&self) -> PrivacyResult<DesSaltReservation>

Irrevocably allocate the next salt in this boots epoch.

The reservation is burned even if later message encoding or encryption fails. It cannot be constructed or reused with a different epoch.

Trait Implementations§

Source§

impl Clone for DesSaltState

Source§

fn clone(&self) -> DesSaltState

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DesSaltState

Source§

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

Formats the value using the given formatter. Read more

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