Struct SecretKey 

pub struct SecretKey { /* private fields */ }

A SecretKey is used to create signatures.

Implementations

impl SecretKey

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

The key identifier of this secret key.

pub fn is_encrypted(&self) -> bool

Returns true if this secret key is encrypted and requires a password to use. This checks both the encryption algorithm and whether the key material has been properly decrypted.

pub fn from_bytes(bytes_buf: &[u8]) -> Result<SecretKey>

Deserialize a SecretKey.

For storage, a SecretKeyBox is usually what you need instead.

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

Serialize a SecretKey.

For storage, a SecretKeyBox is usually what you need instead.

pub fn from_box( sk_box: SecretKeyBox, password: Option<String>, ) -> Result<SecretKey>

Convert a SecretKeyBox to a SecretKey. If password is None, a password is going to be prompted interactively.

pub fn from_unencrypted_box(sk_box: SecretKeyBox) -> Result<SecretKey>

Convert an unencrypted SecretKeyBox to an unencrypted SecretKey.

pub fn to_box(&self, comment: Option<&str>) -> Result<SecretKeyBox>

Convert a SecretKey to a SecretKeyBox.

pub fn from_file<P: AsRef<Path>>( sk_path: P, password: Option<String>, ) -> Result<SecretKey>

Load a SecretKeyBox from a file, and returns a SecretKey from it.

Trait Implementations

impl Clone for SecretKey

fn clone(&self) -> SecretKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecretKey

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

Formats the value using the given formatter.

impl PartialEq for SecretKey

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for SecretKey