aargvark 0.9.6

Self-similar argument parsing
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

use {
    crate::{
        base::{
            VarkState,
            R,
        },
        help::{
            HelpPattern,
            HelpState,
        },
    },
};

/// This method provides completions when `vark()` is invoked in the completion
/// mode.
///
/// This should produce a list of completion options, where each completion is a
/// list of command line arguments. The shell will replace the last partial
/// argument and add additional elements from the selected option.
///
/// The arguments will be automatically quoted and concatenated with spaces as
/// necessary for the output shell.
///
/// In most cases, each element will be a single-element vec (i.e. for file
/// completions, each element would be a vec containing one filename).
pub type AargvarkCompleter = Box<dyn Fn() -> Vec<Vec<String>>>;

/// This is a completer that returns no options, for use in types with no sensible
/// completion functionality.
pub fn empty_completer() -> AargvarkCompleter {
    return Box::new(|| vec![]);
}

/// Anything that implements this trait can be parsed and used as a field in other
/// parsable enums/structs.
pub trait AargvarkTrait: Sized {
    /// Called when this argument is reached. Should parse data until no more data can
    /// be parsed.
    fn vark(state: &mut VarkState) -> R<Self>;

    /// Called when `-h` is specified.
    fn build_help_pattern(state: &mut HelpState) -> HelpPattern;
}