Struct gchemol_parser::TextReader

pub struct TextReader<R: BufRead> { /* fields omitted */ }

Methods

impl TextReader<BufReader<File>>

pub fn from_path<P: AsRef<Path>>(p: P) -> Result<Self>

Build a text reader for file from path p.

impl<'a> TextReader<Cursor<&'a str>>

pub fn from_str(s: &'a str) -> Self

Build a text reader for string slice.

impl<R: Read> TextReader<BufReader<R>>

pub fn new(r: R) -> Self

Build a text reader from a struct implementing Read trait.

impl<R: BufRead + Seek> TextReader<R>

pub fn seek_line<F>(&mut self, f: F) -> Result<u64> where
    F: Fn(&str) -> bool, 

Skip reading until finding a matched line. Return the position before the matched line.

impl<R: BufRead> TextReader<R>

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

Read a new line into buf. Return the length of the new line. Note: the new line is forced to use unix style line ending.

pub fn lines(self) -> impl Iterator<Item = String>

Returns an iterator over the lines of this reader. Each string returned will not have a line ending.

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

Read all text into string buf.

impl<R: BufRead> TextReader<R>

Important traits for Partitions<R, P>

impl<R: BufRead, P: Partition> Iterator for Partitions<R, P> type Item = String;

pub fn partition_by<P: Partition>(self, p: P) -> Partitions<R, P>

Returns an iterator over n lines at a time.

impl<R: BufRead> TextReader<R>

Important traits for Chunks<R>

impl<R: BufRead> Iterator for Chunks<R> type Item = String;

pub fn chunks(self, nlines: usize) -> Chunks<R>

Returns an iterator over n lines at a time.

impl<R: BufRead> TextReader<R>

Important traits for Partitions<R, P>

impl<R: BufRead, P: Partition> Iterator for Partitions<R, P> type Item = String;

pub fn terminated_bunches<F>(self, f: F) -> Partitions<R, Terminated<F>> where
    F: Fn(&str) -> bool, 

Returns an iterator over n lines at a time.

impl<R: BufRead> TextReader<R>

Important traits for Partitions<R, P>

impl<R: BufRead, P: Partition> Iterator for Partitions<R, P> type Item = String;

pub fn preceded_bunches<F>(self, f: F) -> Partitions<R, Preceded<F>> where
    F: Fn(&str) -> bool, 

Returns an iterator over n lines at a time.

impl<R: BufRead> TextReader<R>

Important traits for Bunches<F, R>

impl<F, R> Iterator for Bunches<F, R> where
    F: Fn(&str) -> bool,
    R: BufRead,  type Item = Vec<String>;

pub fn bunches<F>(self, label_fn: F) -> Bunches<F, R> where
    F: Fn(&str) -> bool, 

Deprecated:

Plan to be removed

Return an iterator over a bunch of lines preceded by a label line.

Trait Implementations

impl<R: Debug + BufRead> Debug for TextReader<R>

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

Formats the value using the given formatter.