Struct State

pub struct State<'a> {
    pub pos: (usize, usize),
    pub size: (u16, u16),
    pub content: String,
    pub status_bar: StatusBar,
    pub commands: CommandList,
    pub show_line_numbers: bool,
    pub word_wrap: bool,
    pub word_wrap_option: Options<'a>,
    /* private fields */
}

State that can be ran with pager_rs::run

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

List of Commands that runnable in this State.

show_line_numbers: bool

Show/Hide line numbers.

word_wrap: bool

Enable/Disable word-wrap

word_wrap_option: Options<'a>

textwrap::Options to use when word-wrap is enabled.

The width is not important since it will be replaced by terminal screen width when rendering text.

Implementations

impl<'a> State<'a>

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

Create new State

Examples found in repository

examples/hello_world.rs (line 10)

fn main() -> std::io::Result<()> {
    let content = r#"fn main() {
    println!("Hello World!");
}"#
    .to_string();

    let status_bar = StatusBar::new("Hello World program in rust".to_string());

    let mut state = State::new(content, status_bar, CommandList::default())?;

    pager_rs::init()?;

    pager_rs::run(&mut state)?;

    pager_rs::finish()?;

    Ok(())
}

examples/custom_bar_theme.rs (line 18)

fn main() -> std::io::Result<()> {
    let content = r#"fn main() {
    println!("Hello World!");
}"#
    .to_string();

    let theme = ContentStyle::new()
        .with(Color::White)
        .on(Color::Red)
        .attribute(Attribute::Italic);
    let status_bar = StatusBar::with_theme(
        "Hello World program in rust with colored status bar".to_string(),
        theme,
    );

    let mut state = State::new(content, status_bar, CommandList::default())?;

    pager_rs::init()?;

    pager_rs::run(&mut state)?;

    pager_rs::finish()?;

    Ok(())
}

examples/read_file.rs (line 15)

fn main() -> std::io::Result<()> {
    let args: Vec<String> = env::args().collect();

    if args.len() >= 2 {
        let file_name = args[1].clone();

        let mut file = File::open(file_name.clone())?;
        let mut content = String::new();
        file.read_to_string(&mut content)?;

        let status_bar = StatusBar::new(file_name);

        let mut state = State::new(content, status_bar, CommandList::default())?;

        pager_rs::init()?;

        pager_rs::run(&mut state)?;

        pager_rs::finish()?;
    } else {
        eprintln!("Missing Filename");
    }

    Ok(())
}

examples/custom_command.rs (lines 21-47)

fn main() -> std::io::Result<()> {
    let content = r#"Lorem ipsum dolor sit amet, consectetur adipiscing
elit. Pellentesque neque nulla, viverra ac sapien
et, ultricies convallis lectus. Suspendisse mattis
in urna quis efficitur. Quisque mollis vulputate ipsum,
ut auctor risus luctus eu. Donec sagittis convallis erat
eget imperdiet. Aliquam massa erat, venenatis eu massa at,
dignissim tempus massa. Donec blandit augue et malesuada
fermentum. In vehicula, nisl ut scelerisque sagittis,
sapien elit gravida enim, eu feugiat magna arcu sed enim.
Fusce accumsan sodales ipsum lobortis feugiat. Pellentesque
quam lectus, molestie vitae nisi a, tempor mollis mauris.
Maecenas in magna tempus, porta augue bibendum, feugiat nulla."#
        .to_string();

    let status_bar =
        StatusBar::new("Press 'p' to open selected line on seperate instance".to_string());

    let mut state = State::new(
        content,
        status_bar,
        CommandList::combine(vec![
            CommandList(vec![Command {
                cmd: vec![CommandType::Key(KeyCode::Char('p'))],
                desc: "Open selected line on seperate instance".to_string(),
                func: &|state| {
                    let commands =
                        CommandList::combine(vec![CommandList::quit(), CommandList::navigation()]);

                    let mut modal = State::new(
                        state.content.lines().nth(state.pos.1).unwrap().to_string(),
                        StatusBar::new("Quit (q)".to_string()),
                        commands,
                    )
                    .unwrap();
                    modal.show_line_numbers = false;
                    run(&mut modal).unwrap();
                    true
                },
            }]),
            CommandList::quit(),
            CommandList::navigation(),
            CommandList::help(),
        ]),
    )?;
    state.show_line_numbers = false;

    pager_rs::init()?;

    pager_rs::run(&mut state)?;

    pager_rs::finish()?;

    Ok(())
}

pub fn is_running(&self) -> bool

Returns true if the State is still runing.

pub fn quit(&mut self)

Terminate State

pub fn get_help_text(&self) -> String

Default help text formatter

impl<'a> State<'a>

pub fn get_visible(&self) -> String

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

impl<'a> State<'a>

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<'a> State<'a>

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

Find and execute command matching with pressed key.