Struct TextViewer

pub struct TextViewer { /* private fields */ }

A simple line-based text viewer 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 text(&self) -> &str

Return str slice of inner text.

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 goto_first_line(&mut self)

Move the cursor to the beginning of the first line.

pub fn goto_last_line(&mut self)

Move the cursor to the beginning of the last line.

pub fn goto_next_line(&mut self)

Move the cursor to the beginning of the next line.

pub fn goto_previous_line(&mut self)

Move the cursor to the beginning of the previous line.

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

Move the cursor to the line matching pattern. Regex pattern is allowed. Return current line number after search.

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

Search backward from current point for pattern. Return current line number after search.

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

Peek line n without moving cursor.

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

Peek the text between line n and m (including line m), without moving cursor.

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

Select the next n lines from current point without moving cursor, including current line.

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

Select part of the string in next n lines (including currrent line), in a rectangular area surrounded by columns in col_beg–col_end.

Trait Implementations

impl Clone for TextViewer

fn clone(&self) -> TextViewer

Returns a duplicate 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.