crossterm_input 0.1.0

A cross-platform library for reading userinput.

Crossterm Input | cross-platform input reading .

Lines of Code Latest Version MIT docs Lines of Code

This crate allows you to read the user input cross-platform. It supports all UNIX and windows terminals down to windows 7 (not all terminals are tested see Tested Terminals for more info)

This crate is a sub-crate of crossterm to read the user input, and can be use individually.

Other sub-crates are:

When you want to use other modules as well you might want to use crossterm with feature flags

Table of contents:

Getting Started

This documentation is only for crossterm_input version 0.1 if you have an older version I suggest you check the Upgrade Manual. Also, check out the examples folders with detailed examples for all functionality of this crate.

Add the crossterm_input package to your Cargo.toml file.

[dependencies]
`crossterm_input` = "0.1"

And import the crossterm_input modules you want to use.

extern crate crossterm_input;

pub use crossterm_input::{input, AsyncReader, KeyEvent, TerminalInput};

Useful Links

Features

These are the features of this crate:

  • Cross-platform
  • Everything is multithreaded (Send, Sync)
  • Detailed documentation on every item
  • Very few dependenties.
  • Input
    • Read character
    • Read line
    • Read async
    • Read async until
    • Wait for key event (terminal pause)

Planned features:

  • Read mouse events
  • Read special keys events

Examples

Check out the examples for more information about how to use this crate.

use crossterm_input::input;

let mut input = input();

 match input.read_char() {
    Ok(s) => println!("char typed: {}", s),
    Err(e) => println!("char error : {}", e),
 }
 
 match input.read_line() {
     Ok(s) => println!("string typed: {}", s),
     Err(e) => println!("error: {}", e),
 }

Tested terminals

  • Windows Powershell
    • Windows 10 (pro)
  • Windows CMD
    • Windows 10 (pro)
    • Windows 8.1 (N)
  • Ubuntu Desktop Terminal
    • Ubuntu 17.10
  • (Arch, Manjaro) KDE Konsole
  • Linux Mint

This crate supports all Unix terminals and windows terminals down to Windows 7 but not all of them have been tested. If you have used this library for a terminal other than the above list without issues feel free to add it to the above list, I really would appreciate it.

Notice

This library is average stable now, I don't expect it to not to change that much. If there are any changes that will affect previous versions I will describe what to change to upgrade.

Contributing

I highly appreciate it when you are contributing to this crate. Also Since my native language is not English my grammar and sentence order will not be perfect. So improving this by correcting these mistakes will help both me and the reader of the docs.

Authors

  • Timon Post - Project Owner & creator

License

This project is licensed under the MIT License - see the LICENSE.md file for details