appcore-args 1.0.1-rc.10

Dependency-free bounded argument parsing, generated help and shell completion
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

// =============================================================================
//        #######
//     ###       ###     F: raw.rs
//    ##   ## ##   ##    P: AppCore-Runtime
//         ## ##
//                       C: 2026/08/19 12:52:57 by dnettoRaw
//    ##   ## ##   ##    U: 2026/08/19 13:34:54 by dnettoRaw
//      ###########      S: 1.0.1-rc.8
// =============================================================================

use crate::{CliError, CliErrorKind};

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct ArgLimits {
    pub max_words: usize,
    pub max_word_bytes: usize,
    pub max_total_bytes: usize,
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub struct RawArgs {
    words: Vec<String>,
}

impl Default for ArgLimits {
    fn default() -> Self {
        Self {
            max_words: 1024,
            max_word_bytes: 64 * 1024,
            max_total_bytes: 1024 * 1024,
        }
    }
}

impl RawArgs {
    pub fn from_env() -> Result<Self, CliError> {
        let mut words = Vec::new();
        for (index, word) in std::env::args_os().skip(1).enumerate() {
            let word = word.into_string().map_err(|_| {
                CliError::new(
                    CliErrorKind::InvalidInput,
                    format!("argument {} is not valid UTF-8", index + 1),
                )
            })?;
            words.push(word);
        }
        Self::parse_with_limits(words, ArgLimits::default())
    }

    pub fn parse<I>(args: I) -> Result<Self, CliError>
    where
        I: IntoIterator,
        I::Item: Into<String>,
    {
        Self::parse_with_limits(args, ArgLimits::default())
    }

    pub fn parse_with_limits<I>(args: I, limits: ArgLimits) -> Result<Self, CliError>
    where
        I: IntoIterator,
        I::Item: Into<String>,
    {
        let mut words = Vec::new();
        let mut total_bytes = 0usize;
        for arg in args {
            let value = arg.into();
            validate_raw_word(&value, words.len(), total_bytes, limits)?;
            total_bytes = total_bytes.saturating_add(value.len());
            words.push(value);
        }
        Ok(Self { words })
    }

    pub fn words(&self) -> &[String] {
        &self.words
    }
}

fn validate_raw_word(
    value: &str,
    count: usize,
    total: usize,
    limits: ArgLimits,
) -> Result<(), CliError> {
    if count >= limits.max_words {
        return Err(CliError::new(
            CliErrorKind::InvalidInput,
            format!("argument count exceeds limit of {}", limits.max_words),
        ));
    }
    if value.len() > limits.max_word_bytes {
        return Err(CliError::new(
            CliErrorKind::InvalidInput,
            format!(
                "argument {} exceeds byte limit of {}",
                count + 1,
                limits.max_word_bytes
            ),
        ));
    }
    if total.saturating_add(value.len()) > limits.max_total_bytes {
        return Err(CliError::new(
            CliErrorKind::InvalidInput,
            format!(
                "total argument bytes exceed limit of {}",
                limits.max_total_bytes
            ),
        ));
    }
    if value.contains('\0') {
        return Err(CliError::new(
            CliErrorKind::InvalidInput,
            format!("argument {} contains a NUL byte", count + 1),
        ));
    }
    Ok(())
}