Struct Writer

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

A BAM index (BAI) writer.

Examples

use noodles_bam::bai;
use noodles_csi as csi;

let index = bai::Index::default();

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

Implementations

impl<W> Writer<W>

pub fn get_ref(&self) -> &W

Returns a reference to the underlying writer.

Examples

use noodles_bam::bai;
let writer = bai::io::Writer::new(io::sink());
let _inner = writer.get_ref();

pub fn get_mut(&mut self) -> &mut W

Returns a mutable reference to the underlying writer.

Examples

use noodles_bam::bai;
let mut writer = bai::io::Writer::new(io::sink());
let _inner = writer.get_mut();

pub fn into_inner(self) -> W

Returns the underlying writer.

Examples

use noodles_bam::bai;
let writer = bai::io::Writer::new(io::sink());
let _inner = writer.into_inner();

impl<W> Writer<W>

where W: Write,

pub fn new(inner: W) -> Self

Creates a BAI index writer.

Examples

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

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

Writes a BAM index.

Examples

use noodles_bam::bai;

let index = bai::Index::default();

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