Struct brotli2::write::BrotliEncoder

pub struct BrotliEncoder<W: Write> { /* fields omitted */ }

A compression stream which will have uncompressed data written to it and will write compressed data to an output stream.

Methods

impl<W: Write> BrotliEncoder<W>

Important traits for BrotliEncoder<W>

impl<W: Write> Write for BrotliEncoder<W>

pub fn new(obj: W, level: u32) -> BrotliEncoder<W>

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

Important traits for BrotliEncoder<W>

impl<W: Write> Write for BrotliEncoder<W>

pub fn from_params(obj: W, params: &CompressParams) -> BrotliEncoder<W>

Creates a new encoder with a custom CompressParams.

pub fn get_ref(&self) -> &W

Acquires a reference to the underlying writer.

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

Acquires a mutable reference to the underlying writer.

Note that mutating the output/input state of the stream may corrupt this object, so care must be taken when using this method.

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

Consumes this encoder, flushing the output stream.

This will flush the underlying data stream and then return the contained writer if the flush succeeded.

Trait Implementations

impl<W: Write> Write for BrotliEncoder<W>

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

Write a buffer into this object, 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_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this write.

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.

impl<W: Write> Drop for BrotliEncoder<W>

fn drop(&mut self)

Executes the destructor for this type.