Struct Encoder 

pub struct Encoder<W: Write> { /* private fields */ }

Streaming compression for input streams implementing std::io::Write.

Notes

One should consider using crate::compress or crate::compress_into if possible. In that context, we do not need to hold and maintain intermediate buffers for reading and writing.

Example

use std::{io, io::Write};
use isal::{write::Encoder, CompressionLevel, decompress, Codec};

let data = b"Hello, World!".to_vec();
let mut compressed = vec![];

let mut encoder = Encoder::new(&mut compressed, CompressionLevel::Three, Codec::Gzip);

// Numbeer of compressed bytes written to `output`
io::copy(&mut io::Cursor::new(&data), &mut encoder).unwrap();

// call .flush to finish the stream
encoder.flush().unwrap();

let decompressed = decompress(io::Cursor::new(&compressed), Codec::Gzip).unwrap();
assert_eq!(decompressed.as_slice(), data);

Implementations

impl<W: Write> Encoder<W>

pub fn new(writer: W, level: CompressionLevel, codec: Codec) -> Encoder<W>

Create a new Encoder which implements the std::io::Read trait.

pub fn get_ref_mut(&mut self) -> &mut W

Mutable reference to underlying reader, not advisable to modify during reading.

pub fn get_ref(&self) -> &W

pub fn finish(self) -> Result<W>

Call flush and return the inner writer

pub fn total_out(&self) -> usize

total bytes written to the writer, inclusive of all streams if flush has been called before

pub fn total_in(&self) -> usize

total bytes processed, inclusive of all streams if flush has been called before

Trait Implementations

impl<W: Write> Write for Encoder<W>

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

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flushes 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, args: 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.