Struct tari_utilities::password::SafePassword

pub struct SafePassword { /* private fields */ }

A representation of a passphrase that zeroizes on drop, prevents display and debug output, and limits access to references

The passphrase can be instantiated from a string or any type that can become a string. It is converted to a byte array, which can be accessed as a mutable or immutable reference. You can serialize and deserialize it transparently.

// Create a safe passphrase
let passphrase = SafePassword::from("my secret passphrase");

// We can also use a string directly
assert_eq!(
    passphrase.reveal(),
    SafePassword::from("my secret passphrase".to_string()).reveal()
);

Implementations

impl SafePassword

pub fn reveal(&self) -> &Vec<u8>

Get an immutable reference to the passphrase

pub fn reveal_mut(&mut self) -> &mut Vec<u8>

Get a mutable reference to the passphrase

Trait Implementations

impl Clone for SafePassword

fn clone(&self) -> SafePassword

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SafePassword

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SafePassword

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<S: Into<String>> From<S> for SafePassword

fn from(s: S) -> Self

Converts to this type from the input type.

impl FromStr for SafePassword

type Err = String

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Serialize for SafePassword

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where S: Serializer,

Serialize this value into the given Serde serializer.