Mirrors/clap
2
0
Fork 0
mirror of https://github.com/clap-rs/clap synced 2024-12-12 13:52:34 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs(examples): Show IP Address

Browse source
This commit is contained in:
Ed Page 2022-03-14 09:53:31 -05:00
parent 4842f07045
commit bdd5cf17f8
2 changed files with 22 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
examples/typed-derive.md
View file

@ -11,6 +11,7 @@ USAGE:
typed-derive[EXE] [OPTIONS]
OPTIONS:
--bind <BIND> Handle IP addresses
-D <DEFINES> Hand-written parser for tuples
-h, --help Print help information
-I <DIR> Allow invalid UTF-8 paths
@ -22,7 +23,7 @@ OPTIONS:
Optimization-level (number)
```console
$ typed-derive -O 1
Args { optimization: Some(1), include: None, sleep: None, defines: [] }
Args { optimization: Some(1), include: None, bind: None, sleep: None, defines: [] }
$ typed-derive -O plaid
? failed
@ -35,14 +36,27 @@ For more information try --help
Include (path)
```console
$ typed-derive -I../hello
Args { optimization: None, include: Some("../hello"), sleep: None, defines: [] }
Args { optimization: None, include: Some("../hello"), bind: None, sleep: None, defines: [] }
```
IP Address
```console
$ typed-derive --bind 192.0.0.1
Args { optimization: None, include: None, bind: Some(192.0.0.1), sleep: None, defines: [] }
$ typed-derive --bind localhost
? failed
error: Invalid value "localhost" for '--bind <BIND>': invalid IP address syntax
For more information try --help
```
Time
```console
$ typed-derive --sleep 10s
Args { optimization: None, include: None, sleep: Some(Duration(10s)), defines: [] }
Args { optimization: None, include: None, bind: None, sleep: Some(Duration(10s)), defines: [] }
$ typed-derive --sleep forever
? failed
@ -55,7 +69,7 @@ For more information try --help
Defines (key-value pairs)
```console
$ typed-derive -D Foo=10 -D Alice=30
Args { optimization: None, include: None, sleep: None, defines: [("Foo", 10), ("Alice", 30)] }
Args { optimization: None, include: None, bind: None, sleep: None, defines: [("Foo", 10), ("Alice", 30)] }
$ typed-derive -D Foo
? failed

4
examples/typed-derive.rs
View file

@ -13,6 +13,10 @@ struct Args {
#[clap(short = 'I', parse(from_os_str), value_name = "DIR", value_hint = clap::ValueHint::DirPath)]
include: Option<std::path::PathBuf>,
/// Handle IP addresses
#[clap(long)]
bind: Option<std::net::IpAddr>,
/// Allow human-readable durations
#[clap(long)]
sleep: Option<humantime::Duration>,