[][src]Struct sequoia_openpgp::serialize::TSK

pub struct TSK<'a> { /* fields omitted */ }

A reference to a TPK that allows serialization of secret keys.

To avoid accidental leakage TPK::serialize() skips secret keys. To serialize TPKs with secret keys, use TPK::as_tsk() to create a TSK, which is a shim on top of the TPK, and serialize this.

Example

let (tpk, _) = TPKBuilder::new().generate()?;
assert!(tpk.is_tsk());

let mut buf = Vec::new();
tpk.as_tsk().serialize(&mut buf)?;

let tpk_ = TPK::from_bytes(&buf)?;
assert!(tpk_.is_tsk());
assert_eq!(tpk, tpk_);

Methods

impl<'a> TSK<'a>[src]

pub fn set_filter<P>(self, predicate: P) -> Self where
    P: 'a + Fn(&'a UnspecifiedSecret) -> bool
[src]

Filters which secret keys to export using the given predicate.

Note that the given filter replaces any existing filter.

Example

let (tpk, _) = TPKBuilder::new().add_signing_subkey().generate()?;
assert_eq!(tpk.keys_valid().secret(true).count(), 2);

// Only write out the primary key's secret.
let mut buf = Vec::new();
tpk.as_tsk()
    .set_filter(
        |k| k == tpk.primary()
                .mark_parts_secret_ref().mark_role_unspecified_ref())
    .serialize(&mut buf)?;

let tpk_ = TPK::from_bytes(&buf)?;
assert_eq!(tpk_.keys_valid().secret(true).count(), 1);
assert!(tpk_.primary().secret().is_some());

Trait Implementations

impl<'a> Serialize for TSK<'a>[src]

impl<'a> SerializeInto for TSK<'a>[src]

fn to_vec(&self) -> Result<Vec<u8>>[src]

Serializes the packet to a vector.

fn export_to_vec(&self) -> Result<Vec<u8>>[src]

Exports to a vector. Read more

Auto Trait Implementations

impl<'a> !Send for TSK<'a>

impl<'a> !Sync for TSK<'a>

Blanket Implementations

impl<T> From for T[src]

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip for T where
    V: MultiLane<T>,