Struct pager_rs::State

pub struct State {
    pub pos: (usize, usize),
    pub size: (u16, u16),
    pub content: String,
    pub status_bar: StatusBar,
    pub commands: CommandList,
    pub show_line_numbers: bool,
    // some fields omitted
}

Fields

pos: (usize, usize)

Cursor position in content.

(x, y)

size: (u16, u16)

Size of terminal screen.

(width, height)

content: String

Content to show.

status_bar: StatusBar

status bar at the bottom.

commands: CommandList

show_line_numbers: bool

Implementations

impl State

pub fn new(
    content: String,
    status_bar: StatusBar,
    commands: CommandList
) -> Result<Self>

Create new State

pub fn is_running(&self) -> bool

pub fn quit(&mut self)

Terminate State

pub fn get_help_text(&self) -> String

Default help text formatter

impl State

pub fn get_visible(&self) -> String

Get text to be printed on terminal except for the StatusBar.

impl State

pub fn up(&mut self) -> bool

Move cursor up.

pub fn down(&mut self) -> bool

Move cursor down.

pub fn left(&mut self) -> bool

Move cursor left.

pub fn right(&mut self) -> bool

Move cursor right.

pub fn pgup(&mut self) -> bool

Move cursor one page up.

pub fn pgdown(&mut self) -> bool

Move cursor one page down.

pub fn home(&mut self) -> bool

Move cursor to the start.

pub fn end(&mut self) -> bool

Move cursor to the end.

impl State

pub fn match_key_event(&mut self, code: KeyCode) -> bool

Find and execute command matching with pressed key.