Trait needletail::formats::RecParser

pub trait RecParser<'s>: Sized + Iterator {
    type Header;
    fn from_buffer(buf: &'s [u8], last: bool) -> Self;
    fn header(&mut self) -> Result<Self::Header, ParseError>;
    fn eof(&self) -> Result<(), ParseError>;
    fn used(&self) -> usize;
}

[⚠️Unstable] RecParser is an adaptor trait that allows new file format parsers to be defined. It takes a chunk from a RecBuffer (from_reader), optionally parses an initial header out (header) and then provides an iterator interface to parse a record stream. When finished, it provides an eof function to determine if the stream is completely exhausted.

Associated Types

type Header

Loading content...

Required methods

fn from_buffer(buf: &'s [u8], last: bool) -> Self

fn header(&mut self) -> Result<Self::Header, ParseError>

fn eof(&self) -> Result<(), ParseError>

fn used(&self) -> usize

Loading content...

Implementors

impl<'a> RecParser<'a> for FastaParser<'a>

type Header = ()

Important traits for FastaParser<'a>

impl<'a> Iterator for FastaParser<'a> type Item = Result<FastaRecord<'a>, ParseError>;

fn from_buffer(buf: &[u8], last: bool) -> FastaParser

fn header(&mut self) -> Result<Self::Header, ParseError>

fn eof(&self) -> Result<(), ParseError>

fn used(&self) -> usize

impl<'a> RecParser<'a> for FastqParser<'a>

type Header = ()

Important traits for FastqParser<'a>

impl<'a> Iterator for FastqParser<'a> type Item = Result<FastqRecord<'a>, ParseError>;

fn from_buffer(buf: &[u8], last: bool) -> FastqParser

fn header(&mut self) -> Result<Self::Header, ParseError>

fn eof(&self) -> Result<(), ParseError>

fn used(&self) -> usize

Loading content...