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 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
use super::Error;
use super::Key;
use std::result::Result;
use std::str::FromStr;
/// # Jargon
///
/// This is the main struct in this crate. This is what is used to handle arguments,
/// and get arguments' values.
///
/// # Example
///
/// ```
/// use jargon_args::Jargon;
/// let mut jargon: Jargon = Jargon::from_env();
///
/// if jargon.contains(["-h", "--help"]) {
/// println!("help text");
/// std::process::exit(0);
/// }
///
/// // ...
#[derive(Debug, Clone, Ord, PartialOrd, Eq, PartialEq)]
pub struct Jargon(pub(crate) Vec<String>);
impl Jargon {
/// Extracts a program's arguments from the environment.
pub fn from_env() -> Self {
Self(std::env::args().collect())
}
/// Places provided vector into Jargon. Please have the program's name or subcommand's name at
/// index `0`. 0 is always ignored.
pub fn from_vec<T: ToString>(v: Vec<T>) -> Self {
Self(v.iter().map(|x| x.to_string()).collect())
}
/// Checks if provided key is given in arguments. Removes it.
pub fn contains<K: Into<Key>>(&mut self, key: K) -> bool {
let key: Key = key.into();
let len: usize = self.0.len();
match key {
Key::Dual {
char: c,
s_txt: s,
l_txt: l,
} => {
let s: Key = Key::Short { char: c, txt: s };
let l: Key = Key::Long { char: c, txt: l };
for i in 0..len {
let cont: Key = self.0[i].clone().into();
if cont == s || cont == l {
self.0.remove(i);
return true;
}
}
}
key => {
for i in 0..len {
let cont: Key = self.0[i].clone().into();
if cont == key {
self.0.remove(i);
return true;
}
}
}
}
false
}
#[cfg(feature = "no_mut")]
/// Checks if provided key is given in arguments. Dose not remove it.
pub fn contains_nomut<K: Into<Key>>(&self, key: K) -> bool {
let m = self.0.clone();
let mut m = Self(m);
m.contains(key)
}
/// Runs function that does not return a value if specified key exists.
/// Removes the program's name from provided vector.
pub fn on_subcommand<K: Into<Key>, F: FnMut(Vec<String>)>(&mut self, key: K, mut f: F) {
let key: Key = key.into();
for i in 0..self.0.len() {
let cont: Key = self.0[i].clone().into();
if cont.is_sub() && cont == key {
return f(self.clone().finish());
}
}
}
/// Runs function that returns Option<T> if specified key exists.
/// Removes the program's name from provided vector.
pub fn opt_on_subcommand<K: Into<Key>, F: FnMut(Vec<String>) -> Option<T>, T>(
&mut self,
key: K,
mut f: F,
) -> Option<T> {
let key: Key = key.into();
for i in 0..self.0.len() {
let cont: Key = self.0[i].clone().into();
if cont.is_sub() && cont == key {
return f(self.clone().finish());
}
}
None
}
/// Runs function that returns Result<T, jargon_args::Error> if specified key exists.
/// Removes the program's name from provided vector.
pub fn res_on_subcommand<K: Into<Key>, F: FnMut(Vec<String>) -> Result<T, Error>, T>(
&mut self,
key: K,
mut f: F,
) -> Result<T, Error> {
let key: Key = key.into();
for i in 0..self.0.len() {
let cont: Key = self.0[i].clone().into();
if cont.is_sub() && cont == key {
return f(self.clone().finish());
}
}
Err(Error::MissingArg(key))
}
/// Checks if key exists, removes it, and returns it and all remaining arguments in
/// Some(Vec<String>). None if key isn't in arguments.
pub fn subcommand<K: Into<Key>>(&mut self, key: K) -> Option<Vec<String>> {
let mut v: Vec<String> = Vec::new();
self.on_subcommand(key, |vv| v = vv);
if v.is_empty() {
None
} else {
Some(v)
}
}
#[cfg(feature = "no_mut")]
/// Checks if key exists, removes it without modifying your Jargon variable,
/// and returns it and all remaining arguments in
/// Some(Vec<String>). None if key isn't in arguments.
pub fn subcommand_nomut<K: Into<Key>>(&self, key: K) -> Option<Vec<String>> {
Jargon::from_vec(self.0.clone()).subcommand(key)
}
/// Checks for provided key in arguments, removes it, returns Some(String) with the value after it if there is one.
/// None is there is no value.
pub fn option_arg<T: FromStr, K: Into<Key>>(&mut self, key: K) -> Option<T> {
let key: Key = key.into();
let len: usize = self.0.len();
match key {
Key::Dual {
char: c,
s_txt: s,
l_txt: l,
} => {
let s: Key = Key::Short { char: c, txt: s };
let l: Key = Key::Long { char: c, txt: l };
for i in 0..len {
let cont: Key = self.0[i].clone().into();
if cont == s || cont == l {
if i >= self.0.len() - 1 {
return None;
}
return if !self.0[i + 1].starts_with(s.char())
|| !self.0[i + 1].starts_with(l.char())
{
self.0.remove(i);
self.0.remove(i).parse().ok()
} else {
None
};
}
}
}
key => {
for i in 0..len {
let cont: Key = self.0[i].clone().into();
if cont == key {
if i >= self.0.len() - 1 {
return None;
}
return if !self.0[i + 1].starts_with(key.char()) {
self.0.remove(i);
self.0.remove(i).parse().ok()
} else {
None
};
}
}
}
}
None
}
/// Checks for provided key in arguments, removes it, returns Ok(String) with the value after it if there is one.
/// Err(jargon_args::Error) is there is no value.
pub fn result_arg<T: FromStr, K: Into<Key>>(&mut self, key: K) -> Result<T, Error> {
let key: Key = key.into();
self.option_arg(key.clone()).ok_or(Error::MissingArg(key))
}
/// Returns the next argument as `Some(T)` or 'None' if there is no more arguments or another argument key.
pub fn opt_next<T: FromStr>(&mut self) -> Option<T> {
if self.0.len() == 0 || self.0[0].starts_with('-') {
return None;
}
self.0.remove(0).parse().ok()
}
/// Returns the next argument as `Ok(T)` or 'Err()' if there is no more arguments or another argument key.
// pub fn result_next<T: FromStr>(&mut self) -> Option<T> {
// if self.0.len() == 0 || self.0[0].starts_with('-') {
// return None;
// }
// self.0.remove(0).parse().ok()
// }
/// Drops your jargon instance and returns all remaining arguments.
pub fn finish(self) -> Vec<String> {
self.0.iter().skip(1).map(|s| s.to_string()).collect()
}
}