Struct sequoia_openpgp::crypto::Password

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

Holds a password.

Passwords can be converted from various types using From. The password is encrypted in memory and only decrypted on demand. See mem::Encrypted for details.

Examples

use sequoia_openpgp as openpgp;
use openpgp::crypto::Password;

// Convert from a &str.
let p: Password = "hunter2".into();

// Convert from a &[u8].
let p: Password = b"hunter2"[..].into();

// Convert from a String.
let p: Password = String::from("hunter2").into();

// ...

Implementations

impl Password

pub fn map<F, T>(&self, fun: F) -> T

where F: FnMut(&Protected) -> T,

Maps the given function over the password.

The password is stored encrypted in memory. This function temporarily decrypts it for the given function to use.

Examples

use sequoia_openpgp as openpgp;
use openpgp::crypto::Password;

let p: Password = "hunter2".into();
p.map(|p| assert_eq!(p.as_ref(), &b"hunter2"[..]));

Trait Implementations

impl Clone for Password

fn clone(&self) -> Password

Returns a copy 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

Formats the value using the given formatter.

impl From<&[u8]> for Password

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

Converts to this type from the input type.

impl<'a> From<&'a str> for Password

fn from(v: &'a str) -> Self

Converts to this type from the input type.

impl From<Box<[u8]>> for Password

fn from(v: Box<[u8]>) -> Self

Converts to this type from the input type.

impl From<String> for Password

fn from(v: String) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for Password

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

Converts to this type from the input type.

impl PartialEq for Password

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Password

impl StructuralPartialEq for Password