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 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
/*! # LexicalBool provides a bool-like type that can be parsed from a string ```rust # use lexical_bool::LexicalBool; let tests = &[ // default `true` values ("true", true), ("t", true), ("1", true), ("yes", true), // default `false` values ("false", false), ("f", false), ("0", false), ("no", false), ]; for &(input, ok) in tests { let lb : LexicalBool = input.parse().expect("valid input"); // LexicalBool can be "deref" into a bool, or compared directly with one (partialeq) assert_eq!(lb, ok); } ``` ## Using your own values **note** This uses TLS, so the changes are only valid for the current thread ```rust # use lexical_bool::LexicalBool; // set the true values assert!(lexical_bool::initialize_true_values( &[ "foo", "bar" ] )); // set the false values assert!(lexical_bool::initialize_false_values( &[ "baz", "qux" ] )); // once set, you cannot change them (in this thread) assert_eq!(lexical_bool::initialize_true_values( &[ "true", "1" ] ), false); let tests = &[ // your `true` values ("foo", true), ("bar", true), // your `false` values ("baz", false), ("qux", false), ]; for &(input, ok) in tests { // if parse (or from_str) is called before {initialize_true_values, initialize_false_values} // then it'll default to {lexical_bool::TRUTHY_VALUES, lexical_bool::FALSEY_VALUES} let lb : LexicalBool = input.parse().expect("valid input"); // LexicalBool can be "deref" into a bool, or compared directly with one (partialeq) assert_eq!(lb, ok); } // ..and invalid bools use std::str::FromStr as _; use lexical_bool::Error; let input = "true"; assert_eq!( LexicalBool::from_str(input), Err(Error::InvalidInput(input.to_string())) ); ``` */ use once_cell::sync::OnceCell; thread_local!( static TRUE_VALUES: OnceCell<Vec<String>> = OnceCell::new(); static FALSE_VALUES: OnceCell<Vec<String>> = OnceCell::new(); ); /// Intialize a custom set of truth-y values /// /// This returns whether or not they were updated /// /// ***note*** They can only be updated once per thread /// /// ***note*** If a parse happens in this thread and this hasn't be called, then it'll default to [`TRUTHY_VALUES`](./constant.TRUTHY_VALUES.html) pub fn initialize_true_values<S: ToString>(values: impl IntoIterator<Item = S>) -> bool { let values = values.into_iter().map(|s| s.to_string()).collect(); TRUE_VALUES.with(|f| f.set(values).is_ok()) } /// Intialize a custom set of false-y values /// /// This returns whether or not they were updated. /// /// ***note*** They can only be updated once per thread /// /// ***note*** If a parse happens in this thread and this hasn't be called, then it'll default to [`FALSEY_VALUES`](./constant.FALSEY_VALUES.html) pub fn initialize_false_values<S: ToString>(values: impl IntoIterator<Item = S>) -> bool { let values = values.into_iter().map(|s| s.to_string()).collect(); FALSE_VALUES.with(|f| f.set(values).is_ok()) } /// `LexicalBool` allows parsing truthy-like strings to a bool /// /// It can be `deref` (e.g. `*lb`) to get the bool, or compared to a bool (e.g. `lb == false`) /// /// This uses the values provided by /// [`initialize_true_values`](./fn.initialize_true_values.html) and /// [`initialize_false_values`](./fn.initialize_false_values.html). /// /// If they were /// not initialized before the first parse, than the defaults of /// [`TRUTHY_VALUES`](./constant.TRUTHY_VALUES.html) and /// [`FALSEY_VALUES`](./constant.FALSEY_VALUES.html) are used for the life of /// the thread it was parsed from. /// /// ***note*** The parsing is case-insensitive #[derive(Copy, Clone, PartialEq, Default, Hash, Eq)] pub struct LexicalBool(bool); impl std::ops::Deref for LexicalBool { type Target = bool; fn deref(&self) -> &Self::Target { &self.0 } } impl PartialEq<bool> for LexicalBool { fn eq(&self, other: &bool) -> bool { *other == self.0 } } impl std::fmt::Display for LexicalBool { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { write!(f, "{}", self.0) } } impl std::fmt::Debug for LexicalBool { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { write!(f, "{}", self.0) } } impl std::str::FromStr for LexicalBool { type Err = Error; fn from_str(s: &str) -> Result<Self, Self::Err> { let e = s.to_ascii_lowercase(); if TRUE_VALUES.with(|f| { f.get_or_init(|| TRUTHY_VALUES.iter().map(ToString::to_string).collect()) .iter() .any(|k| k == &e) }) { return Ok(LexicalBool(true)); } if FALSE_VALUES.with(|f| { f.get_or_init(|| FALSEY_VALUES.iter().map(ToString::to_string).collect()) .iter() .any(|k| k == &e) }) { return Ok(LexicalBool(false)); } Err(Error::InvalidInput(s.to_string())) } } /// Default truth-y values. Override with [`initialize_true_values`](./fn.initialize_true_values.html) /// * `true` /// * `t` /// * `1` /// * `yes` pub const TRUTHY_VALUES: [&str; 4] = ["true", "t", "1", "yes"]; /// Default false-y values. Override with [`initialize_false_values`](./fn.initialize_false_values.html) /// * `false` /// * `f` /// * `0` /// * `no` pub const FALSEY_VALUES: [&str; 4] = ["false", "f", "0", "no"]; /// An error returned by [`std::str::FromStr`](https://doc.rust-lang.org/std/str/trait.FromStr.html) #[derive(Debug, Clone, PartialEq)] pub enum Error { /// Invalid input while parsing the string InvalidInput(String), } impl std::fmt::Display for Error { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { match self { Error::InvalidInput(input) => write!( f, "not a boolean: {}. only {} are allowed", input, TRUTHY_VALUES .iter() .chain(FALSEY_VALUES.iter()) .map(|val| format!("'{}''", val)) .fold(String::new(), |mut a, b| { if !a.is_empty() { a.push_str(", ") } a.push_str(&b); a }) ), } } } impl std::error::Error for Error {} #[cfg(test)] mod tests { use super::*; #[test] fn parse_true() { let inputs = &[("true", true), ("t", true), ("1", true), ("yes", true)]; for &(input, ok) in inputs { assert_eq!(input.parse::<LexicalBool>().unwrap(), ok); } } #[test] fn parse_false() { let inputs = &[("false", false), ("f", false), ("0", false), ("no", false)]; for &(input, ok) in inputs { assert_eq!(input.parse::<LexicalBool>().unwrap(), ok); } } #[test] fn parse_custom_true() { assert!(initialize_true_values(&["this is true", "yep", "YEP"])); let inputs = &[ ("this is true", true), ("yep", true), ("YEP", true), // keep the default false ("false", false), ("f", false), ("0", false), ("no", false), ]; for &(input, ok) in inputs { assert_eq!(input.parse::<LexicalBool>().unwrap(), ok); } } #[test] fn parse_custom_false() { assert!(initialize_false_values(&["this is false", "nope", "NOPE"])); let inputs = &[ ("this is false", false), ("nope", false), ("NOPE", false), // keep the default true ("true", true), ("t", true), ("1", true), ("yes", true), ]; for &(input, ok) in inputs { assert_eq!(input.parse::<LexicalBool>().unwrap(), ok); } } #[test] fn display_and_debug() { assert!(initialize_false_values(&["this is false", "nope", "NOPE"])); let inputs = &[ ("this is false", false), ("nope", false), ("NOPE", false), // keep the default true ("true", true), ("t", true), ("1", true), ("yes", true), ]; for (input, expected) in inputs { let b = input.parse::<LexicalBool>().unwrap(); assert_eq!(format!("{}", b), format!("{}", expected)); assert_eq!(format!("{:?}", b), format!("{:?}", expected)); } } #[test] fn trait_impls() { use std::collections::HashSet; let mut set: HashSet<LexicalBool> = HashSet::default(); assert!(set.insert("true".parse().unwrap())); assert!(set.insert("false".parse().unwrap())); assert!(!set.insert("true".parse().unwrap())); assert!(!set.insert("false".parse().unwrap())); } }