[][src]Struct sequoia_openpgp::PacketPile

pub struct PacketPile { /* fields omitted */ }

A PacketPile holds a deserialized sequence of OpenPGP messages.

To deserialize an OpenPGP usage, use either PacketParser, PacketPileParser, or PacketPile::from_file (or related routines).

Normally, you'll want to convert the PacketPile to a TPK or a Message.

Methods

impl PacketPile[src]

pub fn pretty_print(&self)[src]

Pretty prints the message to stderr.

This function is primarily intended for debugging purposes.

pub fn path_ref(&self, pathspec: &[usize]) -> Option<&Packet>[src]

Returns a reference to the packet at the location described by pathspec.

pathspec is a slice of the form [ 0, 1, 2 ]. Each element is the index of packet in a container. Thus, the previous path specification means: return the third child of the second child of the first top-level packet. In other words, the starred packet in the following tree:

        PacketPile
       /     |     \
      0      1      2  ...
    /   \
   /     \
 0         1  ...
       /   |   \  ...
      0    1    2
                *

And, [ 10 ] means return the 11th top-level packet.

Note: there is no packet at the root. Thus, the path [] returns None.

pub fn path_ref_mut(&mut self, pathspec: &[usize]) -> Option<&mut Packet>[src]

Returns a mutable reference to the packet at the location described by pathspec.

See the description of the path_spec for more details.

pub fn replace(
    &mut self,
    pathspec: &[usize],
    count: usize,
    packets: Vec<Packet>
) -> Result<Vec<Packet>>
[src]

Replaces the specified packets at the location described by pathspec with packets.

If a packet is a container, the sub-tree rooted at the container is removed.

Note: the number of packets to remove need not match the number of packets to insert.

The removed packets are returned.

If the path was invalid, then Error::IndexOutOfRange is returned instead.

Example


// A compressed data packet that contains a literal data packet.
let mut literal = Literal::new(DataFormat::Text);
literal.set_body(b"old".to_vec());
let mut pile = PacketPile::from(Packet::from(
    CompressedData::new(CompressionAlgorithm::Uncompressed)
        .push(literal.into())));

// Replace the literal data packet.
let mut literal = Literal::new(DataFormat::Text);
literal.set_body(b"new".to_vec());
pile.replace(
    &[ 0, 0 ], 1,
    [ literal.into() ].to_vec())
    .unwrap();

Important traits for Iter<'a>
pub fn descendants(&self) -> Iter[src]

Returns an iterator over all of the packet's descendants, in depth-first order.

pub fn children<'a>(&'a self) -> Iter<'a, Packet>[src]

Returns an iterator over the top-level packets.

pub fn into_children(self) -> IntoIter<Packet>[src]

Returns an IntoIter over the top-level packets.

pub fn from_packet_parser<'a>(ppr: PacketParserResult<'a>) -> Result<PacketPile>[src]

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.

Trait Implementations

impl Serialize for PacketPile[src]

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

Writes a serialized version of the specified PacketPile to o.

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

Exports a serialized version of the specified PacketPile to o.

impl SerializeInto for PacketPile[src]

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

Serializes the packet to a vector.

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

Exports to a vector. Read more

impl<'a> Parse<'a, PacketPile> for PacketPile[src]

fn from_reader<R: 'a + Read>(reader: R) -> Result<PacketPile>[src]

Deserializes the OpenPGP message stored in a std::io::Read object.

Although this method is easier to use to parse a sequence of OpenPGP packets than a PacketParser or a PacketPileParser, this interface buffers the whole message in memory. Thus, the caller must be certain that the deserialized message is not too large.

Note: this interface does buffer the contents of packets.

fn from_file<P: AsRef<Path>>(path: P) -> Result<PacketPile>[src]

Deserializes the OpenPGP message stored in the file named by path.

See from_reader for more details and caveats.

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

Deserializes the OpenPGP message stored in the provided buffer.

See from_reader for more details and caveats.

impl From<Vec<Packet>> for PacketPile[src]

impl From<Packet> for PacketPile[src]

impl From<Message> for PacketPile[src]

impl PartialEq<PacketPile> for PacketPile[src]

impl Clone for PacketPile[src]

fn clone_from(&mut self, source: &Self)
1.0.0
[src]

Performs copy-assignment from source. Read more

impl Debug for PacketPile[src]

impl FromStr for PacketPile[src]

type Err = Error

The associated error which can be returned from parsing.

Auto Trait Implementations

impl Send for PacketPile

impl Sync for PacketPile

Blanket Implementations

impl<T> From for T[src]

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

impl<T, U> TryFrom for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip for T where
    V: MultiLane<T>,