Struct noodles_bgzf::writer::Writer

pub struct Writer<W> where
    W: Write,  { /* private fields */ }

A BZGF writer.

This implements std::io::Write, consuming uncompressed data and emitting compressed data.

Examples

use noodles_bgzf as bgzf;

let mut writer = bgzf::Writer::new(Vec::new());
writer.write_all(b"noodles-bgzf")?;

let data = writer.finish()?;

Implementations

impl<W> Writer<W> where
    W: Write, 

pub fn builder(inner: W) -> Builder<W>

Creates a BGZF writer builder.

Examples

use noodles_bgzf as bgzf;
let builder = bgzf::Writer::builder(Vec::new());
let writer = builder.build();

pub fn new(inner: W) -> Self

Creates a writer with a default compression level.

Examples

use noodles_bgzf as bgzf;
let writer = bgzf::Writer::new(Vec::new());

pub fn get_ref(&self) -> &W

Returns a reference to the underlying writer.

Examples

use noodles_bgzf as bgzf;
let writer = bgzf::Writer::new(Vec::new());
assert!(writer.get_ref().is_empty());

pub fn into_inner(self) -> W

Returns the underlying writer.

Examples

use noodles_bgzf as bgzf;
let writer = bgzf::Writer::new(Vec::new());
assert!(writer.into_inner().is_empty());

pub fn position(&self) -> u64

Returns the current position of the stream.

Examples

use noodles_bgzf as bgzf;
let writer = bgzf::Writer::new(Vec::new());
assert_eq!(writer.position(), 0);

pub fn virtual_position(&self) -> VirtualPosition

Returns the current virtual position of the stream.

Panics

This panics if the stream flushed >= 256 TiB of compressed data.

Examples

use noodles_bgzf as bgzf;
let writer = bgzf::Writer::new(Vec::new());
assert_eq!(writer.virtual_position(), bgzf::VirtualPosition::from(0));

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

Attempts to finish the output stream by flushing any remaining buffers.

This then appends the final BGZF EOF block.

Examples

use noodles_bgzf as bgzf;

let mut writer = bgzf::Writer::new(Vec::new());
writer.write_all(b"noodles-bgzf")?;

writer.try_finish()?;

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

Returns the underlying writer after finishing the output stream.

This method can only be called once. Any further usage of the writer may result in a panic.

Examples

use noodles_bgzf as bgzf;

let mut writer = bgzf::Writer::new(Vec::new());
writer.write_all(b"noodles-bgzf")?;

let data = writer.finish()?;

Trait Implementations

impl<W: Debug> Debug for Writer<W> where
    W: Write, 

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

Formats the value using the given formatter.

impl<W> Drop for Writer<W> where
    W: Write, 

fn drop(&mut self)

Executes the destructor for this type.

impl<W> Write for Writer<W> where
    W: Write, 

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

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