aboutsummaryrefslogtreecommitdiff
path: root/mingling
diff options
context:
space:
mode:
author魏曹先生 <1992414357@qq.com>2026-07-19 00:35:09 +0800
committer魏曹先生 <1992414357@qq.com>2026-07-19 00:35:09 +0800
commit501eb14dfca05813fa7a16f13f2efd9ba2b8c923 (patch)
tree2c1c7a58c50a2ac07a7eb9e3d698c33442430aea /mingling
parent5e460470f6ea2ce31a403b6e936ec2fe8f45312a (diff)
docs: add doc comments for Picker, AsPicker, and ProgramSetup traits
Diffstat (limited to 'mingling')
-rw-r--r--mingling/src/parser/picker.rs4
-rw-r--r--mingling/src/setups.rs4
2 files changed, 8 insertions, 0 deletions
diff --git a/mingling/src/parser/picker.rs b/mingling/src/parser/picker.rs
index 601cd3f..ca4561c 100644
--- a/mingling/src/parser/picker.rs
+++ b/mingling/src/parser/picker.rs
@@ -743,6 +743,10 @@ where
}
}
+/// Trait for types that can be converted into a `Picker` to extract values from command-line arguments.
+///
+/// This trait provides a convenient way to convert a value (such as `Vec<String>`, `&[String]`, etc.)
+/// into a `Picker` and immediately start extracting values associated with specific flags.
pub trait AsPicker
where
Self: Into<Vec<String>>,
diff --git a/mingling/src/setups.rs b/mingling/src/setups.rs
index a1290ff..6fd728a 100644
--- a/mingling/src/setups.rs
+++ b/mingling/src/setups.rs
@@ -7,6 +7,10 @@ pub use dirs::*;
mod exit_code;
pub use exit_code::*;
+/// Picker's `ProgramSetup` variant.
+///
+/// Internally does not use its own argument parsing,
+/// but relies on `arg_picker`'s argument parsing capability.
#[cfg(feature = "picker")]
pub mod picker;