Struct sequoia_openpgp::cert::amalgamation::ValidComponentAmalgamation

pub struct ValidComponentAmalgamation<'a, C> { /* fields omitted */ }

A certificate's component and its associated data.

Methods from Deref<Target = ComponentAmalgamation<'a, C>>

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 role_as_primary(
    &'a self
) -> &'a ComponentAmalgamation<'a, Key<P, PrimaryRole>>

Changes the key's role tag to PrimaryRole.

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

Changes the key's role tag to SubordinateRole.

pub fn role_as_unspecified(
    &'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 self_signatures(&self) -> &'a [Signature]

The component's self-signatures.

This method is a forwarder for ComponentBundle::self_signatures. Although ComponentAmalgamation derefs to a &ComponentBundle, this method provides a more accurate lifetime, which is helpful when returning the reference from a function. See the module's documentation for more details.

pub fn certifications(&self) -> &'a [Signature]

The component's third-party certifications.

This method is a forwarder for ComponentBundle::certifications. Although ComponentAmalgamation derefs to a &ComponentBundle, this method provides a more accurate lifetime, which is helpful when returning the reference from a function. See the module's documentation for more details.

pub fn self_revocations(&self) -> &'a [Signature]

The component's revocations that were issued by the certificate holder.

This method is a forwarder for ComponentBundle::self_revocations. Although ComponentAmalgamation derefs to a &ComponentBundle, this method provides a more accurate lifetime, which is helpful when returning the reference from a function. See the module's documentation for more details.

pub fn other_revocations(&self) -> &'a [Signature]

The component's revocations that were issued by other certificates.

This method is a forwarder for ComponentBundle::other_revocations. Although ComponentAmalgamation derefs to a &ComponentBundle, this method provides a more accurate lifetime, which is helpful when returning the reference from a function. See the module's documentation for more details.

Trait Implementations

impl<'a, C> ValidateAmalgamation<'a, C> for ValidComponentAmalgamation<'a, C>

type V = Self

The type returned by with_policy.

fn with_policy<T>(self, policy: &'a dyn Policy, time: T) -> Result<Self::V> where
    T: Into<Option<SystemTime>>,
    Self: Sized, 

Changes the amalgamation's policy.

impl<'a, C> ValidAmalgamation<'a, C> for ValidComponentAmalgamation<'a, C>

fn cert(&self) -> &ValidCert<'a>

Returns the certificate.

fn time(&self) -> SystemTime

Returns the amalgamation's reference time.

For queries that are with respect to a point in time, this determines that point in time. For instance, if a component is created at t_c and expires at t_e, then ValidComponentAmalgamation::alive will return true if the reference time is greater than or equal to t_c and less than t_e.

fn policy(&self) -> &'a dyn Policy

Returns the amalgamation's policy.

fn binding_signature(&self) -> &'a Signature

Returns the component's binding signature as of the reference time.

fn revoked(&self) -> RevocationStatus<'a>

Returns the component's revocation status as of the amalgamation's reference time.

Note: this does not return whether the certificate is valid.

fn direct_key_signature(&self) -> Result<&'a Signature>

Returns the Certificate's direct key signature as of the reference time, if any.

fn map<F: Fn(&'a Signature) -> Option<T>, T>(&self, f: F) -> Option<T>

Maps the given function over binding and direct key signature.

fn revocation_keys(&self) -> Box<dyn Iterator<Item = &'a RevocationKey> + 'a>

Returns the value of the Revocation Key subpacket, which contains a designated revoker.

impl<'a, C> Preferences<'a> for ValidComponentAmalgamation<'a, C>

fn preferred_symmetric_algorithms(&self) -> Option<&'a [SymmetricAlgorithm]>

Returns symmetric algorithms that the key holder prefers.

fn preferred_hash_algorithms(&self) -> Option<&'a [HashAlgorithm]>

Returns hash algorithms that the key holder prefers.

fn preferred_compression_algorithms(&self) -> Option<&'a [CompressionAlgorithm]>

Returns compression algorithms that the key holder prefers.

fn preferred_aead_algorithms(&self) -> Option<&'a [AEADAlgorithm]>

Returns AEAD algorithms that the key holder prefers.

fn key_server_preferences(&self) -> Option<KeyServerPreferences>

Returns the key holder's keyserver preferences.

fn preferred_key_server(&self) -> Option<&'a [u8]>

Returns the key holder's preferred keyserver for updates.

fn features(&self) -> Option<Features>

Returns the key holder's feature set.

impl<'a, C: 'a> From<ValidComponentAmalgamation<'a, C>> for ComponentAmalgamation<'a, C>

fn from(vca: ValidComponentAmalgamation<'a, C>) -> Self

Performs the conversion.

impl<'a, C> Clone for ValidComponentAmalgamation<'a, C>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, C> Deref for ValidComponentAmalgamation<'a, C>

type Target = ComponentAmalgamation<'a, C>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a, C: Debug> Debug for ValidComponentAmalgamation<'a, C>

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

Formats the value using the given formatter.