6 releases (breaking)
0.5.0 | Aug 30, 2024 |
---|---|
0.4.0 | Aug 27, 2024 |
0.3.0 | Jul 17, 2024 |
0.2.1 | Jun 6, 2024 |
0.1.0 | Mar 14, 2022 |
#151 in Command-line interface
932 downloads per month
Used in menu
145KB
3.5K
SLoC
noline
Noline is an IO-agnostic #[no_std]
line editor providing robust
line editing for any system. The core functionality is IO-free, so
it can be adapted to any system be it embedded, async, async
embedded, WASM or IPoAC (IP over Avian Carriers).
Features:
- IO-free
- Minimal dependencies
- No allocation needed - Both heap-based and static buffers are provided
- UTF-8 support
- Emacs keybindings
- Line history
Possible future features:
- Auto-completion and hints
The API should be considered experimental and will change in the future.
The core implementation consists of a state machine taking bytes as input and yielding iterators over byte slices. Because this is done without any IO, Noline can be adapted to work on any platform.
Noline comes with multiple implemenations:
sync_editor::Editor
– Editor for synchronous IOasync_editor::Editor
- Editor for asynchronous IO
Editors can be built using builder::EditorBuilder
.
Example
let prompt = "> ";
let mut io = MyIO {}; // IO handler, see full examples for details
// how to implement it
let mut editor = EditorBuilder::new_unbounded()
.with_unbounded_history()
.build_sync(&mut io)
.unwrap();
while let Ok(line) = editor.readline(prompt, &mut io) {
writeln!(io, "Read: '{}'", line).unwrap();
}
For more details, see docs.
Usage
Add this to your Cargo.toml:
[dependencies]
noline = "0.5.0"
License
MPL-2.0
Dependencies
~310–770KB
~17K SLoC