Skip to main content

AeadKey

Struct AeadKey 

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

AEAD key.

§Zeroization

With the alloc feature, the key bytes in data are zeroized when the value is dropped (#[derive(ZeroizeOnDrop)]), and can be wiped earlier by calling [Zeroize::zeroize]. This is best-effort and covers only the current allocation:

  • If the Vec has ever reallocated (growth, shrink_to_fit), earlier copies of its contents may remain elsewhere on the heap; the wipe cannot reach them. Construct keys with their final contents and do not grow data.
  • data is a public field: moving the buffer out (for example with core::mem::take(&mut key.data)) transfers ownership of the secret bytes — and responsibility for wiping them — to the caller.
  • Copies made through accessors (for example as_bytes) are outside the scope of this wipe.
  • Without the alloc feature, data is a borrowed &'static [u8] and is deliberately not zeroized: the borrow is not this type’s to wipe.

Fields§

§data: Vec<u8>

Implementations§

Source§

impl AeadKey

Source

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

Source

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

Trait Implementations§

Source§

impl Drop for AeadKey

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
Source§

impl Zeroize for AeadKey

Available on crate feature alloc only.
Source§

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.

Auto Trait Implementations§

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, 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.
Source§

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more