Struct Writer

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

A CSI writer.

Implementations

impl<W> Writer<W>

where W: Write,

pub fn new(writer: W) -> Self

Creates a CSI writer.

Examples

use noodles_csi as csi;
let writer = csi::io::Writer::new(Vec::new());

pub fn get_ref(&self) -> &Writer<W>

Returns a reference to the underlying writer.

Examples

use noodles_csi as csi;
let writer = csi::io::Writer::new(io::sink());
let _inner = writer.get_ref();

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

Returns a mutable reference to the underlying writer.

Examples

use noodles_csi as csi;
let mut writer = csi::io::Writer::new(io::sink());
let _inner = writer.get_mut();

pub fn into_inner(self) -> Writer<W>

Returns the underlying writer.

Examples

use noodles_csi as csi;
let writer = csi::io::Writer::new(io::sink());
let _inner = writer.into_inner();

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

Writes a coordinate-sorted index (CSI).

Examples

use noodles_csi as csi;
let index = csi::Index::default();
let mut writer = csi::io::Writer::new(Vec::new());
writer.write_index(&index)?;