Struct gchemol_parser::TextViewer

pub struct TextViewer { /* private fields */ }

A simple text view for quick peeking part of text

Implementations

impl TextViewer

Constructor a TextViewer like a text reader in read-only mode, suitable for small file that can be fully read into memory.

pub fn from_str(txt: &str) -> Self

Create a view of text string.

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

Create a view of file context in path p

impl TextViewer

Core methods

pub fn num_lines(&self) -> usize

Total number of lines

pub fn current_line_num(&self) -> usize

Get line number at cursor

pub fn current_line(&self) -> &str

Peek the line at cursor

pub fn goto_line(&mut self, n: usize)

Move the cursor to line n, counting from line 1 at beginning of the text.

pub fn search_forward(&mut self, pattern: &str) -> Result<usize>

Move the cursor to the line matching pattern. Regex pattern is allowed.

pub fn peek_line(&self, n: usize) -> &str

Peek line n

pub fn peek_lines(&self, n: usize, m: usize) -> &str

Peek the text between line n and m (including line m)

pub fn column_selection(
    &self,
    line_beg: usize,
    line_end: usize,
    col_beg: usize,
    col_end: usize
) -> String

Return the part in a rectangular area of text

Trait Implementations

impl Clone for TextViewer

fn clone(&self) -> TextViewer

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TextViewer

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

Formats the value using the given formatter.