Enum sequoia_openpgp::parse::PacketParserResult

pub enum PacketParserResult<'a> {
    Some(PacketParser<'a>),
    EOF(PacketParserEOF),
}

The return type of PacketParser::next() and PacketParser::recurse().

We don't use an Option, because when we reach the end of the packet sequence, some information about the message needs to remain accessible.

Variants

Some(PacketParser<'a>)

A PacketParser for the next packet.

EOF(PacketParserEOF)

Information about a fully parsed packet sequence.

Implementations

impl<'a> PacketParserResult<'a>

pub fn is_none(&self) -> bool

Like Option::is_none().

pub fn is_eof(&self) -> bool

An alias for is_none().

pub fn is_some(&self) -> bool

Like Option::is_some().

pub fn expect(self, msg: &str) -> PacketParser<'a>

Like Option::expect().

pub fn unwrap(self) -> PacketParser<'a>

Like Option::unwrap().

pub fn as_ref(&self) -> Option<&PacketParser<'a>>

Like Option::as_ref().

pub fn as_mut(&mut self) -> Option<&mut PacketParser<'a>>

Like Option::as_mut().

pub fn take(&mut self) -> Self

Like Option::take().

self is replaced with a PacketParserEOF with default values.

pub fn map<U, F>(self, f: F) -> Option<U> where
    F: FnOnce(PacketParser<'a>) -> U, 

Like Option::map().

pub fn recursion_depth(&self) -> Option<isize>

The current packet's recursion depth.

A top-level packet has a recursion depth of 0. Packets in a top-level container have a recursion depth of 1, etc.

Note: if the PacketParser has reached the end of the packet sequence and is not parsing a packet, then this returns None.

pub fn last_recursion_depth(&self) -> Option<isize>

The last packet's recursion depth.

A top-level packet has a recursion depth of 0. Packets in a top-level container have a recursion depth of 1, etc.

Note: if no packet has been returned yet, this returns None.

Trait Implementations

impl<'a> Debug for PacketParserResult<'a>

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

Formats the value using the given formatter.

impl<'a> From<PacketParserResult<'a>> for CertParser<'a, IntoIter<Packet>>

fn from(ppr: PacketParserResult<'a>) -> Self

Initializes a CertParser from a PacketParser.

impl<'a> Parse<'a, PacketParserResult<'a>> for PacketParser<'a>

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

Starts parsing an OpenPGP message stored in a std::io::Read object.

This function returns a PacketParser for the first packet in the stream.

fn from_file<P: AsRef<Path>>(path: P) -> Result<PacketParserResult<'a>>

Starts parsing an OpenPGP message stored in a file named path.

This function returns a PacketParser for the first packet in the stream.

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

Starts parsing an OpenPGP message stored in a buffer.

This function returns a PacketParser for the first packet in the stream.

impl<'_> TryFrom<PacketParserResult<'_>> for Cert

type Error = Error

The type returned in the event of a conversion error.

fn try_from(ppr: PacketParserResult) -> Result<Self>

Returns the Cert found in the packet stream.

If there are more packets after the Cert, e.g. because the packet stream is a keyring, this function will return Error::MalformedCert.

impl<'a> TryFrom<PacketParserResult<'a>> for PacketPile

type Error = Error

The type returned in the event of a conversion error.

fn try_from(ppr: PacketParserResult<'a>) -> Result<PacketPile>

Reads all of the packets from a PacketParser, and turns them into a message.

Note: this assumes that ppr points to a top-level packet.