Skip to main content

KeySession

Struct KeySession 

Source
pub struct KeySession<T: KeyMaterial> { /* private fields */ }
Expand description

Held keys and the capability that saves them, released together on close. Consumers read memory; only opening calls the configured custody’s unlock. Share this owner across every worker using the same custody.

Implementations§

Source§

impl<T: KeyMaterial> KeySession<T>

Source

pub fn open(custody: Arc<dyn Custody<T>>) -> Result<Self, KeyError>

Unlock custody once at the opening composition root.

Source

pub fn read(&self) -> Result<Option<T>, KeyError>

Read an independent copy of the held material without custody IO.

Source

pub fn persist(&self, keys: &T) -> Result<(), KeyError>

Save changed keys before installing them in the shared session. A failed save leaves the held material unchanged and reaches the caller.

Source

pub fn forget(&self) -> Result<(), KeyError>

Remove persisted keys before erasing the session’s copy. A failed removal retains the held keys. The persistence capability lasts until close, so acquiring keys again does not require another passphrase derivation.

Source

pub fn close(&self)

Erase the held material and close custody after its users finish. Also happens when the last session owner is dropped. Performs no IO.

Trait Implementations§

Source§

impl<T: KeyMaterial> Debug for KeySession<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> !Freeze for KeySession<T>

§

impl<T> RefUnwindSafe for KeySession<T>

§

impl<T> Send for KeySession<T>

§

impl<T> Sync for KeySession<T>

§

impl<T> Unpin for KeySession<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for KeySession<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for KeySession<T>

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.

§

impl<T> Instrument for T

§

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

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

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

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> ErasedDestructor for T
where T: 'static,