Struct noodles_bgzf::multithreaded_writer::MultithreadedWriter

pub struct MultithreadedWriter<W>
where
    W: Write + Send + 'static,
{ /* 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<W> MultithreadedWriter<W>

where W: Write + Send + 'static,

pub fn new(inner: W) -> Self

Creates a multithreaded BGZF writer with a default worker count.

Examples

use noodles_bgzf as bgzf;
let writer = bgzf::MultithreadedWriter::new(io::sink());

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

Creates a multithreaded BGZF writer with a worker count.

Examples

use std::num::NonZeroUsize;
use noodles_bgzf as bgzf;
let writer = bgzf::MultithreadedWriter::with_worker_count(NonZeroUsize::MIN, io::sink());

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

Finishes the output stream by flushing any remaining buffers.

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

Examples

use noodles_bgzf as bgzf;
let mut writer = bgzf::MultithreadedWriter::new(io::sink());
writer.finish()?;

Trait Implementations

impl<W> Drop for MultithreadedWriter<W>

where W: Write + Send + 'static,

fn drop(&mut self)

Executes the destructor for this type.

impl<W> Write for MultithreadedWriter<W>

where W: Write + Send + 'static,

fn write(&mut self, buf: &[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, 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.