proceed

Crates.ioproceed
lib.rsproceed
version0.1.0
sourcesrc
created_at2018-07-30 14:55:01.51313
updated_at2020-09-11 03:40:14.00289
descriptionA simple rust cli abstraction for accepting user-input.
homepage
repositoryhttps://git.sr.ht/~dstar4138/proceed
max_upload_size
id76652
size17,118
Dean (dstar4138)

documentation

README

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.
}
Commit count: 0

cargo fmt