Struct Secret 

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

Bytes that are wiped when dropped.

A Secret owns its bytes and zeroes them (with volatile writes the optimizer cannot remove) when it goes away, so a token read from the keychain does not linger in freed memory. It is built from a string or bytes, read back as either, compared in constant time, and prints as Secret(<n> bytes) so a stray {:?} never logs it.

Implementations

impl Secret

pub fn new(bytes: impl Into<Vec<u8>>) -> Self

A secret from raw bytes.

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

The bytes.

pub fn as_str(&self) -> Option<&str>

The bytes as text, when they are valid UTF-8.

pub fn len(&self) -> usize

The number of bytes.

pub fn is_empty(&self) -> bool

Whether there are no bytes.

Trait Implementations

impl Clone for Secret

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Secret

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

Formats the value using the given formatter.

impl Drop for Secret

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 Secret

impl From<&[u8]> for Secret

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

Converts to this type from the input type.

impl From<&str> for Secret

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for Secret

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for Secret

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

Converts to this type from the input type.

impl PartialEq for Secret

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

Constant time in the length of the longer secret: a comparison against a stored value leaks nothing about where the first differing byte is.

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

Inequality operator !=.