Struct noodles::cram::crai::Writer

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

A CRAM index writer.

Implementations

impl<W> Writer<W>

where W: Write,

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

Creates a CRAM index writer.

Examples

use noodles_cram::crai;
let writer = crai::Writer::new(Vec::new());

pub fn get_ref(&self) -> &W

Returns a reference to the underlying writer.

Examples

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

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

Attempts to finish the output stream and returns the underlying writer.

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

Examples

use noodles_cram::crai;
let writer = crai::Writer::new(Vec::new());
let empty_gz = [31, 139, 8, 0, 0, 0, 0, 0, 0, 255, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0];
assert_eq!(writer.finish()?, empty_gz);

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

Writes a CRAM index.

Examples

use noodles_core::Position;
use noodles_cram::crai;

let mut writer = crai::Writer::new(Vec::new());

let index = vec![crai::Record::new(
    Some(0),
    Position::new(10946),
    6765,
    17711,
    233,
    317811,
)];

writer.write_index(&index)?;