Struct Writer

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

A FASTA writer.

Implementations

impl<W> Writer<W>

pub fn get_ref(&self) -> &W

Returns a reference to the underlying writer.

Examples

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

pub fn into_inner(self) -> W

Unwraps and returns the underlying writer.

Examples

use noodles_fasta as fasta;
let writer = fasta::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 writer.

Examples

use noodles_fasta as fasta;
let writer = fasta::io::Writer::new(Vec::new());

pub fn write_record(&mut self, record: &Record) -> Result<()>

Writes a FASTA record.

By default, sequence lines are hard wrapped at 80 bases. This can be changed by using Builder::set_line_base_count when creating the writer.

Examples

use noodles_fasta::{self as fasta, record::{Definition, Sequence}};

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

let definition = Definition::new("sq0", None);
let sequence = Sequence::from(b"ACGT".to_vec());
let record = fasta::Record::new(definition, sequence);

writer.write_record(&record)?;

assert_eq!(writer.get_ref(), b">sq0\nACGT\n");