Struct gchemol_parser::TextReader

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

A stream reader for large text file

Implementations

impl TextReader<BufReader<File>>

pub fn try_from_path(p: &Path) -> 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> TextReader<R>

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

Read a new line into buf.

NOTE

• This function will return the total number of bytes read.
• If this function returns Ok(0), the stream has reached EOF.

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 (Note: out of memory issue for large file)

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

pub fn peek_line(&mut self) -> Result<String>

Peek next line without moving cursor.

pub fn seek_line<F>(&mut self, f: F) -> Result<usize>

where F: FnMut(&str) -> bool,

Skip reading until finding a matched line. Return the number of bytes read in before the matched line. Return error if not found.

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

where F: FnMut(&str) -> bool,

Read lines into buf until f closure predicates true. Return total bytes read into buf.

NOTE

• the line matching predicate is not included into buf

pub fn goto_start(&mut self)

Goto the start of inner file.

pub fn goto_end(&mut self)

Goto the end of inner file.

pub fn get_current_position(&mut self) -> Result<u64>

Returns the current seek position from the start of the stream.

pub fn goto(&mut self, pos: u64) -> Result<()>

Goto to an absolute position, in bytes, in a text stream.

pub fn goto_relative(&mut self, offset: i64) -> Result<u64>

Sets the offset to the current position plus the specified number of bytes. If the seek operation completed successfully, this method returns the new position from the start of the stream.

Trait Implementations

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

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

Formats the value using the given formatter.