Struct sequoia_openpgp::serialize::stream::Compressor

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

Compresses a packet stream.

Writes a compressed data packet containing all packets written to this writer.

Example

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

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

Implementations

impl<'a> Compressor<'a>

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

Creates a new compressor using the given algorithm.

Passing None to compression_level selects the default compression level.

pub fn algo(self, algo: CompressionAlgorithm) -> Self

Sets the compression algorithm.

pub fn level(self, level: CompressionLevel) -> Self

Sets the compression level.

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

Finalizes the compressor, returning the writer stack.

Trait Implementations

impl<'a> Debug for Compressor<'a>

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

Formats the value using the given formatter.

impl<'a> Write for Compressor<'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 Writeer 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

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