#cli #structopt #clap #derive

structopt-toml

An default value loader from TOML for structopt

14 releases

0.4.5 May 6, 2020
0.4.4 Apr 30, 2020
0.4.2 Mar 12, 2020
0.4.0 Jan 7, 2019
0.1.2 Mar 19, 2018

#48 in Command-line interface

Download history 433/week @ 2021-02-26 264/week @ 2021-03-05 89/week @ 2021-03-12 98/week @ 2021-03-19 96/week @ 2021-03-26 103/week @ 2021-04-02 50/week @ 2021-04-09 51/week @ 2021-04-16 211/week @ 2021-04-23 1016/week @ 2021-04-30 1636/week @ 2021-05-07 1660/week @ 2021-05-14 2158/week @ 2021-05-21 1832/week @ 2021-05-28 2078/week @ 2021-06-04 1063/week @ 2021-06-11

1,785 downloads per month
Used in 2 crates

MIT/Apache

9KB
84 lines

structopt-toml

An default value loader from TOML for structopt. It combinates with structopt.

Actions Status Crates.io Docs.rs codecov

Usage

This crate must be used with serde, serde_derive, structopt, and toml explicitly.

[dependencies]
serde          = "1.0.104"
serde_derive   = "1.0.104"
structopt      = "0.3.11"
structopt-toml = "0.4.5"
toml           = "0.5.6"

Example

If derive(Deserialize), derive(StructOptToml) and serde(default) are added to the struct with derive(StructOpt), some functions like from_args_with_toml can be used.

use serde_derive::Deserialize;
use structopt::StructOpt;
use structopt_toml::StructOptToml;

#[derive(Debug, Deserialize, StructOpt, StructOptToml)]
#[serde(default)]
struct Opt {
    #[structopt(default_value = "0", short = "a")] a: i32,
    #[structopt(default_value = "0", short = "b")] b: i32,
}

fn main() {
    let toml_str = r#"
        a = 10
    "#;
    let opt = Opt::from_args_with_toml(toml_str).expect("toml parse failed");
    println!("a:{}", opt.a);
    println!("b:{}", opt.b);
}

The execution result is below.

$ ./example
a:10        // value from TOML string
b:0         // value from default_value of structopt

$ ./example -a 20
a:20        // value from command line argument
b:0

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~2–3MB
~62K SLoC