cli-rs 0.1.13

create clis with sophisticated completions
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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

use std::str::FromStr;

use crate::{
    cli_error::{CliError, CliResult},
    input::{Completor, Input, InputType},
};

// todo existence
// todo short flags with a space
// todo short flag-sets
pub struct Flag<'a, T: Default + FromStr + Clone> {
    pub name: String,
    pub description: Option<String>,
    pub value: Option<T>,
    pub bool_flag: bool,
    pub completor: Option<Completor<'a>>,
}

impl<'a> Flag<'a, bool> {
    pub fn bool(name: &str) -> Self {
        Self {
            name: name.to_string(),
            value: None,
            bool_flag: true,
            completor: None,
            description: None,
        }
    }
}

impl<'a, T: FromStr + Default + Clone> Flag<'a, T> {
    pub fn new(name: &str) -> Self {
        Self {
            name: name.to_string(),
            value: None,
            bool_flag: false,
            completor: None,
            description: None,
        }
    }

    pub fn get(&self) -> T {
        self.value.clone().unwrap_or_default()
    }

    pub fn description(mut self, description: &str) -> Self {
        self.description = Some(description.to_string());
        self
    }

    pub fn completor<F>(mut self, completor: F) -> Self
    where
        F: FnMut(&str) -> CliResult<Vec<String>> + 'a,
    {
        self.completor = Some(Box::new(completor));
        self
    }
}

impl<'a, T: FromStr + Default + Clone> Input for Flag<'a, T> {
    // for short flags with a space
    // should probably return a Result<bool, ParseError>
    fn parse(&mut self, token: &str) -> CliResult<bool> {
        // just handle the short flag first
        if token.len() == 2 && self.bool_flag {
            if &token[0..1] != "-" {
                // todo should this be an error?
                return Ok(false);
            }

            if token[1..2].to_uppercase() == self.name[0..1].to_uppercase() {
                self.value = Some("true".parse().unwrap_or_else(|_| unreachable!()));
                return Ok(true);
            }
        }

        // make it safe to index anywhere
        let min_size = self.name.len() + 2; // --
        if token.len() < min_size {
            return Ok(false);
        }

        // name check
        let flag_length = self.name.len();
        if token[2..flag_length + 2] != self.name {
            return Ok(false);
        }

        // extract value
        if let Some(eq_idx) = token.find('=') {
            let value = &token[eq_idx + 1..].to_string();

            self.value = Some(value.parse().map_err(|_| {
                CliError::from(format!("{} cannot be parsed for {}", value, self.name))
            })?);

            return Ok(true);
        }

        if self.bool_flag {
            self.value = Some("true".parse().unwrap_or_else(|_| unreachable!()));
            return Ok(true);
        }

        Ok(false)
    }

    fn display_name(&self) -> String {
        self.name.clone()
    }

    fn type_name(&self) -> InputType {
        InputType::Flag
    }

    fn parsed(&self) -> bool {
        self.value.is_some()
    }

    fn complete(&mut self, value: &str) -> CliResult<Vec<String>> {
        if let Some(completor) = &mut self.completor {
            completor(value)
        } else {
            Ok(vec![])
        }
    }

    fn is_bool_flag(&self) -> bool {
        self.bool_flag
    }

    fn description(&self) -> Option<String> {
        self.description.clone()
    }

    fn has_default(&self) -> bool {
        true
    }
}