Enum Tag

#[non_exhaustive]
pub enum Tag {
    Reserved,
    PKESK,
    Signature,
    SKESK,
    OnePassSig,
    SecretKey,
    PublicKey,
    SecretSubkey,
    CompressedData,
    SED,
    Marker,
    Literal,
    Trust,
    UserID,
    PublicSubkey,
    UserAttribute,
    SEIP,
    MDC,
    AED,
    Padding,
    Unknown(u8),
    Private(u8),
}

The OpenPGP packet tags as defined in Section 5 of RFC 9580.

The values correspond to the serialized format.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Reserved

Reserved Packet tag.

PKESK

Public-Key Encrypted Session Key Packet.

Signature

Signature Packet.

SKESK

Symmetric-Key Encrypted Session Key Packet.

OnePassSig

One-Pass Signature Packet.

SecretKey

Secret-Key Packet.

PublicKey

Public-Key Packet.

SecretSubkey

Secret-Subkey Packet.

CompressedData

Compressed Data Packet.

SED

Symmetrically Encrypted Data Packet.

Marker

Marker Packet (Obsolete Literal Packet).

Literal

Literal Data Packet.

Trust

Trust Packet.

UserID

User ID Packet.

PublicSubkey

Public-Subkey Packet.

UserAttribute

User Attribute Packet.

SEIP

Sym. Encrypted and Integrity Protected Data Packet.

MDC

Modification Detection Code Packet.

AED

Reserved (“AEAD Encrypted Data Packet”).

Padding

Padding packet.

Unknown(u8)

Unassigned packets (as of RFC4880).

Private(u8)

Experimental packets.

Implementations

impl Tag

pub fn is_critical(&self) -> bool

Returns whether the Tag denotes a critical packet.

Upon encountering an unknown critical packet, implementations MUST reject the whole packet sequence. On the other hand, unknown non-critical packets MUST be ignored. See Section 4.3 of RFC 9580.

pub fn valid_start_of_message(&self) -> bool

Returns whether the Tag can be at the start of a valid message.

Certs can start with PublicKey, TSKs with a SecretKey.

Messages start with a OnePassSig, Signature (old style non-one pass signatures), PKESK, SKESK, CompressedData, or Literal.

Signatures can stand alone either as a detached signature, a third-party certification, or a revocation certificate.

pub fn variants() -> impl Iterator<Item = Tag>

Returns an iterator over all valid variants.

Returns an iterator over all known variants. This does not include the Tag::Reserved, Tag::Private, or Tag::Unknown variants.

Trait Implementations

impl Clone for Tag

fn clone(&self) -> Tag

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tag

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

Formats the value using the given formatter.

impl Display for Tag

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

Formats the value using the given formatter.

impl From<&Packet> for Tag

fn from(p: &Packet) -> Tag

Converts to this type from the input type.

impl From<&Tag> for u8

fn from(t: &Tag) -> u8

Converts to this type from the input type.

impl From<Packet> for Tag

fn from(p: Packet) -> Tag

Converts to this type from the input type.

impl From<Tag> for u8

fn from(t: Tag) -> u8

Converts to this type from the input type.

impl From<u8> for Tag

fn from(u: u8) -> Self

Converts to this type from the input type.

impl Hash for Tag

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Tag

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Tag

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Tag

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Tag

impl Eq for Tag