Struct noodles_gff::io::Writer

source ·
pub struct Writer<W> { /* private fields */ }
Expand description

A GFF writer.

Implementations§

source§

impl<W> Writer<W>
where W: Write,

source

pub fn new(inner: W) -> Self

Creates a GFF writer.

§Examples
use noodles_gff as gff;
let writer = gff::io::Writer::new(Vec::new());
source

pub fn get_ref(&self) -> &W

Returns a reference to the underlying writer.

§Examples
use noodles_gff as gff;
let writer = gff::io::Writer::new(Vec::new());
assert!(writer.get_ref().is_empty());
source

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

Writes a Line.

§Examples
use noodles_gff as gff;
use gff::line::Line;

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

let version = Line::Directive(gff::Directive::GffVersion(Default::default()));
writer.write_line(&version)?;

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

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

let expected = b"##gff-version 3
#noodles
.\t.\t.\t1\t1\t.\t.\t.\t.
";

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

pub fn write_directive(&mut self, directive: &Directive) -> Result<()>

Writes a GFF directive.

§Examples
use noodles_gff as gff;

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

let version = gff::Directive::GffVersion(Default::default());
writer.write_directive(&version)?;

assert_eq!(writer.get_ref(), b"##gff-version 3\n");
source

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

Writes a GFF record.

§Examples
use noodles_gff as gff;

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

let version = gff::Directive::GffVersion(Default::default());
writer.write_directive(&version)?;

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

let expected = b"##gff-version 3
.\t.\t.\t1\t1\t.\t.\t.\t.
";

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

Auto Trait Implementations§

§

impl<W> Freeze for Writer<W>
where W: Freeze,

§

impl<W> RefUnwindSafe for Writer<W>
where W: RefUnwindSafe,

§

impl<W> Send for Writer<W>
where W: Send,

§

impl<W> Sync for Writer<W>
where W: Sync,

§

impl<W> Unpin for Writer<W>
where W: Unpin,

§

impl<W> UnwindSafe for Writer<W>
where W: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.