Struct Writer

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

A FASTA index writer.

Implementations

impl<W> Writer<W>

pub fn get_ref(&self) -> &W

Returns a reference to the underlying writer.

Examples

use noodles_fasta::fai;
let writer = fai::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_fasta::fai;
let mut writer = fai::io::Writer::new(io::sink());
let _inner = writer.get_mut();

pub fn into_inner(self) -> W

Returns the underlying writer.

Examples

use noodles_fasta::fai;
let writer = fai::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 FASTA index writer.

Examples

use noodles_fasta::fai;
let mut writer = fai::io::Writer::new(Vec::new());

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

Writes a FASTA index.

Examples

use noodles_fasta::fai;

let mut writer = fai::io::Writer::new(Vec::new());

let index = fai::Index::from(vec![fai::Record::new("sq0", 13, 5, 80, 81)]);
writer.write_index(&index)?;

assert_eq!(writer.get_ref(), b"sq0\t13\t5\t80\t81\n");