Skip to main content

SecretArray

Struct SecretArray 

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

Non-Clone bounded secret bytes with mandatory full-capacity cleanup.

Implementations§

Source§

impl<const CAP: usize> SecretArray<CAP>

Source

pub fn from_array( bytes: [u8; CAP], len: usize, ) -> Result<Self, BufferLengthError>

Takes ownership, checks the visible prefix, and wipes unused capacity.

Source

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

Creates an explicit borrowed interoperability view.

Source

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

Creates an explicit mutable interoperability view.

Source

pub fn declassify(self) -> DeclassifiedArray<CAP>

Deliberately converts this secret into ordinary non-wiping storage.

Source

pub const fn len(&self) -> usize

Returns the public initialized length.

Source

pub const fn is_empty(&self) -> bool

Returns whether the initialized prefix is empty.

Source

pub const fn capacity(&self) -> usize

Returns the public fixed capacity.

Source

pub fn clear(&mut self)

Wipes the complete backing array and resets the visible length.

Trait Implementations§

Source§

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

Source§

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

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

impl<const CAP: usize> Display for SecretArray<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 SecretArray<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 SecretArray<CAP>

§

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

§

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

§

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

§

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

§

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

§

impl<const CAP: usize> UnwindSafe for SecretArray<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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.