Enum sequoia_openpgp::parse::PacketParserResult

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

The result of parsing a packet.

This type is returned by PacketParser::next, PacketParser::recurse, PacketParserBuilder::build, and the implementation of PacketParser's Parse trait. The result is either Some(PacketParser), indicating successful parsing of a packet, or EOF(PacketParserEOF) if the end of the input stream has been reached.

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_eof(&self) -> bool

Returns true if the result is EOF.

pub fn is_some(&self) -> bool

Returns true if the result is Some.

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

Unwraps a result, yielding the content of an Some.

Panics

Panics if the value is an EOF, with a panic message including the passed message, and the information in the PacketParserEOF object.

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

Unwraps a result, yielding the content of an Some.

Panics

Panics if the value is an EOF, with a panic message including the information in the PacketParserEOF object.

pub fn as_ref(&self) -> StdResult<&PacketParser<'a>, &PacketParserEOF>

Converts from PacketParserResult to Result<&PacketParser, &PacketParserEOF>.

Produces a new Result, containing references into the original PacketParserResult, leaving the original in place.

pub fn as_mut(
    &mut self
) -> StdResult<&mut PacketParser<'a>, &mut PacketParserEOF>

Converts from PacketParserResult to Result<&mut PacketParser, &mut PacketParserEOF>.

Produces a new Result, containing mutable references into the original PacketParserResult, leaving the original in place.

pub fn take(&mut self) -> Self

Takes the value out of the PacketParserResult, leaving a EOF in its place.

The EOF left in place carries a PacketParserEOF with default values.

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

Maps a PacketParserResult to Result<PacketParser, PacketParserEOF> by applying a function to a contained Some value, leaving an EOF value untouched.

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>

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 the sequence contains multiple certificates (i.e., it is a keyring), or the certificate is followed by an invalid packet this function will fail. To parse keyrings, use CertParser instead of this function.

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.