Struct bam::bgzip::Writer

pub struct Writer<W: Write> { /* fields omitted */ }

Bgzip writer, that allows to compress and write blocks with uncompressed size at most MAX_BLOCK_SIZE = 65536.

Methods

impl Writer<File>

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

Opens a bgzip writer from a path and compression level. Maximal compression level is 9.

impl<W: Write> Writer<W>

pub fn from_stream(stream: W, level: u8) -> Self

Opens a bgzip writer from a stream and compression level. Maximal compression level is 9.

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

Writes an empty block.

pub fn write_several(&mut self, contents: &[&[u8]]) -> Result<()>

Compresses all slices in the contents and writes as a single block.

Sum length of the contents should be at most MAX_BLOCK_SIZE = 65536.

If the compressed block is bigger than MAX_BLOCK_SIZE, the function returns an error WriteZero.

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

Compresses contents and writes as a single block.

Input contents size should be at most MAX_BLOCK_SIZE = 65536.

If the compressed block is bigger than MAX_BLOCK_SIZE, the function returns an error WriteZero.

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

Flushes inner stream.