Struct noodles::bam::bai::Writer

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

A BAM index (BAI) writer.

Examples

use noodles_bam::bai;

let index = bai::Index::new(Vec::new(), None);

let mut writer = File::create("sample.bam.bai").map(bai::Writer::new)?;
writer.write_header()?;
writer.write_index(&index)?;

Implementations

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

pub fn new(inner: W) -> Writer<W>

Creates a BAI index writer.

Examples

use noodles_bam::bai;
let writer = bai::Writer::new(Vec::new());

pub fn get_ref(&self) -> &W

Returns a reference to the underlying writer.

Examples

use noodles_bam::bai;
let writer = bai::Writer::new(Vec::new());
assert!(writer.get_ref().is_empty());

pub fn write_header(&mut self) -> Result<(), Error>

Writes a BAM index header.

This writes the magic number of the file format.

Examples

use noodles_bam::bai;

let mut writer = bai::Writer::new(Vec::new());
writer.write_header()?;

assert_eq!(writer.get_ref(), b"BAI\x01");

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

Writes a BAM index.

Examples

use noodles_bam::bai;

let index = bai::Index::new(Vec::new(), None);

let mut writer = bai::Writer::new(Vec::new());
writer.write_header()?;
writer.write_index(&index)?;