Struct memsecurity::ZeroizeBytesArray

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

This is an array of variable length bytes that can be zeroed out on drop.

Structure

use bytes::BytesMut;

pub struct ZeroizeBytesArray<const N: usize>(BytesMut);

Implementations

impl<const N: usize> ZeroizeBytesArray<N>

pub fn new() -> Self

Initialize the array with an initial length of N

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

Initialize the array and set the internal value of the array to the value specified by method argument

pub fn new_with_csprng() -> Self

Initialize the array and set the internal value of the array to the value specified by method argument

pub fn set(self, value: [u8; N]) -> Self

Set the internal value of the array to the value specified by method argument

pub fn set_byte(&mut self, value: u8) -> &mut Self

Add the byte the internal value

pub fn set_bytes_mut(self, value: BytesMut) -> Self

Set the internal value of the array to the value specified by method argument value which is a BytesMut

pub fn with_additional_capacity(capacity: usize) -> Self

Initialize the array with the length specified by the generic const N added to the value specified by the method argument capacity:usize (N + capacity)

pub fn expose_borrowed(&self) -> &BytesMut

Expose the internal value of the array

Trait Implementations

impl<const N: usize> AsRef<[u8]> for ZeroizeBytesArray<N>

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<const N: usize> BorshDeserialize for ZeroizeBytesArray<N>

fn deserialize_reader<R: Read>(reader: &mut R) -> Result<Self, Error>

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl<const N: usize> BorshSerialize for ZeroizeBytesArray<N>

fn serialize<W: Write>(&self, writer: &mut W) -> Result<(), Error>

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

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

Formats the value using the given formatter.

impl<const N: usize> Default for ZeroizeBytesArray<N>

fn default() -> Self

Returns the “default value” for a type.

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

fn drop(&mut self)

Executes the destructor for this type.

impl<const N: usize> PartialEq for ZeroizeBytesArray<N>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<const N: usize> Zeroize for ZeroizeBytesArray<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.

impl<const N: usize> Eq for ZeroizeBytesArray<N>

impl<const N: usize> ZeroizeOnDrop for ZeroizeBytesArray<N>