Struct sequoia_openpgp::serialize::stream::Message

pub struct Message<'a>(_);

Streams an OpenPGP message.

Wraps an io::Writer for use with the streaming subsystem. The Message is a stack of filters that create the desired message structure. Literal data must be framed using the LiteralWriter filter. Once all the has been written, the Message must be finalized using Message::finalize.

Methods

impl<'a> Message<'a>

Important traits for Message<'a>

impl<'a> Write for Message<'a>

pub fn new<W: 'a + Write>(w: W) -> Message<'a>

Starts streaming an OpenPGP message.

Example

use sequoia_openpgp as openpgp;
use openpgp::serialize::stream::{Message, LiteralWriter};

let message = Message::new(&mut sink);
// Construct the writer stack here.
let mut message = LiteralWriter::new(message).build()?;
// Write literal data to `message` here.
// ...
// Finalize the message.
message.finalize()?;

pub fn finalize_one(self) -> Result<Option<Message<'a>>>

Finalizes the topmost writer, returning the underlying writer.

Finalizes the topmost writer, i.e. flushes any buffered data, and pops it of the stack. This allows for fine-grained control of the resulting message, but must be done with great care. If done improperly, the resulting message may be malformed.

Example

This demonstrates how to create a compressed, signed message from a detached signature.

use std::io::Write;
use std::convert::TryFrom;
use sequoia_openpgp as openpgp;
use openpgp::packet::{Packet, Signature, one_pass_sig::OnePassSig3};
use openpgp::serialize::Serialize;
use openpgp::serialize::stream::{Message, Compressor, LiteralWriter};

let data: &[u8] = // ...
let sig: Signature = // ...

let message = Message::new(&mut sink);
let mut message = Compressor::new(message).build()?;

// First, write a one-pass-signature packet.
Packet::from(OnePassSig3::try_from(&sig)?)
    .serialize(&mut message)?;

// Then, add the literal data.
let mut message = LiteralWriter::new(message).build()?;
message.write_all(data)?;

// Finally, pop the `LiteralWriter` off the stack to write the
// signature.
let mut message = message.finalize_one()?.unwrap();
Packet::from(sig).serialize(&mut message)?;

// Finalize the message.
message.finalize()?;

pub fn finalize(self) -> Result<()>

Finalizes the message.

Finalizes all writers on the stack, flushing any buffered data.

Note

Failing to finalize the message may result in corrupted messages.

Example

use sequoia_openpgp as openpgp;
use openpgp::serialize::stream::{Message, LiteralWriter};

let message = Message::new(&mut sink);
// Construct the writer stack here.
let mut message = LiteralWriter::new(message).build()?;
// Write literal data to `message` here.
// ...
// Finalize the message.
message.finalize()?;

Trait Implementations

impl<'a> From<Message<'a>> for Box<dyn Stackable<'a, Cookie> + 'a>

fn from(s: Message<'a>) -> Self

Performs the conversion.

impl<'a> From<&'a mut (dyn Write + 'a)> for Message<'a>

fn from(w: &'a mut dyn Write) -> Self

Performs the conversion.

impl<'a> Debug for Message<'a>

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

Formats the value using the given formatter.

impl<'a> Write for Message<'a>

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoVec]) -> Result<usize, Error>

🔬 This is a nightly-only experimental API. (iovec)

Like write, except that it writes from a slice of buffers.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.