Struct bam::bgzip::SentenceWriter

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

A struct that allows to write bgzip files in sentences.

It implements a Write trait, and works similar to a BufWriter, but has a method end_sentence, that indicates the end of a block of the same nature (for example, a BAM record can represent a single sentence). Method flush ignores sentences and immediately writes the remaining buffer.

The SentenceWriter will try to start new bgzip blocks only when a new sentence starts. The writer still puts several sentences in the same bgzip block, if possible.

Methods

impl<W: Write> SentenceWriter<W>

pub fn new(writer: Writer<W>) -> Self

pub fn end_sentence(&mut self)

Ends the current sentence.

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

Writes all the remaining contents to bgzip and an empty block.

Trait Implementations

impl<W: Write> Drop for SentenceWriter<W>

fn drop(&mut self)

Executes the destructor for this type.

impl<W: Write> Write for SentenceWriter<W>

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 write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer 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.