Struct noodles_bgzf::multithreaded_writer::MultithreadedWriter

pub struct MultithreadedWriter { /* private fields */ }

A multithreaded BGZF writer.

This is much more basic than super::Writer but uses a thread pool to compress block data.

Implementations

impl MultithreadedWriter

pub fn with_worker_count<W>(worker_count: NonZeroUsize, inner: W) -> Self

where W: Write + Send + 'static,

Creates a multithreaded BGZF writer.

pub fn finish(&mut self) -> Result<()>

Finishes the output stream by flushing any remaining buffers.

This shuts down the writer and deflater workers and appends the final BGZF EOF block.

Trait Implementations

impl Drop for MultithreadedWriter

fn drop(&mut self)

Executes the destructor for this type.

impl Write for MultithreadedWriter

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

where Self: Sized,

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