Struct noodles_tabix::Writer

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

A tabix writer.

Implementations

impl<W> Writer<W>

where W: Write,

pub fn new(writer: W) -> Self

Creates a tabix writer.

Examples

use noodles_tabix as tabix;
let writer = tabix::Writer::new(Vec::new());

pub fn get_ref(&self) -> &W

Returns a reference to the underlying writer.

Examples

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

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

Attempts to finish the output stream.

This is typically only manually called if the underlying stream is needed before the writer is dropped.

Examples

use noodles_tabix as tabix;
let mut writer = tabix::Writer::new(Vec::new());
writer.try_finish()?;

pub fn write_index(&mut self, index: &Index) -> Result<()>

Writes a tabix index.

Examples

use noodles_csi::binning_index::index::Header;
use noodles_tabix as tabix;

let mut writer = tabix::Writer::new(Vec::new());
let index = tabix::Index::builder().set_header(Header::default()).build();
writer.write_index(&index)?;