Struct Passphrase

pub struct Passphrase(SecretString);

A secret passphrase

The passphrase is held by a [SecretString], which guarantees zeroing of memory on destruct.

Tuple Fields

0: SecretString

Implementations

impl Passphrase

pub fn new(passphrase: String) -> Self

Creates a new Passphrase from owned String

Examples

use nethsm::Passphrase;

let passphrase = Passphrase::new("passphrase".to_string());

pub fn expose_owned(&self) -> String

Exposes the secret passphrase as owned String

This is a convenience function, as much of [nethsm_sdk_rs] exclusively deals with owned strings.

pub fn expose_borrowed(&self) -> &str

Exposes the secret passphrase as borrowed str

Trait Implementations

impl Clone for Passphrase

fn clone(&self) -> Passphrase

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Passphrase

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

Formats the value using the given formatter.

impl Default for Passphrase

fn default() -> Passphrase

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Passphrase

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromStr for Passphrase

type Err = Error

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 Passphrase

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

where S: Serializer,

Serializes a Passphrase.

Warning

This may be used to write a passphrase to file! Take precautions so that passphrases can not leak to the environment.