Enum sequoia_openpgp::KeyID

pub enum KeyID {
    V4([u8; 8]),
    Invalid(Box<[u8]>),
    // some variants omitted
}

A short identifier for certificates and keys.

A KeyID is a fingerprint fragment. It identifies a public key, but is easy to forge. For more details about how a KeyID is generated, see Section 12.2 of RFC 4880.

Note: This enum cannot be exhaustively matched to allow future extensions.

Variants

V4([u8; 8])

Lower 8 byte SHA-1 hash.

Invalid(Box<[u8]>)

Used for holding keyids that we don't understand. For instance, we don't grok v3 keyids. And, it is possible that the Issuer subpacket contains the wrong number of bytes.

Implementations

impl KeyID

pub fn new(data: u64) -> KeyID

Converts a u64 to a KeyID.

pub fn as_u64(&self) -> Result<u64>

Converts the KeyID to a u64 if possible.

pub fn from_bytes(raw: &[u8]) -> KeyID

Reads a binary key ID.

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

Returns a reference to the raw KeyID.

pub fn wildcard() -> Self

Returns the wildcard KeyID.

pub fn is_wildcard(&self) -> bool

Returns true if this is a wild card ID.

pub fn to_hex(&self) -> String

Converts this key ID to its canonical hexadecimal representation.

This representation is always uppercase and without spaces and is suitable for stable key identifiers.

The output of this function is exactly the same as formatting this object with the :X format specifier.

use openpgp::KeyID;

let keyid = "fb3751f1587daef1".parse::<KeyID>().unwrap();

assert_eq!("FB3751F1587DAEF1", keyid.to_hex());
assert_eq!(format!("{:X}", keyid), keyid.to_hex());

pub fn from_hex(s: &str) -> Result<Self, Error>

Parses the hexadecimal representation of an OpenPGP key ID.

This function is the reverse of to_hex. It also accepts other variants of the key ID notation including lower-case letters, spaces and optional leading 0x.

use openpgp::KeyID;

let keyid = KeyID::from_hex("0xfb3751f1587daef1").unwrap();

assert_eq!("FB3751F1587DAEF1", keyid.to_hex());

Trait Implementations

impl Clone for KeyID

fn clone(&self) -> KeyID

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyID

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

Formats the value using the given formatter.

impl Display for KeyID

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

Formats the value using the given formatter.

impl Eq for KeyID

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

fn from(fp: &Fingerprint) -> Self

Performs the conversion.

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

fn from(i: &KeyHandle) -> Self

Performs the conversion.

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

fn from(i: &KeyID) -> Self

Performs the conversion.

impl From<[u8; 8]> for KeyID

fn from(id: [u8; 8]) -> Self

Performs the conversion.

impl From<Fingerprint> for KeyID

fn from(fp: Fingerprint) -> Self

Performs the conversion.

impl From<KeyHandle> for KeyID

fn from(i: KeyHandle) -> Self

Performs the conversion.

impl From<KeyID> for Vec<u8>

fn from(id: KeyID) -> Self

Performs the conversion.

impl From<KeyID> for KeyHandle

fn from(i: KeyID) -> Self

Performs the conversion.

impl From<u64> for KeyID

fn from(id: u64) -> Self

Performs the conversion.

impl FromStr for KeyID

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for KeyID

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 LowerHex for KeyID

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

Formats the value using the given formatter.

impl Marshal for KeyID

fn serialize(&self, o: &mut dyn Write) -> Result<()>

Writes a serialized version of the object to o.

fn export(&self, o: &mut dyn Write) -> Result<()>

Exports a serialized version of the object to o.

impl MarshalInto for KeyID

fn serialized_len(&self) -> usize

Computes the maximal length of the serialized representation.

fn serialize_into(&self, buf: &mut [u8]) -> Result<usize>

Serializes into the given buffer.

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

Serializes the packet to a vector.

fn export_into(&self, buf: &mut [u8]) -> Result<usize>

Exports into the given buffer.

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

Exports to a vector.

impl Ord for KeyID

fn cmp(&self, other: &KeyID) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<KeyID> for KeyID

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

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

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

This method tests for !=.

impl PartialOrd<KeyID> for KeyID

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

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

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

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

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

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

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

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

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

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

impl Serialize for KeyID

fn serialize(&self, o: &mut dyn Write) -> Result<()>

Writes a serialized version of the object to o.

fn export(&self, o: &mut dyn Write) -> Result<()>

Exports a serialized version of the object to o.

impl SerializeInto for KeyID

fn serialized_len(&self) -> usize

Computes the maximal length of the serialized representation.

fn serialize_into(&self, buf: &mut [u8]) -> Result<usize>

Serializes into the given buffer.

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

Serializes the packet to a vector.

fn export_into(&self, buf: &mut [u8]) -> Result<usize>

Exports into the given buffer.

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

Exports to a vector.

impl StructuralEq for KeyID

impl StructuralPartialEq for KeyID

impl UpperHex for KeyID

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

Formats the value using the given formatter.