entrance

Type sytem assisted command line argument parser

entrance provides type assisted tools for parsing command line arguments.

Simple usage

use entrance::*;
use std::env::args;

#[derive(Options)]
struct Opts {
    #[description = "Print the usage"]
    #[short = 'h']
    help: bool,

    #[description = "Print the version"]
    version: bool,
}

fn main() {
    let command: Command<Opts, ()> = Command::new(env!("CARGO_PKG_NAME"))
        .parse(args())
        .unwrap();

    if command.options().help {
        println!("{}", command.help());
    }

    if command.options().version {
        println!("{} {}", command.name(), env!("CARGO_PKG_VERSION"));
    }
}

Structs and traits

Command

This struct provides tools for parsing command line arguments.

Before parsing command line arguments, it is necessary to create the instance with the associated function new. Then, use parse or parse_options and parse_arguments.

If arguments should be parsed after checking options, use parse_options and parse_arguments. Otherwise, use parse simply.

Options

A derive macro is available for this.

Limitation: the macro supports only the struct with bool members.

Arguments