Struct brotli2::bufread::BrotliEncoder

[+] Show declaration

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

[−] Expand description

A brotli encoder, or compressor.

This structure implements a BufRead interface and will read uncompressed data from an underlying stream and emit a stream of compressed data.

Methods

impl<R: BufRead> BrotliEncoder<R>[−]

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

Creates a new encoder which will read uncompressed data from the given stream and emit the compressed stream.

The level argument here is typically 0-11.

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

Creates a new encoder with a custom CompressParams.

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[−]

Consumes this encoder, returning the underlying reader.

Trait Implementations

impl<R: BufRead> Read for BrotliEncoder<R>[+]

[+] Show hidden undocumented items

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.

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 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.