Struct sequoia_openpgp::serialize::stream::ArbitraryWriter

pub struct ArbitraryWriter<'a> { /* private fields */ }

Writes an arbitrary packet.

This writer can be used to construct arbitrary OpenPGP packets. This is mainly useful for testing. The body will be written using partial length encoding, or, if the body is short, using full length encoding.

Implementations

impl<'a> ArbitraryWriter<'a>

pub fn new(inner: Message<'a>, tag: Tag) -> Result<Message<'a>>

Creates a new writer with the given tag.

Examples

use std::io::Write;
use sequoia_openpgp as openpgp;
use openpgp::packet::Tag;
use openpgp::serialize::stream::{Message, ArbitraryWriter};

let mut sink = vec![];
{
    let message = Message::new(&mut sink);
    let mut message = ArbitraryWriter::new(message, Tag::Literal)?;
    message.write_all(b"t")?;                   // type
    message.write_all(b"\x00")?;                // filename length
    message.write_all(b"\x00\x00\x00\x00")?;    // date
    message.write_all(b"Hello world.")?;        // body
    message.finalize()?;
}
assert_eq!(b"\xcb\x12t\x00\x00\x00\x00\x00Hello world.",
           sink.as_slice());

Trait Implementations

impl<'a> Debug for ArbitraryWriter<'a>

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

Formats the value using the given formatter.

impl<'a> Write for ArbitraryWriter<'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: &[IoSlice<'_>]) -> Result<usize, Error>

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

fn is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers 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

where Self: Sized,

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