Struct memsecurity::CsprngArray

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

Generate Cryptographically secure random bytes of different sizes based on generic usize N

Structure

pub struct CsprngArray<const N: usize>([u8; N]);

Example

let bytes = CsprngArray::<32>::gen(); // Generates 32 random bytes
assert_eq!(bytes.len(), 32);

Implementations

impl<const N: usize> CsprngArray<N>

pub fn gen() -> Self

Method to generate random cryptographically secure random bytes

Example

let bytes = CsprngArray::<64>::gen(); // Generates 64 random bytes
assert_eq!(bytes.len(), 64);

pub fn take(self, buffer: &mut [u8; N]) -> MemSecurityResult<()>

Copies the contents of the buffer

pub fn take_zeroize_on_error( self, buffer: &mut [u8; N] ) -> MemSecurityResult<()>

Copies the contents of the buffer

pub fn expose(&self) -> [u8; N]

Clone the data. Be careful with this as it retains the secret in memory. It is recommended to call Csprng::zeroize() after consuming this in order to zeroize the memory

pub fn expose_borrowed(&self) -> &[u8]

Clone the data. Be careful with this as it retains the secret in memory. It is recommended to call Csprng::zeroize() after consuming this in order to zeroize the memory

pub fn dangerous_debug(&self) -> &[u8; N]

Get the inner value of the struct. This is only available in a debug build and is enforced by the flag #[cfg(debug_assertions)]

Trait Implementations

impl<const N: usize> AsRef<[u8]> for CsprngArray<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 CsprngArray<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 CsprngArray<N>

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

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

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

Formats the value using the given formatter.

impl<const N: usize> Display for CsprngArray<N>

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

Formats the value using the given formatter.

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

fn drop(&mut self)

Executes the destructor for this type.

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