aopt 1.4.3

A flexible and typed getopt tools
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

pub(crate) mod infer;

use std::ffi::OsStr;
use std::fmt::Debug;

pub use self::infer::Infer;
pub use self::infer::Placeholder;

pub use crate::acore::value::raw2str;
pub use crate::acore::value::AnyValue;
pub use crate::acore::value::ErasedValue;
pub use crate::acore::value::InitHandler;
pub use crate::acore::value::InitializeValue;
pub use crate::acore::value::RawValParser;
pub use crate::acore::value::StoreHandler;
pub use crate::acore::value::ValAccessor;
pub use crate::acore::value::ValInitializer;
pub use crate::acore::value::ValStorer;
pub use crate::acore::value::ValValidator;
pub use crate::acore::value::ValidatorHandler;

use crate::ctx::Ctx;
use crate::Error;

/// A special option value, can stop the policy, using for implement `--`.
///
/// # Example
/// ```
/// use aopt::prelude::*;
///
/// fn main() -> Result<(), Box<dyn std::error::Error>> {
///
///     let mut parser = AFwdParser::default();
///
///     parser.add_opt("stop".infer::<aopt::value::Stop>())?;
///
///     // -w will processed, it is set before `--`
///     parser.add_opt("-w=i")?;
///
///     // -o will not processed, it is set after `--`
///     parser.add_opt("-o=s")?;
///
///     // fo will processed, it is not an option
///     parser.add_opt("foo=p@1")?;
///
///     parser.parse(Args::from(["app", "-w=42", "--", "-o", "val", "foo"]))?;
///
///     assert_eq!(parser.find_val::<i64>("-w")?, &42);
///     assert!(parser.find_val::<String>("-o").is_err());
///     assert_eq!(parser.find_val::<bool>("foo")?, &true);
///     Ok(())
/// }
/// ```
///
/// ```plaintext
/// POSIX.1-2017
///
/// 12.2 Utility Syntax Guidelines
///
/// Guideline 10:
///
/// The first -- argument that is not an option-argument should be accepted as a delimiter indicating the end of options.
/// Any following arguments should be treated as operands, even if they begin with the '-' character.
/// ```
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, PartialOrd, Ord)]
pub struct Stop;

impl RawValParser for Stop {
    type Error = Error;

    fn parse(raw: Option<&OsStr>, ctx: &Ctx) -> Result<Self, Self::Error> {
        const STOP: &str = "--";

        if ctx.name()?.map(|v| v.as_ref()) == Some(STOP) {
            ctx.set_policy_act(crate::parser::Action::Stop);
            Ok(Stop)
        } else {
            Err(Error::sp_rawval(raw, "except `--` for Stop").with_uid(ctx.uid()?))
        }
    }
}

/// A special option value, using for implement `-`.
///
/// # Example
/// ```
/// use aopt::prelude::*;
///
/// fn main() -> Result<(), Box<dyn std::error::Error>> {
///
///     let mut parser = AFwdParser::default();
///
///     parser.set_strict(true);
///     parser.add_opt("stdin=b".infer::<std::io::Stdin>())?;
///
///     // -w will processed, it is set before `--`
///     parser.add_opt("-w=i")?;
///
///     // -o will not processed, it is set after `--`
///     parser.add_opt("-o=s")?;
///
///     // fo will processed, it is not an option
///     parser.add_opt("foo=p@1")?;
///
///     parser.parse(Args::from(
///         ["app", "-w=42", "-", "foo"].into_iter(),
///     ))?;
///
///     assert_eq!(parser.find_val::<i64>("-w")?, &42);
///     assert!(parser.find_val::<std::io::Stdin>("-").is_ok());
///     assert_eq!(parser.find_val::<bool>("foo")?, &true);
///     Ok(())
/// }
/// ```
pub enum DocTestForRawValParserStdin {}