getch-rs

getch for Windows and Unix.

Usage

Cargo.toml

[dependencies]
getch-rs = "0.2"

main.rs

use getch_rs::Getch;

fn main() {
    let g = Getch::new();

    if let Ok(key) = g.getch() {
        println!("{:?}", key);
    }
}

Examples

$ cargo run --example getch

Contributing

This project welcomes your PR and issues. For example, fixing bugs, adding features, refactoring, etc.

lib.rs:

getch-rs

getch is a C language function designed to capture a single character input from the keyboard without requiring the user to press the Enter key. This function suspends program execution until the user provides input. Typically employed in console-based programs, it proves useful for scenarios where menu selection or awaiting key input is required.

Example

use getch_rs::{Getch, Key};

fn main() {
    let g = Getch::new();

    println!("press `q` to exit");

    loop {
        match g.getch() {
            Ok(Key::Char('q')) => break,
            Ok(key) => println!("{:?}", key),
            Err(e) => println!("{}", e),
        }
    }
}