#cli #term #terminal #input #ui

proceed

A simple rust cli abstraction for accepting user-input

1 unstable release

0.1.0 Sep 11, 2020
0.0.1 Jul 30, 2018

#410 in Command-line interface

Download history 10/week @ 2023-02-07 22/week @ 2023-02-14 17/week @ 2023-02-21 4/week @ 2023-02-28 9/week @ 2023-03-07 9/week @ 2023-03-14 8/week @ 2023-03-21 6/week @ 2023-03-28 6/week @ 2023-04-04 10/week @ 2023-04-11 5/week @ 2023-04-18 7/week @ 2023-04-25 23/week @ 2023-05-02 12/week @ 2023-05-09 17/week @ 2023-05-16 27/week @ 2023-05-23

80 downloads per month
Used in bhop

MIT license

13KB
216 lines

Proceed

Current Release: v0.1.0

License builds.sr.ht status Latest version Documentation

A simple set of common utility functions for checking with the user of your command line application.

  • proceed(bool) - Y/N with default.
  • any_or_quit_with(char) - Any key unless char for quit.

These are wrappers around a flexible user-input checker, so you can customize as needed.

Out-of-Scope:

  • no_std - We need std I/O.
  • Translations or handling string output in general. Use any of the i18n packages.

Examples:

Just check yes or no, with a default of either YES or NO.

use proceed::{proceed, NO};

fn main() {
    print!("Are you sure? [y/N]");
    if !proceed(NO) {
       return;
    }
    // Do things now that we got confirmation.
}

Continue on any user input (but 'q' for quit). Needs term feature enabled, otherwise user will need to press "Enter" afterwards.

use proceed::any_or_quit;

fn main() {
    println!("We are about to do something expensive.");
    print!("Press any key to continue, or 'q' to quit.");
    if !any_or_quit_with('q') {
        println!("Quitting.");
        return;
    }
    // Do expensive operation.
}

Dependencies

~25KB