Enum sequoia_openpgp::packet::prelude::Packet

pub enum Packet {
    Unknown(Unknown),
    Signature(Signature),
    OnePassSig(OnePassSig),
    PublicKey(Key<PublicParts, PrimaryRole>),
    PublicSubkey(Key<PublicParts, SubordinateRole>),
    SecretKey(Key<SecretParts, PrimaryRole>),
    SecretSubkey(Key<SecretParts, SubordinateRole>),
    Marker(Marker),
    Trust(Trust),
    UserID(UserID),
    UserAttribute(UserAttribute),
    Literal(Literal),
    CompressedData(CompressedData),
    PKESK(PKESK),
    SKESK(SKESK),
    SEIP(SEIP),
    MDC(MDC),
    AED(AED),
    // some variants omitted
}

Enumeration of packet types.

The different OpenPGP packets are detailed in Section 5 of RFC 4880.

The Unknown packet allows Sequoia to deal with packets that it doesn't understand. The Unknown packet is basically a binary blob that includes the packet's tag.

The unknown packet is also used for packets that are understood, but use unsupported options. For instance, when the packet parser encounters a compressed data packet with an unknown compression algorithm, it returns the packet in an Unknown packet rather than a CompressedData packet.

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

A note on equality

We define equality on Packet like equality of the serialized form of the packet bodies defined by RFC4880, i.e. two packets are considered equal if and only if their serialized form is equal, modulo the OpenPGP framing (CTB and length style, potential partial body encoding).

Variants

Unknown(Unknown)

Unknown packet.

Signature(Signature)

Signature packet.

OnePassSig(OnePassSig)

One pass signature packet.

PublicKey(Key<PublicParts, PrimaryRole>)

Public key packet.

PublicSubkey(Key<PublicParts, SubordinateRole>)

Public subkey packet.

SecretKey(Key<SecretParts, PrimaryRole>)

Public/Secret key pair.

SecretSubkey(Key<SecretParts, SubordinateRole>)

Public/Secret subkey pair.

Marker(Marker)

Marker packet.

Trust(Trust)

Trust packet.

UserID(UserID)

User ID packet.

UserAttribute(UserAttribute)

User attribute packet.

Literal(Literal)

Literal data packet.

CompressedData(CompressedData)

Compressed literal data packet.

PKESK(PKESK)

Public key encrypted data packet.

SKESK(SKESK)

Symmetric key encrypted data packet.

SEIP(SEIP)

Symmetric key encrypted, integrity protected data packet.

MDC(MDC)

Modification detection code packet.

AED(AED)

AEAD Encrypted Data Packet.

Implementations

impl Packet

pub fn tag(&self) -> Tag

Returns the Packet's corresponding OpenPGP tag.

Tags are explained in Section 4.3 of RFC 4880.

pub fn kind(&self) -> Option<Tag>

Returns the parsed Packet's corresponding OpenPGP tag.

Returns the packets tag, but only if it was successfully parsed into the corresponding packet type. If e.g. a Signature Packet uses some unsupported methods, it is parsed into an Packet::Unknown. tag() returns Tag::Signature, whereas kind() returns None.

Trait Implementations

impl Arbitrary for Packet

fn arbitrary<G: Gen>(g: &mut G) -> Self

fn shrink(&self) -> Box<dyn Iterator<Item = Self> + 'static>

impl Clone for Packet

fn clone(&self) -> Packet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Packet

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

Formats the value using the given formatter.

impl<'a> Deref for Packet

type Target = Common

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> DerefMut for Packet

fn deref_mut(&mut self) -> &mut Common

Mutably dereferences the value.

impl Eq for Packet

impl From<AED> for Packet

fn from(p: AED) -> Self

Performs the conversion.

impl From<AED1> for Packet

fn from(p: AED1) -> Self

Performs the conversion.

impl From<CompressedData> for Packet

fn from(s: CompressedData) -> Self

Performs the conversion.

impl From<Key<PublicParts, PrimaryRole>> for Packet

fn from(k: Key<PublicParts, PrimaryRole>) -> Self

Convert the Key struct to a Packet.

impl From<Key<PublicParts, SubordinateRole>> for Packet

fn from(k: Key<PublicParts, SubordinateRole>) -> Self

Convert the Key struct to a Packet.

impl From<Key<SecretParts, PrimaryRole>> for Packet

fn from(k: Key<SecretParts, PrimaryRole>) -> Self

Convert the Key struct to a Packet.

impl From<Key<SecretParts, SubordinateRole>> for Packet

fn from(k: Key<SecretParts, SubordinateRole>) -> Self

Convert the Key struct to a Packet.

impl From<Literal> for Packet

fn from(s: Literal) -> Self

Performs the conversion.

impl From<MDC> for Packet

fn from(s: MDC) -> Self

Performs the conversion.

impl From<Marker> for Packet

fn from(p: Marker) -> Self

Performs the conversion.

impl From<OnePassSig> for Packet

fn from(s: OnePassSig) -> Self

Performs the conversion.

impl From<OnePassSig3> for Packet

fn from(p: OnePassSig3) -> Self

Performs the conversion.

impl From<PKESK> for Packet

fn from(p: PKESK) -> Self

Performs the conversion.

impl From<PKESK3> for Packet

fn from(p: PKESK3) -> Self

Performs the conversion.

impl From<Packet> for Option<Token>

fn from(p: Packet) -> Self

Performs the conversion.

impl From<Packet> for PacketPile

fn from(p: Packet) -> Self

Performs the conversion.

impl From<SEIP> for Packet

fn from(p: SEIP) -> Self

Performs the conversion.

impl From<SEIP1> for Packet

fn from(s: SEIP1) -> Self

Performs the conversion.

impl From<SKESK> for Packet

fn from(p: SKESK) -> Self

Performs the conversion.

impl From<SKESK4> for Packet

fn from(s: SKESK4) -> Self

Performs the conversion.

impl From<SKESK5> for Packet

fn from(s: SKESK5) -> Self

Performs the conversion.

impl From<Signature> for Packet

fn from(s: Signature) -> Self

Performs the conversion.

impl From<Signature4> for Packet

fn from(s: Signature4) -> Self

Performs the conversion.

impl From<Trust> for Packet

fn from(s: Trust) -> Self

Performs the conversion.

impl From<Unknown> for Packet

fn from(s: Unknown) -> Self

Performs the conversion.

impl From<UserAttribute> for Packet

fn from(s: UserAttribute) -> Self

Performs the conversion.

impl From<UserID> for Packet

fn from(s: UserID) -> Self

Performs the conversion.

impl Hash for Packet

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 Marshal for Packet

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

Writes a serialized version of the specified Packet to o.

This function works recursively: if the packet contains any packets, they are also serialized.

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

Exports a serialized version of the specified Packet to o.

This function works recursively: if the packet contains any packets, they are also serialized.

impl MarshalInto for Packet

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 export_into(&self, buf: &mut [u8]) -> Result<usize>

Exports into the given buffer.

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

Serializes the packet to a vector.

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

Exports to a vector.

impl<'a> Parse<'a, Packet> for Packet

fn from_reader<R: 'a + Read>(reader: R) -> Result<Self>

Reads from the given reader.

fn from_file<P: AsRef<Path>>(path: P) -> Result<T>

Reads from the given file.

fn from_bytes<D: AsRef<[u8]> + ?Sized>(data: &'a D) -> Result<T>

Reads from the given slice.

impl PartialEq<Packet> for Packet

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

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

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

This method tests for !=.

impl Serialize for Packet

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 Packet

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 Packet

impl StructuralPartialEq for Packet