optz 0.7.0

A no-magic option parser for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

# optz

A no-magic option parser for Rust.

`optz` provides a simple, flexible, and minimalistic way to parse
command-line options in Rust applications. It focuses on clarity
and control, avoiding "magic" behavior in favor of explicit
configuration.


## Usage

### Basic Example

```rust
use optz::{Opt, Optz};

let optz = Optz::new("myapp")
  .option(
    Opt::flag("verbose")
      .description("Enable verbose mode")
      .short("-v")
  )
  .option(
    Opt::arg("num-items")
      .description("Number of items to process")
      .default_value("5")
  )
  .parse()
  .unwrap();

if optz.get("verbose").unwrap().unwrap() {
  println!("Verbose mode enabled");
}

let count: u32 = optz.get("num-items").unwrap().unwrap();
println!("Processing {} items", count);
```

### Example with Configuration

```rust
#[derive(Debug, PartialEq)]
struct MyConfig {
  value: i32,
}

let config = MyConfig { value: 42 };
let optz = Optz::new("myapp")
  .config(config)
  .option(
    Opt::flag("verbose")
      .description("Enable verbose output")
      .short("-v")
  )
  .parse()
  .unwrap();

let retrieved: &MyConfig = optz.get_config().unwrap();
assert_eq!(*retrieved, MyConfig { value: 42 });
```

### Example with Handlers

```rust
fn my_handler(_optz: &Optz) -> Result<(), OptzError> {
  println!("Custom handler called!");
  Ok(())
}

let optz = Optz::from_args("test", vec!["test", "--custom"])
  .option(
    Opt::flag("custom")
      .description("Trigger custom logic")
      .handler(my_handler)
  )
  .parse()
  .unwrap();
```


## TODO

- [ ] Check types during parsing instead of at `get()`