aopt-core 1.0.4

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

pub(crate) mod action;
pub(crate) mod index;
pub(crate) mod style;

use std::any::TypeId;
use std::fmt::Debug;

use crate::value::ValAccessor;
use crate::Error;
use crate::Uid;

pub use self::action::Action;
pub use self::index::Index;
pub use self::style::Style;

pub const BOOL_TRUE: &str = "true";

pub const BOOL_FALSE: &str = "false";

pub trait Opt: Debug {
    fn reset(&mut self);

    /// The Uid of option.
    fn uid(&self) -> Uid;

    /// The name of option.
    fn name(&self) -> &str;

    /// The type of option.
    fn r#type(&self) -> &TypeId;

    /// The help hint of option such as `--flag`.
    fn hint(&self) -> &str;

    /// The help message of option.
    fn help(&self) -> &str;

    fn valid(&self) -> bool;

    /// If the option matched.
    fn matched(&self) -> bool;

    /// If the option is force required.
    fn force(&self) -> bool;

    /// The associaed action of option.
    fn action(&self) -> &Action;

    /// The index of option.
    fn index(&self) -> Option<&Index>;

    /// The alias the option.
    fn alias(&self) -> Option<&Vec<String>>;

    fn accessor(&self) -> &ValAccessor;

    fn accessor_mut(&mut self) -> &mut ValAccessor;

    fn ignore_alias(&self) -> bool;

    fn ignore_name(&self) -> bool;

    fn ignore_index(&self) -> bool;

    fn set_uid(&mut self, uid: Uid);

    fn set_matched(&mut self, matched: bool);

    fn mat_style(&self, style: Style) -> bool;

    fn mat_force(&self, force: bool) -> bool;

    fn mat_name(&self, name: Option<&str>) -> bool;

    fn mat_alias(&self, name: &str) -> bool;

    fn mat_index(&self, index: Option<(usize, usize)>) -> bool;

    fn init(&mut self) -> Result<(), Error>;

    fn set_name(&mut self, name: impl Into<String>) -> &mut Self;

    fn set_type(&mut self, r#type: TypeId) -> &mut Self;

    fn set_value(&mut self, value: ValAccessor) -> &mut Self;

    fn set_hint(&mut self, hint: impl Into<String>) -> &mut Self;

    fn set_help(&mut self, help: impl Into<String>) -> &mut Self;

    fn set_action(&mut self, action: Action) -> &mut Self;

    fn set_style(&mut self, styles: Vec<Style>) -> &mut Self;

    fn set_index(&mut self, index: Option<Index>) -> &mut Self;

    fn set_force(&mut self, force: bool) -> &mut Self;

    fn add_alias(&mut self, name: impl Into<String>) -> &mut Self;

    fn rem_alias(&mut self, name: &str) -> &mut Self;

    fn set_ignore_name(&mut self, ignore_name: bool) -> &mut Self;

    fn set_ignore_alias(&mut self, ignore_alias: bool) -> &mut Self;

    fn set_ignore_index(&mut self, ignore_index: bool) -> &mut Self;
}