aboutsummaryrefslogtreecommitdiff
path: root/mingling_picker/README.md
diff options
context:
space:
mode:
author魏曹先生 <1992414357@qq.com>2026-07-17 04:04:11 +0800
committer魏曹先生 <1992414357@qq.com>2026-07-17 04:04:11 +0800
commitdc9d5ea0026a6cb6bb477d5db8e9190a79ecb337 (patch)
treefffa1630946e8299e25f805955cc3baa0479be0d /mingling_picker/README.md
parentb9f208deed7b8e012fbcd84202e2fb1d5eb8eeb9 (diff)
docs: add module-level documentation and improve doc comments
Diffstat (limited to 'mingling_picker/README.md')
-rw-r--r--mingling_picker/README.md17
1 files changed, 11 insertions, 6 deletions
diff --git a/mingling_picker/README.md b/mingling_picker/README.md
index c83bff4..db67825 100644
--- a/mingling_picker/README.md
+++ b/mingling_picker/README.md
@@ -22,15 +22,20 @@ mingling_picker = "0.3.0"
Provides a clean chained-call API for declaring arguments to parse:
```rust
+use mingling_picker::prelude::*;
+
let args: Vec<&str> = vec!["--name", "Bob", "--age", "24"];
-let result = args
- .pick(&flag![name: String])
+
+let (name, age) = args
+ .pick(&arg![name: String])
.or(|| "Alice".to_string())
- .pick(&flag![age: i32])
+ .pick(&arg![age: i32])
.or(|| 24)
.post(|num| num.clamp(0, 120))
- .parse();
-let (name, age): (String, i32) = a.unwrap();
+ .unwrap();
+
+assert_eq!(name, "Bob".to_string());
+assert_eq!(age, 24);
```
## Parsing Function Library
@@ -38,5 +43,5 @@ let (name, age): (String, i32) = a.unwrap();
Provides a pure function library `parselib` for analyzing the structure of command-line arguments.
```rust
-use mingling::picker::parselib::*;
+use mingling_picker::parselib::*;
```