#cli #structopt #clap #derive

macro structopt-toml-derive

A derive crate of structopt-toml

15 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

#3 in #structopt

Download history 150/week @ 2021-02-15 828/week @ 2021-02-22 318/week @ 2021-03-01 196/week @ 2021-03-08 55/week @ 2021-03-15 108/week @ 2021-03-22 99/week @ 2021-03-29 92/week @ 2021-04-05 69/week @ 2021-04-12 61/week @ 2021-04-19 632/week @ 2021-04-26 1463/week @ 2021-05-03 1333/week @ 2021-05-10 1481/week @ 2021-05-17 2086/week @ 2021-05-24 2166/week @ 2021-05-31

1,800 downloads per month
Used in 3 crates (via structopt-toml)

MIT/Apache

8KB
160 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

~335–760KB
~19K SLoC