Enum sequoia_openpgp::KeyHandle

pub enum KeyHandle {
    Fingerprint(Fingerprint),
    KeyID(KeyID),
}

Identifies OpenPGP keys.

An KeyHandle is either a Fingerprint or a KeyID.

Variants

Fingerprint(Fingerprint)

A Fingerprint.

KeyID(KeyID)

A KeyID.

Methods

impl KeyHandle

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

Returns a reference to the raw identifier.

pub fn aliases<H>(&self, other: H) -> bool where
    H: Borrow<KeyHandle>, 

Returns whether self and other could be aliases of each other.

KeyHandle's PartialEq implementation cannot assert that a Fingerprint and a KeyID are equal, because distinct fingerprints may have the same KeyID, and PartialEq must be transitive, i.e.,

a == b and b == c implies a == c.

That is, if fpr1 and fpr2 are distinct fingerprints with the same key ID then:

fpr1 == keyid and fpr2 == keyid, but fpr1 != fpr2.

In these cases (and only these cases) KeyHandle's PartialOrd implementation returns None to correctly indicate that a comparison is not possible.

This definition of equality makes searching for a given KeyHandle using PartialEq awkward. This function fills that gap. It answers the question: given two KeyHandles, could they be aliases? That is, it implements the desired, non-transitive equality relation:

// fpr1 and fpr2 are different fingerprints with the same KeyID.
assert!(! fpr1.eq(&fpr2));
assert!(fpr1.aliases(&keyid));
assert!(fpr2.aliases(&keyid));
assert!(! fpr1.aliases(&fpr2));

Trait Implementations

impl From<KeyID> for KeyHandle

fn from(i: KeyID) -> Self

Performs the conversion.

impl<'_> From<&'_ KeyID> for KeyHandle

fn from(i: &KeyID) -> Self

Performs the conversion.

impl From<KeyHandle> for KeyID

fn from(i: KeyHandle) -> Self

Performs the conversion.

impl<'_> From<&'_ KeyHandle> for KeyID

fn from(i: &KeyHandle) -> Self

Performs the conversion.

impl From<Fingerprint> for KeyHandle

fn from(i: Fingerprint) -> Self

Performs the conversion.

impl<'_> From<&'_ Fingerprint> for KeyHandle

fn from(i: &Fingerprint) -> Self

Performs the conversion.

impl PartialOrd<KeyHandle> for KeyHandle

fn partial_cmp(&self, other: &KeyHandle) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialEq<KeyHandle> for KeyHandle

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

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

#[must_use]

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

This method tests for !=.

impl Clone for KeyHandle

fn clone(&self) -> KeyHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Display for KeyHandle

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

Formats the value using the given formatter.

impl Hash for KeyHandle

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Debug for KeyHandle

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

Formats the value using the given formatter.

impl TryFrom<KeyHandle> for Fingerprint

type Error = Error

The type returned in the event of a conversion error.

fn try_from(i: KeyHandle) -> Result<Self>

Performs the conversion.

impl<'_> TryFrom<&'_ KeyHandle> for Fingerprint

type Error = Error

The type returned in the event of a conversion error.

fn try_from(i: &KeyHandle) -> Result<Self>

Performs the conversion.