Struct gchemol_parser::GrepReader

pub struct GrepReader { /* private fields */ }

Quick grep text by marking the line that matching a pattern, suitable for very large text file.

Implementations

impl GrepReader

pub fn try_from_path(p: &Path) -> Result<Self>

Build from file in path

pub fn mark( &mut self, pattern: &str, max_count: impl Into<Option<usize>> ) -> Result<usize>

Mark positions that matching pattern, so that we can seek these positions later. Regex can be used in pattern. Return the number of marked positions.

Paramters

• max_count: exits search if max_count matches reached.

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 num_markers(&self) -> usize

Return the number of marked positions.

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

Goto the next position that marked. Return marker position on success. Return Err if already reached the last marker or other errors.

pub fn goto_marker(&mut self, marker_index: usize) -> Result<u64>

Goto the marked position in marker_index. Will panic if marker_index out of range.

pub fn read_lines(&mut self, n: usize, buffer: &mut String) -> Result<()>

Return n lines in string on success from current position. Return error if reached EOF early.

pub fn get_mut(&mut self) -> &mut BufReader<File>

Gets a mutable reference to the underlying reader.

pub fn view_lines(&mut self, n: usize) -> Result<TextViewer>

View next n lines like in a normal text viewer. This method will forward the cursor by n lines.

pub fn read_until_next_marker(&mut self, s: &mut String) -> Result<()>

Return text from current position to the next marker or file end. It method will forward the cursor to the next marker.

pub fn view_until_next_marker(&mut self) -> Result<TextViewer>

View all lines until next marker like in a normal text viewer. It method will forward the cursor to the next marker.

Trait Implementations

impl Debug for GrepReader

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

Formats the value using the given formatter.