Struct zstd::stream::write::AutoFinishEncoder

pub struct AutoFinishEncoder<'a, W: Write, F: FnMut(Result<W>) = Box<dyn Send + FnMut(Result<W>)>> { /* fields omitted */ }

A wrapper around an Encoder<W> that finishes the stream on drop.

This can be created by the auto_finish() method on the Encoder.

Implementations

impl<'a, W: Write, F: FnMut(Result<W>)> AutoFinishEncoder<'a, W, F>

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 mutation of the writer may result in surprising results if this encoder is continued to be used.

Mostly used for testing purposes.

Trait Implementations

impl<W: Write, F: FnMut(Result<W>)> Drop for AutoFinishEncoder<'_, W, F>

fn drop(&mut self)

Executes the destructor for this type.

impl<W: Write, F: FnMut(Result<W>)> Write for AutoFinishEncoder<'_, W, F>

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

Write a buffer into this writer, 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_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, 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” adapter for this instance of Write.