Struct SecretOutput 

pub struct SecretOutput<'a> { /* private fields */ }

Borrowed secret output with full-range cleanup on drop.

Construction wipes unused tail bytes. Drop wipes the complete borrowed range. A consuming Self::declassify call deliberately transfers the bytes into an ordinary non-wiping view.

Implementations

impl<'a> SecretOutput<'a>

pub fn from_initialized( storage: &'a mut [u8], len: usize, ) -> Result<Self, BufferLengthError>

Wraps one initialized prefix and assumes cleanup responsibility.

Invalid lengths wipe the complete range before returning an error.

pub fn empty(storage: &'a mut [u8]) -> Self

Creates an empty output guard after wiping the complete range.

pub fn expose_secret(&self) -> ExposedSecret<'_>

Creates an explicit borrowed interoperability view.

pub fn expose_secret_mut(&mut self) -> ExposedSecretMut<'_>

Creates an explicit mutable interoperability view.

pub fn declassify(self) -> DeclassifiedOutput<'a>

Deliberately transfers the initialized prefix into ordinary storage.

The returned view does not wipe on drop. Its tail remains zeroed, and the caller becomes responsible for any later cleanup requirement.

pub const fn len(&self) -> usize

Returns the public initialized length.

pub fn capacity(&self) -> usize

Returns the public borrowed capacity.

pub const fn is_empty(&self) -> bool

Returns whether the initialized prefix is empty.

pub fn clear(&mut self)

Wipes the complete range and resets the initialized length.

Trait Implementations

impl Debug for SecretOutput<'_>

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

Formats the value using the given formatter.

impl Display for SecretOutput<'_>

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

Formats the value using the given formatter.

impl Drop for SecretOutput<'_>

fn drop(&mut self)

Executes the destructor for this type.

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.