Struct sequoia_openpgp::parse::PacketParserEOF

pub struct PacketParserEOF<'a> { /* private fields */ }

Information about the stream of packets parsed by the PacketParser.

Once the PacketParser reaches the end of the input stream, it returns a PacketParserResult::EOF with a PacketParserEOF. This object provides information about the parsed stream, notably whether or not the packet stream was a well-formed Message, Cert or keyring.

Examples

Parse some OpenPGP stream using a PacketParser and detects the kind of data:

use sequoia_openpgp as openpgp;
use openpgp::Packet;
use openpgp::parse::{Parse, PacketParserResult, PacketParser};

let openpgp_data: &[u8] = // ...
let mut ppr = PacketParser::from_bytes(openpgp_data)?;
while let PacketParserResult::Some(mut pp) = ppr {
    // Start parsing the next packet, recursing.
    ppr = pp.recurse()?.1;
}

if let PacketParserResult::EOF(eof) = ppr {
    if eof.is_message().is_ok() {
        // ...
    } else if eof.is_cert().is_ok() {
        // ...
    } else if eof.is_keyring().is_ok() {
        // ...
    } else {
        // ...
    }
}

Implementations

impl<'a> PacketParserEOF<'a>

pub fn is_message(&self) -> Result<()>

Returns whether the stream is an OpenPGP Message.

A Message has a very specific structure. Returns true if the stream is of that form, as opposed to a Cert or just a bunch of packets.

Examples

Parse some OpenPGP stream using a PacketParser and detects the kind of data:

use sequoia_openpgp as openpgp;
use openpgp::Packet;
use openpgp::parse::{Parse, PacketParserResult, PacketParser};

let openpgp_data: &[u8] = // ...
let mut ppr = PacketParser::from_bytes(openpgp_data)?;
while let PacketParserResult::Some(mut pp) = ppr {
    // Start parsing the next packet, recursing.
    ppr = pp.recurse()?.1;
}

if let PacketParserResult::EOF(eof) = ppr {
    if eof.is_message().is_ok() {
        // ...
    }
}

pub fn is_keyring(&self) -> Result<()>

Returns whether the message is an OpenPGP keyring.

A keyring has a very specific structure. Returns true if the stream is of that form, as opposed to a Message or just a bunch of packets.

Examples

Parse some OpenPGP stream using a PacketParser and detects the kind of data:

use sequoia_openpgp as openpgp;
use openpgp::Packet;
use openpgp::parse::{Parse, PacketParserResult, PacketParser};

let openpgp_data: &[u8] = // ...
let mut ppr = PacketParser::from_bytes(openpgp_data)?;
while let PacketParserResult::Some(mut pp) = ppr {
    // Start parsing the next packet, recursing.
    ppr = pp.recurse()?.1;
}

if let PacketParserResult::EOF(eof) = ppr {
    if eof.is_keyring().is_ok() {
        // ...
    }
}

pub fn is_cert(&self) -> Result<()>

Returns whether the message is an OpenPGP Cert.

A Cert has a very specific structure. Returns true if the stream is of that form, as opposed to a Message or just a bunch of packets.

Examples

Parse some OpenPGP stream using a PacketParser and detects the kind of data:

use sequoia_openpgp as openpgp;
use openpgp::Packet;
use openpgp::parse::{Parse, PacketParserResult, PacketParser};

let openpgp_data: &[u8] = // ...
let mut ppr = PacketParser::from_bytes(openpgp_data)?;
while let PacketParserResult::Some(mut pp) = ppr {
    // Start parsing the next packet, recursing.
    ppr = pp.recurse()?.1;
}

if let PacketParserResult::EOF(eof) = ppr {
    if eof.is_cert().is_ok() {
        // ...
    }
}

pub fn last_path(&self) -> &[usize]

Returns the path of the last packet.

Examples

Parse some OpenPGP stream using a PacketParser and returns the path (see PacketPile::path_ref) of the last packet:

use sequoia_openpgp as openpgp;
use openpgp::Packet;
use openpgp::parse::{Parse, PacketParserResult, PacketParser};

let openpgp_data: &[u8] = // ...
let mut ppr = PacketParser::from_bytes(openpgp_data)?;
while let PacketParserResult::Some(mut pp) = ppr {
    // Start parsing the next packet, recursing.
    ppr = pp.recurse()?.1;
}

if let PacketParserResult::EOF(eof) = ppr {
    let _ = eof.last_path();
}

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.

Examples

Parse some OpenPGP stream using a PacketParser and returns the recursion depth of the last packet:

use sequoia_openpgp as openpgp;
use openpgp::Packet;
use openpgp::parse::{Parse, PacketParserResult, PacketParser};

let openpgp_data: &[u8] = // ...
let mut ppr = PacketParser::from_bytes(openpgp_data)?;
while let PacketParserResult::Some(mut pp) = ppr {
    // Start parsing the next packet, recursing.
    ppr = pp.recurse()?.1;
}

if let PacketParserResult::EOF(eof) = ppr {
    let _ = eof.last_recursion_depth();
}

pub fn into_reader(self) -> Box<dyn BufferedReader<Cookie> + 'a>

Returns the exhausted reader.

Trait Implementations

impl<'a> Debug for PacketParserEOF<'a>

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

Formats the value using the given formatter.