Struct yazi::DecoderStream

pub struct DecoderStream<'a, S: Sink> { /* fields omitted */ }

Decompression stream combining a decoder context with an output.

See the crate level decompression section for detailed usage.

Implementations

impl<'a, S: Sink> DecoderStream<'a, S>

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

Writes the specified buffer to the stream, producing decompressed data in the output.

pub fn decompressed_size(&self) -> u64

Returns the number of decompressed bytes that have been written to the output.

pub fn finish(self) -> Result<(u64, Option<u32>), Error>

Consumes the stream, flushing any input that may be buffered. Returns the total number of decompressed bytes written to the output and an optional checksum if the stream was zlib encoded.

Trait Implementations

impl<'a, S: Sink> Drop for DecoderStream<'a, S>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, S: Sink> Write for DecoderStream<'a, S>

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 Writeer 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" adaptor for this instance of Write.