Skip to main content

SecretArrayEncoder

Struct SecretArrayEncoder 

Source
pub struct SecretArrayEncoder<const CAP: usize> { /* private fields */ }
Expand description

Stack-backed incremental secret encoder.

CAP is encoded output capacity. The public maximum input length is bound separately when the encoder is constructed.

Implementations§

Source§

impl<const CAP: usize> SecretArrayEncoder<CAP>

Source

pub fn new<S: Codec>( codec: &Base64<S>, maximum_input_len: usize, ) -> Result<Self, SecretEncodeError>

Creates an empty bounded encoder over wiping stack storage.

Source

pub fn update( &mut self, input: &SecretInput<'_>, ) -> Result<Progress, SecretEncodeError>

Encodes one classified chunk into private secret output storage.

Source

pub fn finish(self) -> Result<SecretArray<CAP>, SecretEncodeError>

Completes encoding and returns redacted wiping storage.

Source

pub fn encode<S: Codec>( codec: &Base64<S>, input: &SecretInput<'_>, ) -> Result<SecretArray<CAP>, SecretEncodeError>

Encodes one complete classified input into a secret array.

Source

pub const fn state(&self) -> &SecretEncoderState

Returns public encoder metadata without exposing output bytes.

Trait Implementations§

Source§

impl<const CAP: usize> Debug for SecretArrayEncoder<CAP>

Source§

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

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

impl<const CAP: usize> Drop for SecretArrayEncoder<CAP>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

§

impl<const CAP: usize> Freeze for SecretArrayEncoder<CAP>

§

impl<const CAP: usize> RefUnwindSafe for SecretArrayEncoder<CAP>

§

impl<const CAP: usize> Send for SecretArrayEncoder<CAP>

§

impl<const CAP: usize> Sync for SecretArrayEncoder<CAP>

§

impl<const CAP: usize> Unpin for SecretArrayEncoder<CAP>

§

impl<const CAP: usize> UnsafeUnpin for SecretArrayEncoder<CAP>

§

impl<const CAP: usize> UnwindSafe for SecretArrayEncoder<CAP>

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