Struct SecretBytes 

pub struct SecretBytes(/* private fields */);

Zeroizing byte-oriented secret material.

Implementations

impl SecretBytes

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

Wraps owned secret bytes.

pub fn from_slice(secret: &[u8]) -> Self

Copies borrowed secret bytes into zeroizing storage.

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

Returns the secret bytes.

pub const fn len(&self) -> usize

Returns the secret length in bytes.

pub const fn is_empty(&self) -> bool

Returns whether the secret is empty.

Trait Implementations

impl AsRef<[u8]> for SecretBytes

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

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

impl Clone for SecretBytes

fn clone(&self) -> SecretBytes

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecretBytes

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SecretBytes

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Drop for SecretBytes

fn drop(&mut self)

Executes the destructor for this type.

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.

impl Eq for SecretBytes

impl PartialEq for SecretBytes

fn eq(&self, other: &SecretBytes) -> 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 StructuralPartialEq for SecretBytes

impl Zeroize for SecretBytes

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.