#curses #tui

easycurses

A crate that makes working with curses easy

14 releases (9 breaking)

Uses old Rust 2015

0.13.0 Apr 20, 2020
0.12.2 Dec 15, 2018
0.12.1 Nov 6, 2018
0.10.0 Apr 8, 2018
0.4.0 Jul 24, 2017

#243 in Build Utils

Download history 30/week @ 2022-08-18 45/week @ 2022-08-25 51/week @ 2022-09-01 113/week @ 2022-09-08 39/week @ 2022-09-15 31/week @ 2022-09-22 81/week @ 2022-09-29 89/week @ 2022-10-06 22/week @ 2022-10-13 32/week @ 2022-10-20 77/week @ 2022-10-27 101/week @ 2022-11-03 77/week @ 2022-11-10 72/week @ 2022-11-17 19/week @ 2022-11-24 35/week @ 2022-12-01

217 downloads per month
Used in 3 crates

Zlib license

36KB
504 lines

License:0BSD CratesIO Travis-ci Appveyor

EasyCurses

A rust crate to smooth over the pain points of working with curses. Because it's based on pancurses, it works equally well with on both windows and unix computers.

Examples are available in the examples/ directory. The files are somewhat commented, and you can run any of them with cargo to see them in action.

cargo run --example <fileName>

Full API documentation available at docs.rs/easycurses

Terminal Safety

Normally when you're using curses there's a big danger that your program will leave the terminal in an unusable state where things don't print properly and stuff if your program exits on accident and you don't get your chance to call endwin properly. EasyCurses will safely cleanup the terminal and restore it to a useable state when your program closes via its Drop trait. No worries.

The catch is that you do have to only ever have one EasyCurses value active at once. Having two at once would let the initialization and shutdown get out of balance, and things would go bad. This is tracked with an AtomicBool value that's flipped on and off as appropriate.

Similarly, if you ever abort the program entirely there's no chance for cleanup, since an abort is an instant termination of the process. So, just don't ever compile with panic=abort, or use exit, or panic during an unwind, or anything else like that. At least not while an EasyCurses value is in scope somewhere within your call stack.

Stability

I would characterize the library as "largely stable". As laid out somewhere during the 1.0-level crate discussions, a crate can't rightly call itself 1.0 unless all the things it depends on are themselves 1.0, so no matter what this crate won't actually go to 1.0 before pancurses does.

License

This project is released into the public domain via The Unlicense. You are free to use it however you like with or without attribution. If you wish to contribute to the project then you must add your contributions under the same license.

Dependencies

~145–430KB