Struct il2_utils::mem::SecretBytes

pub struct SecretBytes { /* fields omitted */ }

This struct wraps a byte array that is guaranteed to have its contents shredded upon destruction.

It also allows the locking of the value in memory if required, preventing it from being moved into the disk.

This struct also implements a mechanism to set a logical length that differs

Implementations

impl SecretBytes

pub fn new(size: usize, locked: bool) -> Self

Creates a new SecretBytes.

Arguments:

• size: The size in bytes;
• locked: Locks the value in memory;

pub fn with_value(value: &[u8], locked: bool) -> Self

Creates a new SecretBytes and initializes it with the given value.

Arguments:

• value: The initial value;
• locked: Locks the value in memory;

pub fn mut_value(&mut self) -> &mut [u8]

Returns the value as a mutable byte slice.

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

Returns the value as an immutable byte slice.

pub fn mut_buffer(&mut self) -> &mut [u8]

Returns the buffer as a mutable byte slice. The buffer may be larger than the value itself.

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

Returns the buffer as an immutable byte slice. The buffer may be larger than the value itself.

pub fn locked(&self) -> bool

Returns true if the value is locked in memory or false otherwise.

pub fn len(&self) -> usize

Returns the logical size of this value. It may be equal or smaller than the actual buffer size.

pub fn set_len(&mut self, size: usize)

Sets the logical size of this value. If the new size is larger than the buffer size, this method will set the logical size to the current buffer size.

Arguments:

• size: The logical size of the value.

pub fn is_empty(&self) -> bool

Returns true if this value has length 0.

pub fn buffer_len(&self) -> usize

Returns the size of the inner buffer of this value.

pub fn lock_supported() -> bool

Verifies if the underlying platform supports memory locking.

Returns true if locking is supported or false otherwise.

Trait Implementations

impl Clone for SecretBytes

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Deref for SecretBytes

type Target = [u8]

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for SecretBytes

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Drop for SecretBytes

fn drop(&mut self)

Executes the destructor for this type.