ragout 0.1.0

ragout - terminal Raw Mode Input Handler

ragout is a library crate offering shell functionalities inside the terminal raw mode.

Features

• input movements
  • move to start/end of input line
  • move to the next/prev item (basically a word)
• input deletion
  • delete whole input line
  • delete all input to the right/left of cursor
• history
  • save input to input history on user submission (hits enter/return)
  • navigate through saved history entries with the up/down keys
• exit the program with CTRL-C (uses std::process::exit())

Examples

default use case

use ragout::{init, run};

fn main() {
    // enter raw mode and initialize necessary variables
    let (mut sol, mut i, mut h, mut ui) = init();
    'main: loop {
        // catch and handle user actions,
        // if input was submitted bind its value to input var
        let input = run(&mut i, &mut h, &mut sol, &mut ui);

        // reset user input to empty string
        if !input.is_empty() {
            // do some stuff with the user input
            ui.clear();
        }
    }
}

License

Licensed under the MIT license.

WARN: This crate is still experimental, if something breaks, feel free to open an issue or make a pr.