Struct Encoder 

pub struct Encoder<R: Read> { /* private fields */ }

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

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::Read};
use isal::{read::Encoder, CompressionLevel, decompress, Codec};
let data = b"Hello, World!".to_vec();

let mut encoder = Encoder::new(data.as_slice(), CompressionLevel::Three, Codec::Gzip);
let mut compressed = vec![];

// Number of compressed bytes written to `output`
let n = io::copy(&mut encoder, &mut compressed).unwrap();
assert_eq!(n as usize, compressed.len());

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

Implementations

impl<R: Read> Encoder<R>

pub fn new(reader: R, level: CompressionLevel, codec: Codec) -> Encoder<R>

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

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

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

pub fn get_ref(&self) -> &R

Trait Implementations

impl<R: Read> Read for Encoder<R>

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

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

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

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

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

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

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

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

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>

where Self: Sized,

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

Read and return a fixed array of bytes from this source.