Struct brotli2::read::BrotliEncoder

pub struct BrotliEncoder<R: Read> { /* fields omitted */ }

A compression stream which wraps an uncompressed stream of data. Compressed data will be read from the stream.

Methods

impl<R: Read> BrotliEncoder<R>

Important traits for BrotliEncoder<R>

impl<R: Read> Read for BrotliEncoder<R>

pub fn new(r: R, level: u32) -> BrotliEncoder<R>

Create a new compression stream which will compress at the given level to read compress output to the give output stream.

The level argument here is typically 0-9 with 6 being a good default.

Important traits for BrotliEncoder<R>

impl<R: Read> Read for BrotliEncoder<R>

pub fn from_params(r: R, params: &CompressParams) -> BrotliEncoder<R>

Configure the compression parameters of this encoder.

pub fn get_ref(&self) -> &R

Acquires a reference to the underlying stream

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

Acquires a mutable reference to the underlying stream

Note that mutation of the stream may result in surprising results if this encoder is continued to be used.

pub fn into_inner(self) -> R

Unwrap the underlying writer, finishing the compression stream.

Trait Implementations

impl<R: Read> Read for BrotliEncoder<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.

unsafe fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

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

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

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

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

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

Read the exact number of bytes required to fill buf.

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

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

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

fn chars(self) -> Chars<Self>

Deprecated since 1.27.0

: Use str::from_utf8 instead: https://doc.rust-lang.org/nightly/std/str/struct.Utf8Error.html#examples

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

the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this Read instance to an [Iterator] over [char]s.

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

Creates an adaptor which will chain this stream with another.

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

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