pub struct Message<'a>(_);
Expand description
Streams an OpenPGP message.
Wraps an io::Write
r 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
sourceimpl<'a> Message<'a>
impl<'a> Message<'a>
sourcepub fn new<W: 'a + Write + Send + Sync>(w: W) -> Message<'a>ⓘNotable traits for Message<'a>impl<'a> Write for Message<'a>
pub fn new<W: 'a + Write + Send + Sync>(w: W) -> Message<'a>ⓘNotable traits for Message<'a>impl<'a> Write for Message<'a>
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()?;
sourcepub fn finalize_one(self) -> Result<Option<Message<'a>>>
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.
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()?;
sourcepub fn finalize(self) -> Result<()>
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.
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
sourceimpl<'a> Write for Message<'a>
impl<'a> Write for Message<'a>
sourcefn write(&mut self, buf: &[u8]) -> Result<usize>
fn write(&mut self, buf: &[u8]) -> Result<usize>
Write a buffer into this writer, returning how many bytes were written. Read more
sourcefn flush(&mut self) -> Result<()>
fn flush(&mut self) -> Result<()>
Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
sourcefn is_write_vectored(&self) -> bool
fn is_write_vectored(&self) -> bool
can_vector
)Determines if this Write
r has an efficient write_vectored
implementation. Read more
1.0.0 · sourcefn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
Attempts to write an entire buffer into this writer. Read more
sourcefn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
write_all_vectored
)Attempts to write multiple buffers into this writer. Read more
Auto Trait Implementations
impl<'a> !RefUnwindSafe for Message<'a>
impl<'a> Send for Message<'a>
impl<'a> Sync for Message<'a>
impl<'a> Unpin for Message<'a>
impl<'a> !UnwindSafe for Message<'a>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more