Struct bio::io::fastq::Writer

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

A FastQ writer.

Implementations

impl Writer<File>

pub fn to_file<P: AsRef<Path>>(path: P) -> Result<Self>

Write to a given file path.

pub fn to_file_with_capacity<P: AsRef<Path>>(
    capacity: usize,
    path: P
) -> Result<Self>

Write to the given file path and a buffer capacity

impl<W: Write> Writer<W>

pub fn new(writer: W) -> Self

Write to a given io::Write.

pub fn with_capacity(capacity: usize, writer: W) -> Self

Create a new Fastq writer with a capacity of write buffer

pub fn from_bufwriter(bufwriter: BufWriter<W>) -> Self

Create a new Fastq writer with a given BufWriter

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

Directly write a FastQ record.

pub fn write(
    &mut self,
    id: &str,
    desc: Option<&str>,
    seq: TextSlice<'_>,
    qual: &[u8]
) -> Result<()>

Write a FastQ record with given id, optional description, sequence and qualities.

pub fn flush(&mut self) -> Result<()>

Flush the writer, ensuring that everything is written.

Trait Implementations

impl<W: Debug + Write> Debug for Writer<W>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.