Struct sequoia_openpgp::serialize::stream::LiteralWriter

pub struct LiteralWriter<'a> { /* fields omitted */ }

Writes a literal data packet.

The body will be written using partial length encoding, or, if the body is short, using full length encoding.

Example

extern crate sequoia_openpgp as openpgp;
use std::io::Write;
use openpgp::serialize::stream::{Message, LiteralWriter};

let mut o = vec![];
{
    let message = Message::new(&mut o);
    let mut w = LiteralWriter::new(message).build()?;
    w.write_all(b"Hello world.")?;
    w.finalize()?;
}
assert_eq!(b"\xcb\x12b\x00\x00\x00\x00\x00Hello world.", o.as_slice());

Methods

impl<'a> LiteralWriter<'a>

pub fn new(inner: Stack<'a, Cookie>) -> Self

Creates a new literal writer.

pub fn format(self, format: DataFormat) -> Self

Sets the data format.

pub fn filename<B: AsRef<[u8]>>(self, filename: B) -> Result<Self>

Sets the filename.

The standard does not specify the encoding. Filenames must not be longer than 255 bytes.

pub fn date(self, timestamp: SystemTime) -> Result<Self>

Sets the data format.

pub fn build(self) -> Result<Stack<'a, Cookie>>

Finalizes the literal writer, returning the writer stack.

format, filename, and date will be emitted as part of the literal packets headers. Note that these headers will not be authenticated by signatures (but will be authenticated by a SEIP/MDC container), and are therefore unreliable and should not be trusted.

Trait Implementations

impl<'a> Debug for LiteralWriter<'a>

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

Formats the value using the given formatter.

impl<'a> Write for LiteralWriter<'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 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.