Struct Password 

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

A password used to unlock a crate::Keystore.

The password is stored in a Zeroizing<Vec<u8>>; the underlying memory is wiped when the Password is dropped. Password is Clone so callers may retain a copy for later use (e.g., re-locking with the same password); both copies are zeroized on drop.

Construction

Use any of the From impls:

use dig_keystore::Password;

let from_str:     Password = Password::from("abc");
let from_string:  Password = Password::from(String::from("abc"));
let from_slice:   Password = Password::from(b"abc".as_slice());
let from_vec:     Password = Password::from(b"abc".to_vec());
let from_new:     Password = Password::new(b"abc");

UTF-8 vs arbitrary bytes

Password accepts arbitrary byte sequences. Argon2id hashes raw bytes, so non-UTF-8 passwords work. The optional password-strength feature (which wires zxcvbn) requires UTF-8 and falls back to an empty-string score for non-UTF-8 bytes.

Implementations

impl Password

pub fn new(bytes: impl AsRef<[u8]>) -> Self

Wrap any byte sequence as a Password.

Copies the input bytes into a freshly-allocated zeroizing buffer. The caller’s original bytes are not wiped — callers managing particularly sensitive memory should zeroize the source themselves after passing it to Password::new.

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

Borrow the raw password bytes. The returned slice is valid only while the Password is alive.

Used internally by [crate::kdf] to feed Argon2id. External callers generally should not need this — prefer handing the Password to a Keystore method.

pub fn len(&self) -> usize

Length in bytes.

pub fn is_empty(&self) -> bool

Whether the password is zero bytes long.

Empty passwords are permitted by the library (Argon2id will hash them), but they are trivially brute-forced. Treat as an operator error.

Trait Implementations

impl Clone for Password

fn clone(&self) -> Password

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Password

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

Never leaks password contents. Prints Password(<N bytes>).

A common mistake is to derive Debug on an outer struct that contains a Password, then log the struct and accidentally print the password. This custom Debug impl makes that mistake benign.

impl From<&[u8]> for Password

fn from(bytes: &[u8]) -> Self

Converts to this type from the input type.

impl From<&str> for Password

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for Password

fn from(s: String) -> Self

Consumes the String, so the UTF-8 buffer is transferred into the zeroizing buffer with a single allocation and no leftover copy.

impl From<Vec<u8>> for Password

fn from(bytes: Vec<u8>) -> Self

Consumes the Vec<u8>, transferring ownership into the zeroizing buffer. Preferred over Password::new(&vec) because it avoids the double-allocation.