logo
pub struct Message { /* private fields */ }
Expand description

A message.

An OpenPGP message is a structured sequence of OpenPGP packets. Basically, it’s an optionally encrypted, optionally signed literal data packet. The exact structure is defined in Section 11.3 of RFC 4880.

ASCII Armored Messages are wrapped in -----BEGIN PGP MESSAGE----- header and -----END PGP MESSAGE----- tail lines:

-----BEGIN PGP MESSAGE-----

xA0DAAoW5saJekzviSQByxBiAAAAAADYtdiv2KfZgtipwnUEABYKACcFglwJHYoW
IQRnpIdTo4Cms7fffcXmxol6TO+JJAkQ5saJekzviSQAAIJ6APwK6FxtHXn8txDl
tBFsIXlOSLOs4BvArlZzZSMomIyFLAEAwCLJUChMICDxWXRlHxORqU5x6hlO3DdW
sl/1DAbnRgI=
=AqoO
-----END PGP MESSAGE-----

Examples

Creating a Message encrypted with a password.

use std::io::Write;
use openpgp::serialize::stream::{Message, Encryptor, LiteralWriter};

let mut sink = vec![];
let message = Encryptor::with_passwords(
    Message::new(&mut sink), Some("ściśle tajne")).build()?;
let mut w = LiteralWriter::new(message).build()?;
w.write_all(b"Hello world.")?;
w.finalize()?;

Implementations

Returns the body of the message.

Returns None if no literal data packet is found. This happens if a SEIP container has not been decrypted.

Examples
use std::io;
use std::io::Read;
use openpgp::Message;
use openpgp::armor::{Reader, ReaderMode};
use openpgp::parse::Parse;

let data = "yxJiAAAAAABIZWxsbyB3b3JsZCE="; // base64 over literal data packet

let mut cursor = io::Cursor::new(&data);
let mut reader = Reader::from_reader(&mut cursor, ReaderMode::VeryTolerant);

let mut buf = Vec::new();
reader.read_to_end(&mut buf)?;

let message = Message::from_bytes(&buf)?;
assert_eq!(message.body().unwrap().body(), b"Hello world!");

Methods from Deref<Target = PacketPile>

Pretty prints the message to stderr.

This function is primarily intended for debugging purposes.

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.

Examples
let pile = PacketPile::from(packets);

if let Some(packet) = pile.path_ref(&[0]) {
    // There is a packet at this path.
}

if let None = pile.path_ref(&[0, 1, 2]) {
    // But none here.
}

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

let mut lit = Literal::new(DataFormat::Text);
lit.set_body(b"test".to_vec());

let pile = PacketPile::from(vec![lit.into()]);

for packet in pile.descendants() {
    assert_eq!(packet.tag(), Tag::Literal);
}

Returns an iterator over the top-level packets.

let mut lit = Literal::new(DataFormat::Text);
lit.set_body(b"test".to_vec());

let pile = PacketPile::from(vec![lit.into()]);

assert_eq!(pile.children().len(), 1);

Trait Implementations

Formats the value using the given formatter. Read more

The resulting type after dereferencing.

Dereferences the value.

Converts to this type from the input type.

The associated error which can be returned from parsing.

Parses a string s to return a value of this type. Read more

Writes a serialized version of the specified Message to o.

Exports a serialized version of the object to o. Read more

Computes the maximal length of the serialized representation. Read more

Serializes into the given buffer. Read more

Exports into the given buffer. Read more

Serializes the packet to a vector.

Exports to a vector. Read more

Reads a Message from the specified reader.

See Message::try_from for more details.

Reads a Message from the specified file.

See Message::try_from for more details.

Reads a Message from buf.

See Message::try_from for more details.

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

This method tests for !=.

Writes a serialized version of the object to o.

Exports a serialized version of the object to o. Read more

Computes the maximal length of the serialized representation. Read more

Serializes into the given buffer. Read more

Serializes the packet to a vector.

Exports into the given buffer. Read more

Exports to a vector. Read more

Converts the PacketPile to a Message.

Converting a PacketPile to a Message doesn’t change the packets; it asserts that the packet sequence is an optionally encrypted, optionally signed, optionally compressed literal data packet. The exact grammar is defined in Section 11.3 of RFC 4880.

Caveats: this function assumes that any still encrypted parts or still compressed parts are valid messages.

The type returned in the event of a conversion error.

Converts the vector of Packets to a Message.

See Message::try_from for more details.

The type returned in the event of a conversion error.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.