Struct AeadKey

pub struct AeadKey {
    pub data: Vec<u8>,
}

AEAD key with automatic memory zeroization

Fields

data: Vec<u8>

Implementations

impl AeadKey

pub fn new(data: Vec<u8>) -> Self

Create a new AEAD key

Arguments

• data - The key data (will be zeroized on drop)

Returns

A new AEAD key

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

Get the key data (use with caution)

pub fn size(&self) -> usize

Get the key size

pub fn validate_size(&self, expected_size: usize) -> Result<()>

Validate key size

Arguments

• expected_size - The expected key size

Returns

Ok(()) if the key size is correct, or an error if not

Trait Implementations

impl Debug for AeadKey

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

Formats the value using the given formatter.

impl Drop for AeadKey

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq for AeadKey

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Zeroize for AeadKey

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 Eq for AeadKey