rawcmd 0.6.3

Command-line application framework.
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

use std::str::FromStr;

/// Structure which holds flag summary.
#[derive(Debug, Clone, PartialEq)]
pub struct FlagSummary {
    name: String,
    alias: Option<String>,
    description: Option<String>,
    value: Option<String>,
    default_value: Option<String>,
    accepts_value: bool,
    provided: bool,
}

/// Structure implementation.
impl FlagSummary {

    // Returns new instance.
    pub fn with_name<
        S: Into<String>,
    >(
        name: S,
        alias: Option<String>,
        description: Option<String>,
        value: Option<String>,
        default_value: Option<String>,
        accepts_value: bool,
        provided: bool,
    ) -> Self {
        Self {
            name: name.into(),
            alias,
            description,
            value,
            default_value,
            accepts_value,
            provided,
        }
    }
}

/// Structure implementation.
impl FlagSummary {

    /// Returns name.
    pub fn name(&self) -> &String {
        &self.name
    }

    /// Returns alias.
    pub fn alias(&self) -> &Option<String> {
        &self.alias
    }

    /// Returns description.
    pub fn description(&self) -> &Option<String> {
        &self.description
    }

    /// Returns value.
    pub fn value(&self) -> &Option<String> {
        &self.value
    }

    /// Returns value.
    pub fn to_value<T>(&self) -> Option<T>
        where
        T: FromStr,
    {
        match &self.value {
            Some(v) => match v.parse::<T>() {
                Ok(v) => Some(v),
                Err(_) => None,
            },
            None => None,
        }
    }

    /// Returns default value.
    pub fn default_value(&self) -> &Option<String> {
        &self.default_value
    }

    /// Returns true if the flag has value.
    pub fn accepts_value(&self) -> bool {
        self.accepts_value
    }

    /// Returns true if the flag has value.
    pub fn provided(&self) -> bool {
        self.provided
    }
}