Struct sequoia_openpgp::cert::amalgamation::KeyAmalgamation

pub struct KeyAmalgamation<'a, P, R, R2> where
    P: 'a + KeyParts,
    R: 'a + KeyRole,  { /* fields omitted */ }

A key amalgamation.

Generally, you won't use this type directly, but instead use PrimaryKeyAmalgamation, SubordinateKeyAmalgamation, or ErasedKeyAmalgamation.

See the module-level documentation for information about key amalgamations.

Implementations

impl<'a, P> KeyAmalgamation<'a, P, PrimaryRole, ()> where
    P: KeyParts, 

pub fn parts_into_public(self) -> PrimaryKeyAmalgamation<'a, PublicParts>

Changes the key's parts tag to PublicParts.

pub fn parts_as_public(&'a self) -> &'a PrimaryKeyAmalgamation<'a, PublicParts>

Changes the key's parts tag to PublicParts.

pub fn parts_into_secret(
    self
) -> Result<PrimaryKeyAmalgamation<'a, SecretParts>>

Changes the key's parts tag to SecretParts.

pub fn parts_as_secret(
    &'a self
) -> Result<&'a PrimaryKeyAmalgamation<'a, SecretParts>>

Changes the key's parts tag to SecretParts.

pub fn parts_into_unspecified(
    self
) -> PrimaryKeyAmalgamation<'a, UnspecifiedParts>

Changes the key's parts tag to UnspecifiedParts.

pub fn parts_as_unspecified(
    &'a self
) -> &PrimaryKeyAmalgamation<'a, UnspecifiedParts>

Changes the key's parts tag to UnspecifiedParts.

impl<'a, P> KeyAmalgamation<'a, P, SubordinateRole, ()> where
    P: KeyParts, 

pub fn parts_into_public(self) -> SubordinateKeyAmalgamation<'a, PublicParts>

Changes the key's parts tag to PublicParts.

pub fn parts_as_public(
    &'a self
) -> &'a SubordinateKeyAmalgamation<'a, PublicParts>

Changes the key's parts tag to PublicParts.

pub fn parts_into_secret(
    self
) -> Result<SubordinateKeyAmalgamation<'a, SecretParts>>

Changes the key's parts tag to SecretParts.

pub fn parts_as_secret(
    &'a self
) -> Result<&'a SubordinateKeyAmalgamation<'a, SecretParts>>

Changes the key's parts tag to SecretParts.

pub fn parts_into_unspecified(
    self
) -> SubordinateKeyAmalgamation<'a, UnspecifiedParts>

Changes the key's parts tag to UnspecifiedParts.

pub fn parts_as_unspecified(
    &'a self
) -> &SubordinateKeyAmalgamation<'a, UnspecifiedParts>

Changes the key's parts tag to UnspecifiedParts.

impl<'a, P> KeyAmalgamation<'a, P, UnspecifiedRole, bool> where
    P: KeyParts, 

pub fn parts_into_public(self) -> ErasedKeyAmalgamation<'a, PublicParts>

Changes the key's parts tag to PublicParts.

pub fn parts_as_public(&'a self) -> &'a ErasedKeyAmalgamation<'a, PublicParts>

Changes the key's parts tag to PublicParts.

pub fn parts_into_secret(self) -> Result<ErasedKeyAmalgamation<'a, SecretParts>>

Changes the key's parts tag to SecretParts.

pub fn parts_as_secret(
    &'a self
) -> Result<&'a ErasedKeyAmalgamation<'a, SecretParts>>

Changes the key's parts tag to SecretParts.

pub fn parts_into_unspecified(
    self
) -> ErasedKeyAmalgamation<'a, UnspecifiedParts>

Changes the key's parts tag to UnspecifiedParts.

pub fn parts_as_unspecified(
    &'a self
) -> &ErasedKeyAmalgamation<'a, UnspecifiedParts>

Changes the key's parts tag to UnspecifiedParts.

impl<'a, P, R, R2> KeyAmalgamation<'a, P, R, R2> where
    P: 'a + KeyParts,
    R: 'a + KeyRole, 

pub fn component_amalgamation(&self) -> &ComponentAmalgamation<'a, Key<P, R>>

Returns the KeyAmalgamation's ComponentAmalgamation.

pub fn key(&self) -> &'a Key<P, R>

Returns the KeyAmalgamation's key.

Normally, a type implementing KeyAmalgamation eventually derefs to a Key, however, this method provides a more accurate lifetime. See the documentation for ComponentAmalgamation::component for an explanation.

Methods from Deref<Target = ComponentAmalgamation<'a, Key<P, R>>>

pub fn parts_as_public(
    &'a self
) -> &'a ComponentAmalgamation<'a, Key<PublicParts, R>>

Changes the key's parts tag to PublicParts.

pub fn parts_as_secret(
    &'a self
) -> Result<&'a ComponentAmalgamation<'a, Key<SecretParts, R>>>

Changes the key's parts tag to SecretParts.

pub fn parts_as_unspecified(
    &'a self
) -> &ComponentAmalgamation<'a, Key<UnspecifiedParts, R>>

Changes the key's parts tag to UnspecifiedParts.

pub fn mark_role_primary_ref(
    &'a self
) -> &'a ComponentAmalgamation<'a, Key<P, PrimaryRole>>

Changes the key's role tag to PrimaryRole.

pub fn mark_role_subordinate_ref(
    &'a self
) -> &'a ComponentAmalgamation<'a, Key<P, SubordinateRole>>

Changes the key's role tag to SubordinateRole.

pub fn mark_role_unspecified_ref(
    &'a self
) -> &'a ComponentAmalgamation<'a, Key<P, UnspecifiedRole>>

Changes the key's role tag to UnspecifiedRole.

pub fn cert(&self) -> &'a Cert

Returns the certificate that the component came from.

pub fn bundle(&self) -> &'a ComponentBundle<C>

Returns this amalgamation's bundle.

Note: although Amalgamation derefs to a ComponentBundle, this method provides a more accurate lifetime, which is helpful when returning the reference from a function.

Consider the following, which doesn't work:

use openpgp::cert::prelude::*;
use openpgp::packet::prelude::*;

cert.keys()
    .map(|ka| {
        let b : &KeyBundle<_, _> = &ka;
        b
    })
    .collect::<Vec<&KeyBundle<_, _>>>();

Compiling the above code results in the following error:

b returns a value referencing data owned by the current function

This error occurs because the Deref trait says that the lifetime of the target, i.e., &KeyBundle, is bounded by ka's lifetime, whose lifetime is indeed limited to the closure. But, &KeyBundle is independent of ka! It is a copy of the KeyAmalgamation's reference to the KeyBundle whose lifetime is 'a. Unfortunately, this can't be expressed using Deref, but it can be done using a separate method:

use openpgp::cert::prelude::*;
use openpgp::packet::prelude::*;

cert.keys().map(|ka| ka.bundle())
    .collect::<Vec<&KeyBundle<_, _>>>();

pub fn component(&self) -> &'a C

Returns this amalgamation's component.

Note: although Amalgamation derefs to a Component (via ComponentBundle), this method provides a more accurate lifetime, which is helpful when returning the reference from a function.

Consider the following, which doesn't work:

use openpgp::cert::prelude::*;
use openpgp::packet::prelude::*;

cert.keys()
    .map(|ka| {
        let k : &Key<_, _> = &ka;
        k
    })
    .collect::<Vec<&Key<_, _>>>();

Compiling the above code results in the following error:

k returns a value referencing data owned by the current function

This error occurs because the Deref trait says that the lifetime of the target, i.e., &Key, is bounded by the ka's lifetime, whose lifetime is indeed limited to the closure. But, &Key is independent of ka! It is a copy of the KeyAmalgamation's reference to the Key whose lifetime is 'a. Unfortunately, this can't be expressed using Deref, but it can be done using a separate method:

use openpgp::cert::prelude::*;
use openpgp::packet::prelude::*;

cert.keys().map(|ka| ka.key())
    .collect::<Vec<&Key<_, _>>>();

pub fn userid(&self) -> &'a UserID

Returns a reference to the User ID.

pub fn user_attribute(&self) -> &'a UserAttribute

Returns a reference to the User Attribute.

Trait Implementations

impl<'a, P, R, R2> Clone for KeyAmalgamation<'a, P, R, R2> where
    P: 'a + KeyParts,
    R: 'a + KeyRole,
    R2: Copy, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, P: Debug, R: Debug, R2: Debug> Debug for KeyAmalgamation<'a, P, R, R2> where
    P: 'a + KeyParts,
    R: 'a + KeyRole, 

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

Formats the value using the given formatter.

impl<'a, P, R, R2> Deref for KeyAmalgamation<'a, P, R, R2> where
    P: 'a + KeyParts,
    R: 'a + KeyRole, 

type Target = ComponentAmalgamation<'a, Key<P, R>>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a> From<&'a KeyAmalgamation<'a, PublicParts, PrimaryRole, ()>> for &'a PrimaryKeyAmalgamation<'a, UnspecifiedParts>

fn from(p: &'a PrimaryKeyAmalgamation<'a, PublicParts>) -> Self

Performs the conversion.

impl<'a> From<&'a KeyAmalgamation<'a, PublicParts, SubordinateRole, ()>> for &'a SubordinateKeyAmalgamation<'a, UnspecifiedParts>

fn from(p: &'a SubordinateKeyAmalgamation<'a, PublicParts>) -> Self

Performs the conversion.

impl<'a> From<&'a KeyAmalgamation<'a, PublicParts, UnspecifiedRole, bool>> for &'a ErasedKeyAmalgamation<'a, UnspecifiedParts>

fn from(p: &'a ErasedKeyAmalgamation<'a, PublicParts>) -> Self

Performs the conversion.

impl<'a> From<&'a KeyAmalgamation<'a, SecretParts, PrimaryRole, ()>> for &'a PrimaryKeyAmalgamation<'a, PublicParts>

fn from(p: &'a PrimaryKeyAmalgamation<'a, SecretParts>) -> Self

Performs the conversion.

impl<'a> From<&'a KeyAmalgamation<'a, SecretParts, PrimaryRole, ()>> for &'a PrimaryKeyAmalgamation<'a, UnspecifiedParts>

fn from(p: &'a PrimaryKeyAmalgamation<'a, SecretParts>) -> Self

Performs the conversion.

impl<'a> From<&'a KeyAmalgamation<'a, SecretParts, SubordinateRole, ()>> for &'a SubordinateKeyAmalgamation<'a, PublicParts>

fn from(p: &'a SubordinateKeyAmalgamation<'a, SecretParts>) -> Self

Performs the conversion.

impl<'a> From<&'a KeyAmalgamation<'a, SecretParts, SubordinateRole, ()>> for &'a SubordinateKeyAmalgamation<'a, UnspecifiedParts>

fn from(p: &'a SubordinateKeyAmalgamation<'a, SecretParts>) -> Self

Performs the conversion.

impl<'a> From<&'a KeyAmalgamation<'a, SecretParts, UnspecifiedRole, bool>> for &'a ErasedKeyAmalgamation<'a, PublicParts>

fn from(p: &'a ErasedKeyAmalgamation<'a, SecretParts>) -> Self

Performs the conversion.

impl<'a> From<&'a KeyAmalgamation<'a, SecretParts, UnspecifiedRole, bool>> for &'a ErasedKeyAmalgamation<'a, UnspecifiedParts>

fn from(p: &'a ErasedKeyAmalgamation<'a, SecretParts>) -> Self

Performs the conversion.

impl<'a> From<&'a KeyAmalgamation<'a, UnspecifiedParts, PrimaryRole, ()>> for &'a PrimaryKeyAmalgamation<'a, PublicParts>

fn from(p: &'a PrimaryKeyAmalgamation<'a, UnspecifiedParts>) -> Self

Performs the conversion.

impl<'a> From<&'a KeyAmalgamation<'a, UnspecifiedParts, SubordinateRole, ()>> for &'a SubordinateKeyAmalgamation<'a, PublicParts>

fn from(p: &'a SubordinateKeyAmalgamation<'a, UnspecifiedParts>) -> Self

Performs the conversion.

impl<'a> From<&'a KeyAmalgamation<'a, UnspecifiedParts, UnspecifiedRole, bool>> for &'a ErasedKeyAmalgamation<'a, PublicParts>

fn from(p: &'a ErasedKeyAmalgamation<'a, UnspecifiedParts>) -> Self

Performs the conversion.

impl<'a, P: 'a + KeyParts> From<KeyAmalgamation<'a, P, PrimaryRole, ()>> for ErasedKeyAmalgamation<'a, P>

fn from(ka: PrimaryKeyAmalgamation<'a, P>) -> Self

Performs the conversion.

impl<'a, P: 'a + KeyParts> From<KeyAmalgamation<'a, P, SubordinateRole, ()>> for ErasedKeyAmalgamation<'a, P>

fn from(ka: SubordinateKeyAmalgamation<'a, P>) -> Self

Performs the conversion.

impl<'a> From<KeyAmalgamation<'a, PublicParts, PrimaryRole, ()>> for PrimaryKeyAmalgamation<'a, UnspecifiedParts>

fn from(p: PrimaryKeyAmalgamation<'a, PublicParts>) -> Self

Performs the conversion.

impl<'a> From<KeyAmalgamation<'a, PublicParts, PrimaryRole, ()>> for ErasedKeyAmalgamation<'a, UnspecifiedParts>

fn from(ka: PrimaryKeyAmalgamation<'a, PublicParts>) -> Self

Performs the conversion.

impl<'a> From<KeyAmalgamation<'a, PublicParts, SubordinateRole, ()>> for SubordinateKeyAmalgamation<'a, UnspecifiedParts>

fn from(p: SubordinateKeyAmalgamation<'a, PublicParts>) -> Self

Performs the conversion.

impl<'a> From<KeyAmalgamation<'a, PublicParts, SubordinateRole, ()>> for ErasedKeyAmalgamation<'a, UnspecifiedParts>

fn from(ka: SubordinateKeyAmalgamation<'a, PublicParts>) -> Self

Performs the conversion.

impl<'a> From<KeyAmalgamation<'a, PublicParts, UnspecifiedRole, bool>> for ErasedKeyAmalgamation<'a, UnspecifiedParts>

fn from(p: ErasedKeyAmalgamation<'a, PublicParts>) -> Self

Performs the conversion.

impl<'a> From<KeyAmalgamation<'a, SecretParts, PrimaryRole, ()>> for PrimaryKeyAmalgamation<'a, PublicParts>

fn from(p: PrimaryKeyAmalgamation<'a, SecretParts>) -> Self

Performs the conversion.

impl<'a> From<KeyAmalgamation<'a, SecretParts, PrimaryRole, ()>> for PrimaryKeyAmalgamation<'a, UnspecifiedParts>

fn from(p: PrimaryKeyAmalgamation<'a, SecretParts>) -> Self

Performs the conversion.

impl<'a> From<KeyAmalgamation<'a, SecretParts, PrimaryRole, ()>> for ErasedKeyAmalgamation<'a, PublicParts>

fn from(ka: PrimaryKeyAmalgamation<'a, SecretParts>) -> Self

Performs the conversion.

impl<'a> From<KeyAmalgamation<'a, SecretParts, PrimaryRole, ()>> for ErasedKeyAmalgamation<'a, UnspecifiedParts>

fn from(ka: PrimaryKeyAmalgamation<'a, SecretParts>) -> Self

Performs the conversion.

impl<'a> From<KeyAmalgamation<'a, SecretParts, SubordinateRole, ()>> for SubordinateKeyAmalgamation<'a, PublicParts>

fn from(p: SubordinateKeyAmalgamation<'a, SecretParts>) -> Self

Performs the conversion.

impl<'a> From<KeyAmalgamation<'a, SecretParts, SubordinateRole, ()>> for SubordinateKeyAmalgamation<'a, UnspecifiedParts>

fn from(p: SubordinateKeyAmalgamation<'a, SecretParts>) -> Self

Performs the conversion.

impl<'a> From<KeyAmalgamation<'a, SecretParts, SubordinateRole, ()>> for ErasedKeyAmalgamation<'a, PublicParts>

fn from(ka: SubordinateKeyAmalgamation<'a, SecretParts>) -> Self

Performs the conversion.

impl<'a> From<KeyAmalgamation<'a, SecretParts, SubordinateRole, ()>> for ErasedKeyAmalgamation<'a, UnspecifiedParts>

fn from(ka: SubordinateKeyAmalgamation<'a, SecretParts>) -> Self

Performs the conversion.

impl<'a> From<KeyAmalgamation<'a, SecretParts, UnspecifiedRole, bool>> for ErasedKeyAmalgamation<'a, PublicParts>

fn from(p: ErasedKeyAmalgamation<'a, SecretParts>) -> Self

Performs the conversion.

impl<'a> From<KeyAmalgamation<'a, SecretParts, UnspecifiedRole, bool>> for ErasedKeyAmalgamation<'a, UnspecifiedParts>

fn from(p: ErasedKeyAmalgamation<'a, SecretParts>) -> Self

Performs the conversion.

impl<'a> From<KeyAmalgamation<'a, UnspecifiedParts, PrimaryRole, ()>> for PrimaryKeyAmalgamation<'a, PublicParts>

fn from(p: PrimaryKeyAmalgamation<'a, UnspecifiedParts>) -> Self

Performs the conversion.

impl<'a> From<KeyAmalgamation<'a, UnspecifiedParts, PrimaryRole, ()>> for ErasedKeyAmalgamation<'a, PublicParts>

fn from(ka: PrimaryKeyAmalgamation<'a, UnspecifiedParts>) -> Self

Performs the conversion.

impl<'a> From<KeyAmalgamation<'a, UnspecifiedParts, SubordinateRole, ()>> for SubordinateKeyAmalgamation<'a, PublicParts>

fn from(p: SubordinateKeyAmalgamation<'a, UnspecifiedParts>) -> Self

Performs the conversion.

impl<'a> From<KeyAmalgamation<'a, UnspecifiedParts, SubordinateRole, ()>> for ErasedKeyAmalgamation<'a, PublicParts>

fn from(ka: SubordinateKeyAmalgamation<'a, UnspecifiedParts>) -> Self

Performs the conversion.

impl<'a> From<KeyAmalgamation<'a, UnspecifiedParts, UnspecifiedRole, bool>> for ErasedKeyAmalgamation<'a, PublicParts>

fn from(p: ErasedKeyAmalgamation<'a, UnspecifiedParts>) -> Self

Performs the conversion.

impl<'a, P, R, R2> From<ValidKeyAmalgamation<'a, P, R, R2>> for KeyAmalgamation<'a, P, R, R2> where
    P: 'a + KeyParts,
    R: 'a + KeyRole,
    R2: Copy, 

fn from(vka: ValidKeyAmalgamation<'a, P, R, R2>) -> Self

Performs the conversion.

impl<'a> TryFrom<&'a KeyAmalgamation<'a, PublicParts, PrimaryRole, ()>> for &'a PrimaryKeyAmalgamation<'a, SecretParts>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(p: &'a PrimaryKeyAmalgamation<'a, PublicParts>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<&'a KeyAmalgamation<'a, PublicParts, SubordinateRole, ()>> for &'a SubordinateKeyAmalgamation<'a, SecretParts>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(p: &'a SubordinateKeyAmalgamation<'a, PublicParts>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<&'a KeyAmalgamation<'a, PublicParts, UnspecifiedRole, bool>> for &'a ErasedKeyAmalgamation<'a, SecretParts>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(p: &'a ErasedKeyAmalgamation<'a, PublicParts>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<&'a KeyAmalgamation<'a, UnspecifiedParts, PrimaryRole, ()>> for &'a PrimaryKeyAmalgamation<'a, SecretParts>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(p: &'a PrimaryKeyAmalgamation<'a, UnspecifiedParts>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<&'a KeyAmalgamation<'a, UnspecifiedParts, SubordinateRole, ()>> for &'a SubordinateKeyAmalgamation<'a, SecretParts>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(
    p: &'a SubordinateKeyAmalgamation<'a, UnspecifiedParts>
) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<&'a KeyAmalgamation<'a, UnspecifiedParts, UnspecifiedRole, bool>> for &'a ErasedKeyAmalgamation<'a, SecretParts>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(p: &'a ErasedKeyAmalgamation<'a, UnspecifiedParts>) -> Result<Self>

Performs the conversion.

impl<'a, P, P2> TryFrom<KeyAmalgamation<'a, P, UnspecifiedRole, bool>> for PrimaryKeyAmalgamation<'a, P2> where
    P: 'a + KeyParts,
    P2: 'a + KeyParts, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(ka: ErasedKeyAmalgamation<'a, P>) -> Result<Self>

Performs the conversion.

impl<'a, P, P2> TryFrom<KeyAmalgamation<'a, P, UnspecifiedRole, bool>> for SubordinateKeyAmalgamation<'a, P2> where
    P: 'a + KeyParts,
    P2: 'a + KeyParts, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(ka: ErasedKeyAmalgamation<'a, P>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<KeyAmalgamation<'a, PublicParts, PrimaryRole, ()>> for PrimaryKeyAmalgamation<'a, SecretParts>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(p: PrimaryKeyAmalgamation<'a, PublicParts>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<KeyAmalgamation<'a, PublicParts, SubordinateRole, ()>> for SubordinateKeyAmalgamation<'a, SecretParts>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(p: SubordinateKeyAmalgamation<'a, PublicParts>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<KeyAmalgamation<'a, PublicParts, UnspecifiedRole, bool>> for ErasedKeyAmalgamation<'a, SecretParts>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(p: ErasedKeyAmalgamation<'a, PublicParts>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<KeyAmalgamation<'a, UnspecifiedParts, PrimaryRole, ()>> for PrimaryKeyAmalgamation<'a, SecretParts>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(p: PrimaryKeyAmalgamation<'a, UnspecifiedParts>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<KeyAmalgamation<'a, UnspecifiedParts, SubordinateRole, ()>> for SubordinateKeyAmalgamation<'a, SecretParts>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(p: SubordinateKeyAmalgamation<'a, UnspecifiedParts>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<KeyAmalgamation<'a, UnspecifiedParts, UnspecifiedRole, bool>> for ErasedKeyAmalgamation<'a, SecretParts>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(p: ErasedKeyAmalgamation<'a, UnspecifiedParts>) -> Result<Self>

Performs the conversion.