cmd-args 0.2.0

Command line argument parser with nested command support
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

use std::rc::Rc;
use crate::option;
use std::collections::HashSet;

/// Description of an option.
pub struct Descriptor {
    name: Rc<String>,
    aliases: HashSet<String>,
    value_type: option::Type,
    description: String,
}

impl Descriptor {
    /// Create a new option descriptor.
    pub fn new(name: &str, value_type: option::Type, description: &str) -> Self {
        Descriptor {
            name: Rc::new(String::from(name)),
            aliases: HashSet::new(),
            value_type,
            description: String::from(description),
        }
    }

    /// Get the name of the option.
    pub fn name(&self) -> &String {
        &self.name
    }

    /// Take a reference to the name of the option.
    pub fn take_name(&self) -> Rc<String> {
        Rc::clone(&self.name)
    }

    /// Get the type of the option value.
    pub fn value_type(&self) -> &option::Type {
        &self.value_type
    }

    /// Get the description of the option.
    pub fn description(&self) -> &String {
        &self.description
    }

    /// Add an alias to the option.
    pub fn add_alias(mut self, alias: &str) -> Self {
        self.aliases.insert(String::from(alias));

        self
    }

    /// Get aliases.
    pub fn get_aliases(&self) -> &HashSet<String> {
        &self.aliases
    }
}