Struct Writer

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

A GTF writer.

Implementations

impl<W> Writer<W>

pub fn get_ref(&self) -> &W

Returns a reference to the underlying writer.

Examples

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

pub fn into_inner(self) -> W

Returns the underlying writer.

Examples

use noodles_gtf as gtf;
let writer = gtf::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 GTF writer.

Examples

use noodles_gtf as gtf;
let writer = gtf::io::Writer::new(Vec::new());

Examples found in repository

examples/gtf_write.rs (line 11)

fn main() -> io::Result<()> {
    let stdout = io::stdout().lock();
    let mut writer = gtf::io::Writer::new(stdout);

    let record = gtf::Record::default();
    writer.write_record(&record)?;

    Ok(())
}

pub fn write_line(&mut self, line: &Line) -> Result<()>

Writes a Line.

Examples

use noodles_gtf as gtf;
use gtf::line::Line;

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

let version = Line::Comment(String::from("#format: gtf"));
writer.write_line(&version)?;

let comment = Line::Comment(String::from("noodles"));
writer.write_line(&comment)?;

let record = Line::Record(gtf::Record::default());
writer.write_line(&record)?;

let expected = b"##format: gtf
#noodles
.\t.\t.\t1\t1\t.\t.\t.\t
";

assert_eq!(&writer.get_ref()[..], &expected[..]);

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

Writes a GTF record.

Examples

use noodles_gtf as gtf;

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

let record = gtf::Record::default();
writer.write_record(&record)?;

let expected = b".\t.\t.\t1\t1\t.\t.\t.\t\n";
assert_eq!(writer.into_inner(), expected);

Examples found in repository

examples/gtf_write.rs (line 14)

fn main() -> io::Result<()> {
    let stdout = io::stdout().lock();
    let mut writer = gtf::io::Writer::new(stdout);

    let record = gtf::Record::default();
    writer.write_record(&record)?;

    Ok(())
}