#cli #structopt #clap #derive

macro structopt-toml-derive

A derive crate of structopt-toml

17 releases

0.5.1 Jul 9, 2022
0.5.0 Jul 27, 2021
0.4.5 May 6, 2020
0.4.2 Mar 12, 2020
0.2.4 Mar 20, 2018

#5 in #structopt

Download history 418/week @ 2022-08-18 443/week @ 2022-08-25 257/week @ 2022-09-01 313/week @ 2022-09-08 322/week @ 2022-09-15 263/week @ 2022-09-22 302/week @ 2022-09-29 237/week @ 2022-10-06 185/week @ 2022-10-13 297/week @ 2022-10-20 203/week @ 2022-10-27 526/week @ 2022-11-03 153/week @ 2022-11-10 282/week @ 2022-11-17 203/week @ 2022-11-24 110/week @ 2022-12-01

811 downloads per month
Used in 3 crates (via structopt-toml)

MIT/Apache

8KB
163 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.5.1"
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

~230–640KB
~15K SLoC