Struct Reader

pub struct Reader<R> { /* private fields */ }

An async GFF reader.

Implementations

impl<R> Reader<R>

pub fn get_ref(&self) -> &R

Returns a reference to the underlying reader.

Examples

use noodles_gff as gff;
use tokio::io;
let reader = gff::r#async::io::Reader::new(io::empty());
let _inner = reader.get_ref();

pub fn get_mut(&mut self) -> &mut R

Returns a mutable reference to the underlying reader.

Examples

use noodles_gff as gff;
use tokio::io;
let mut reader = gff::r#async::io::Reader::new(io::empty());
let _inner = reader.get_mut();

pub fn into_inner(self) -> R

Unwraps and returns the underlying reader.

Examples

use noodles_gff as gff;
use tokio::io;
let reader = gff::r#async::io::Reader::new(io::empty());
let _inner = reader.into_inner();

impl<R> Reader<R>

where R: AsyncBufRead + Unpin,

pub fn new(inner: R) -> Self

Creates an async GFF reader.

Examples

use noodles_gff as gff;
use tokio::io;
let reader = gff::r#async::io::Reader::new(io::empty());

pub async fn read_line(&mut self, buf: &mut String) -> Result<usize>

Reads a raw GFF line.

Examples

use noodles_gff as gff;

let data = b"##gff-version 3\n";
let mut reader = gff::r#async::io::Reader::new(&data[..]);

let mut buf = String::new();
reader.read_line(&mut buf).await?;
assert_eq!(buf, "##gff-version 3");

pub async fn read_lazy_line(&mut self, line: &mut Line) -> Result<usize>

Reads a lazy line.

Examples

use noodles_gff::{self as gff, lazy};

let data = b"##gff-version 3\n";
let mut reader = gff::r#async::io::Reader::new(&data[..]);

let mut line = lazy::Line::default();
reader.read_lazy_line(&mut line).await?;
assert_eq!(line, lazy::Line::Directive(String::from("##gff-version 3")));

pub fn lines(&mut self) -> impl Stream<Item = Result<Line>> + '_

Returns a stream over lines.

Examples

use noodles_gff as gff;
use futures::TryStreamExt;

let data = b"##gff-version 3\n";
let mut reader = gff::r#async::io::Reader::new(&data[..]);
let mut lines = reader.lines();

let line = lines.try_next().await?;
assert!(matches!(line, Some(gff::Line::Directive(_))));

assert!(lines.try_next().await?.is_none());

pub fn records(&mut self) -> impl Stream<Item = Result<Record>> + '_

Returns a stream over records.

Examples

use noodles_gff as gff;
use futures::TryStreamExt;

let data = b"##gff-version 3\n";
let mut reader = gff::r#async::io::Reader::new(&data[..]);
let mut records = reader.records();

assert!(records.try_next().await?.is_none());