Struct Writer

pub struct Writer { /* private fields */ }

A writer that writes uncompressed, gzip, and bgzip files.

Implementations

impl Writer

pub fn from_stdout() -> Result<Self, Error>

Create a new Writer to write to stdout with default compression.

pub fn from_stdout_with_compression( level: CompressionLevel, ) -> Result<Self, Error>

Create a new Writer to write to stdout with specific compression

Arguments

• level the compression level to use

pub fn from_path<P: AsRef<Path>>(path: P) -> Result<Self, Error>

Create a new Writer from a path with default compression.

Arguments

• path - the path to open.

pub fn from_path_with_level<P: AsRef<Path>>( path: P, level: CompressionLevel, ) -> Result<Self, Error>

Create a new Writer from a path with a specific compression level.

Arguments

• path - the path to open.

pub fn set_thread_pool(&mut self, tpool: &ThreadPool) -> Result<()>

Set the thread pool to use for parallel compression.

Arguments

• tpool - the thread-pool to use

Trait Implementations

impl Debug for Writer

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

Formats the value using the given formatter.

impl Drop for Writer

fn drop(&mut self)

Executes the destructor for this type.

impl Write for Writer

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.