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 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
#![deny( absolute_paths_not_starting_with_crate, ambiguous_associated_items, anonymous_parameters, const_err, dead_code, deprecated, deprecated_in_future, duplicate_macro_exports, ellipsis_inclusive_range_patterns, exceeding_bitshifts, explicit_outlives_requirements, exported_private_dependencies, ill_formed_attribute_input, illegal_floating_point_literal_pattern, improper_ctypes, incoherent_fundamental_impls, invalid_type_param_default, irrefutable_let_patterns, keyword_idents, late_bound_lifetime_arguments, legacy_constructor_visibility, legacy_directory_ownership, macro_expanded_macro_exports_accessed_by_absolute_paths, missing_copy_implementations, missing_docs, missing_fragment_specifier, mutable_borrow_reservation_conflict, mutable_transmutes, nested_impl_trait, no_mangle_const_items, no_mangle_generic_items, non_camel_case_types, non_shorthand_field_patterns, non_snake_case, non_upper_case_globals, order_dependent_trait_objects, overflowing_literals, parenthesized_params_in_types_and_modules, path_statements, patterns_in_fns_without_body, plugin_as_library, private_doc_tests, private_in_public, proc_macro_derive_resolution_fallback, pub_use_of_private_extern_crate, question_mark_macro_sep, safe_extern_statics, safe_packed_borrows, stable_features, trivial_bounds, trivial_casts, trivial_numeric_casts, type_alias_bounds, tyvar_behind_raw_pointer, unconditional_recursion, unions_with_drop_fields, unknown_crate_types, unnameable_test_items, unreachable_code, unreachable_patterns, unreachable_pub, unsafe_code, unstable_features, unstable_name_collisions, unused_allocation, unused_assignments, unused_attributes, unused_comparisons, unused_doc_comments, unused_extern_crates, unused_features, unused_import_braces, unused_imports, unused_labels, unused_lifetimes, unused_macros, unused_must_use, unused_mut, unused_parens, unused_qualifications, unused_unsafe, unused_variables, where_clauses_object_safety, while_true )] #![warn(macro_use_extern_crate, unknown_lints)] #![allow( bare_trait_objects, box_pointers, elided_lifetimes_in_paths, intra_doc_link_resolution_failure, missing_doc_code_examples, missing_debug_implementations, single_use_lifetimes, unused_results, variant_size_differences, warnings, renamed_and_removed_lints )] #![cfg_attr(feature = "clippy", feature(plugin))] //! # envmnt //! //! Environment variables utility functions. //! //! This library has many helper functions to access/modify/check environment variables. //! //! # Example //! //! ``` //! extern crate envmnt; //! //! fn main() { //! if !envmnt::exists("MY_ENV_VAR") { //! envmnt::set("MY_ENV_VAR", "SOME VALUE"); //! } //! //! let value = envmnt::get_or("MY_ENV_VAR", "DEFAULT_VALUE"); //! println!("Env Value: {}", &value); //! //! envmnt::set_bool("FLAG_VAR", true); //! let flag_value = envmnt::is_or("FLAG_VAR", false); //! println!("Bool Flag: {}", &flag_value); //! //! let pre_value = envmnt::get_set("MY_ENV_VAR", "SOME NEW VALUE"); //! //! let value = envmnt::get_or("MY_ENV_VAR", "DEFAULT_VALUE"); //! println!("New Env Value: {}", &value); //! println!("Previous Env Value: {:?}", &pre_value); //! } //! ``` //! //! # Installation //! In order to use this library, just add it as a dependency: //! //! ```ini //! [dependencies] //! envmnt = "*" //! ``` //! //! # Contributing //! See [contributing guide](https://github.com/sagiegurari/envmnt/blob/master/.github/CONTRIBUTING.md) //! //! # License //! Developed by Sagie Gur-Ari and licensed under the //! [Apache 2](https://github.com/sagiegurari/envmnt/blob/master/LICENSE) open source license. //! #[cfg(test)] #[path = "./lib_test.rs"] mod lib_test; mod environment; mod util; /// Returns true environment variable is defined. /// /// # Arguments /// /// * `key` - The environment variable name /// /// # Example /// /// ``` /// extern crate envmnt; /// /// fn main() { /// if !envmnt::exists("MY_ENV_VAR") { /// envmnt::set("MY_ENV_VAR", "SOME VALUE"); /// } /// } /// ``` pub fn exists(key: &str) -> bool { environment::exists(key) } /// Removes the provided environment variable. /// /// # Arguments /// /// * `key` - The environment variable to remove /// /// # Example /// /// ``` /// extern crate envmnt; /// /// fn main() { /// envmnt::set("MY_ENV_VAR", "SOME VALUE"); /// /// envmnt::remove("MY_ENV_VAR"); /// } /// ``` pub fn remove(key: &str) { environment::remove(key) } /// Removes the provided environment variable and returns its previous value (if any). /// /// # Arguments /// /// * `key` - The environment variable to remove /// /// # Example /// /// ``` /// extern crate envmnt; /// /// fn main() { /// envmnt::set("MY_ENV_VAR", "SOME VALUE"); /// /// let value = envmnt::get_remove("MY_ENV_VAR"); /// println!("Env Value: {:?}", &value); /// } /// ``` pub fn get_remove(key: &str) -> Option<String> { environment::get_remove(key) } /// Returns the environment variable value or if is not defined, the default value will be returned. /// /// # Arguments /// /// * `key` - The environment variable name /// * `default_value` - In case the environment variable is not defined, this value will be returned. /// /// # Example /// /// ``` /// extern crate envmnt; /// /// fn main() { /// envmnt::set("MY_ENV_VAR", "SOME VALUE"); /// /// let value = envmnt::get_or("MY_ENV_VAR", "DEFAULT_VALUE"); /// println!("Env Value: {}", &value); /// } /// ``` pub fn get_or(key: &str, default_value: &str) -> String { environment::get_or(key, default_value) } /// Returns false if environment variable value if falsy. /// The value is falsy if it is one of the following: /// * Empty string /// * false (case insensitive) /// * 0 /// Any other value is returned as true. /// /// # Arguments /// /// * `key` - The environment variable name /// * `default_value` - In case the environment variable is not defined, this value will be returned. /// /// # Example /// /// ``` /// extern crate envmnt; /// /// fn main() { /// envmnt::set_bool("FLAG_VAR", true); /// /// let flag_value = envmnt::is_or("FLAG_VAR", false); /// println!("Bool Flag: {}", &flag_value); /// } /// ``` pub fn is_or(key: &str, default_value: bool) -> bool { environment::is_or(key, default_value) } /// Sets the environment variable value. /// /// # Arguments /// /// * `key` - The environment variable name /// * `value` - The environment variable value /// /// # Example /// /// ``` /// extern crate envmnt; /// /// fn main() { /// envmnt::set("MY_ENV_VAR", "SOME VALUE"); /// /// let value = envmnt::get_or("MY_ENV_VAR", "DEFAULT_VALUE"); /// println!("Env Value: {}", &value); /// } /// ``` pub fn set(key: &str, value: &str) { environment::set(key, value) } /// Sets the environment variable with a true/false value as string. /// /// # Arguments /// /// * `key` - The environment variable name /// * `value` - true/false boolean value which will be converted to string /// /// # Example /// /// ``` /// extern crate envmnt; /// /// fn main() { /// envmnt::set_bool("FLAG_VAR", true); /// /// let flag_value = envmnt::is_or("FLAG_VAR", false); /// println!("Bool Flag: {}", &flag_value); /// } /// ``` pub fn set_bool(key: &str, value: bool) { environment::set_bool(key, value) } /// Sets the environment variable value and returns the previous value. /// /// # Arguments /// /// * `key` - The environment variable name /// * `value` - The environment variable value /// /// # Example /// /// ``` /// extern crate envmnt; /// /// fn main() { /// let pre_value = envmnt::get_set("MY_ENV_VAR", "SOME VALUE"); /// /// let value = envmnt::get_or("MY_ENV_VAR", "DEFAULT_VALUE"); /// println!("New Env Value: {}", &value); /// println!("Previous Env Value: {:?}", &pre_value); /// } /// ``` pub fn get_set(key: &str, value: &str) -> Option<String> { environment::get_set(key, value) } /// Returns true if the provided environment variable is defined and equals the provided value. /// /// # Arguments /// /// * `key` - The environment variable name /// * `value` - The value to check /// /// # Example /// /// ``` /// extern crate envmnt; /// /// fn main() { /// envmnt::set("MY_ENV_VAR", "SOME VALUE"); /// /// let same = envmnt::is_equal("MY_ENV_VAR", "SOME VALUE"); /// println!("Value Is Same: {}", &same); /// } /// ``` pub fn is_equal(key: &str, value: &str) -> bool { environment::is_equal(key, value) }