logo
pub struct Message<'a>(_);
Expand description

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.

Implementations

Starts streaming an OpenPGP message.

Examples
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()?;

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.

Examples

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()?;

Finalizes the message.

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

Note

Failing to finalize the message may result in corrupted messages.

Examples
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

Formats the value using the given formatter. Read more

Performs the conversion.

Performs the conversion.

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

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

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

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

Determines if this Writer has an efficient write_vectored implementation. Read more

Attempts to write an entire buffer into this writer. Read more

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

Attempts to write multiple buffers into this writer. Read more

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

Creates a “by reference” adapter for this instance of Write. Read more

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.