Struct OutputSink 

pub struct OutputSink<W: Write> { /* private fields */ }

A deterministic compressed or plain output stream.

The sink owns at most 64 KiB of Rust buffering. Format writers must keep their additional workspace within OutputOptions::memory_limit_bytes.

Implementations

impl OutputSink<File>

pub fn create( path: impl AsRef<Path>, options: OutputOptions, ) -> Result<Self, Diagnostic>

Creates a local output stream, selecting compression from its suffix.

Errors

Returns E7901 for invalid limits, unavailable compression, or an output file that cannot be created.

impl<W: Write> OutputSink<W>

pub fn finish(self) -> Result<(), Diagnostic>

Completes compression and flushes all bytes to the underlying writer.

Errors

Returns E7901 if the stream cannot be completed.

Trait Implementations

impl<W: Write> Debug for OutputSink<W>

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<W: Write> Write for OutputSink<W>

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

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flushes 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, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

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

where Self: Sized,

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