Struct Reader

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

A FASTQ index reader.

Implementations

impl<R> Reader<R>

pub fn get_ref(&self) -> &R

Returns a reference to the underlying reader.

Examples

use noodles_fastq::fai;
let reader = fai::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_fastq::fai;
let mut reader = fai::io::Reader::new(io::empty());
let _inner = reader.get_mut();

pub fn into_inner(self) -> R

Returns the underlying reader.

Examples

use noodles_fastq::fai;
let reader = fai::io::Reader::new(io::empty());
let _inner = reader.into_inner();

impl<R> Reader<R>

where R: BufRead,

pub fn new(inner: R) -> Self

Creates a FASTQ index reader.

Examples

use noodles_fastq::fai;
let data = b"r0\t4\t4\t4\t5\t11\n";
let mut reader = fai::io::Reader::new(&data[..]);

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

Reads a raw FASTQ index record.

The given buffer will not include the trailing newline. It can subsequently be parsed as a [super::Record].

The position of the stream is expected to be at the start or at the start of another record.

If successful, this returns the number of bytes read from the stream. If the number of bytes read is 0, the stream reached EOF.

Examples

use noodles_fastq::fai;

let data = b"r0\t4\t4\t4\t5\t11\n";
let mut reader = fai::io::Reader::new(&data[..]);

let mut buf = String::new();
reader.read_record(&mut buf)?;

assert_eq!(buf, "r0\t4\t4\t4\t5\t11");

Trait Implementations

impl<R: Debug> Debug for Reader<R>

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

Formats the value using the given formatter.