Struct SecretArray 

pub struct SecretArray<const N: usize>(/* private fields */);

An owned, zeroizing wrapper around a fixed-size [u8; N] stack array.

Intended for fixed-size key material such as X25519 private seeds, AEAD keys, and shared secrets ([u8; 32]). The stack bytes are overwritten with zeros on Drop. Debug is redacted. Clone produces an independent value that also zeroizes on its own drop.

Implementations

impl<const N: usize> SecretArray<N>

pub const fn new(value: [u8; N]) -> Self

Wraps an owned [u8; N] as a secret.

pub const fn expose_secret(&self) -> &[u8]

Borrows the secret as a &[u8] view.

All uses of this function should be carefully reviewed to ensure the value is not printed or copied to a non-Secret-wrapped storage. The borrow does not change ownership and the secret is still zeroed on drop.

pub const fn len(&self) -> usize

Length of the array in bytes (always N).

pub const fn is_empty(&self) -> bool

Whether the array is zero-length (N == 0).

pub const fn into_inner(self) -> [u8; N]

Consumes the wrapper and returns the plain owned [u8; N].

This is the ownership-handoff path for when key material must leave the library boundary. The moved-out value is not zeroized (that is the point of handoff); the caller then owns leak prevention. No wrapped copy remains, because self is consumed by value.

Note: [u8; N] is Copy, so this returns a bit-for-bit copy and the (now-moved) self is dropped — its storage is the same bytes the copy carries, so this does not zero the returned value.

Trait Implementations

impl<const N: usize> Clone for SecretArray<N>

fn clone(&self) -> SecretArray<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for SecretArray<N>

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

Formats the value using the given formatter.

impl<const N: usize> Drop for SecretArray<N>

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.

impl<const N: usize> From<[u8; N]> for SecretArray<N>

fn from(value: [u8; N]) -> Self

Converts to this type from the input type.

impl<const N: usize> Zeroize for SecretArray<N>

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.