1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
//! FASTA writer.
mod builder;
mod record;
use std::io::{self, Write};
pub use self::builder::Builder;
use self::record::write_record;
use crate::Record;
/// A FASTA writer.
pub struct Writer<W> {
inner: W,
line_base_count: usize,
}
impl<W> Writer<W>
where
W: Write,
{
/// Creates a FASTA writer.
///
/// # Examples
///
/// ```
/// use noodles_fasta as fasta;
/// let writer = fasta::io::Writer::new(Vec::new());
/// ```
pub fn new(inner: W) -> Self {
Builder::default().build_with_writer(inner)
}
/// Returns a reference to the underlying writer.
///
/// # Examples
///
/// ```
/// use noodles_fasta as fasta;
/// let writer = fasta::io::Writer::new(Vec::new());
/// assert!(writer.get_ref().is_empty());
/// ```
pub fn get_ref(&self) -> &W {
&self.inner
}
/// 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 std::io;
/// 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");
/// # Ok::<(), io::Error>(())
/// ```
pub fn write_record(&mut self, record: &Record) -> io::Result<()> {
write_record(&mut self.inner, record, self.line_base_count)
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_new() {
let writer = Writer::new(Vec::new());
assert_eq!(writer.line_base_count, 80);
}
}