envmnt 0.9.1

Environment variables utility functions.
Documentation
1
2
3
4
var searchIndex = JSON.parse('{\
"envmnt":{"doc":"envmnt","t":[6,6,6,5,5,5,0,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,0,5,4,13,13,13,11,11,11,11,11,11,11,11,11,11,11,13,6,3,4,3,13,13,13,13,13,13,11,11,11,11,11,11,11,11,11,11,11,11,11,11,12,11,12,11,11,11,11,11,11,12,11,11,11,11,11,12,11,11,11,11,11,11,11,11,11,11,11,11],"n":["ExpandOptions","ExpansionType","ListOptions","contains","contains_ignore_case","decrement","errors","evaluate_and_load_file","evaluate_and_set_all","exists","expand","get_any","get_f32","get_f64","get_i128","get_i16","get_i32","get_i64","get_i8","get_isize","get_list","get_list_with_options","get_or","get_or_panic","get_parse","get_parse_or","get_remove","get_set","get_u128","get_u16","get_u32","get_u64","get_u8","get_usize","increment","is","is_all_exists","is_any_exists","is_equal","is_or","load_file","parse_env_file_content","parse_file","remove","remove_all","set","set_all","set_bool","set_f32","set_f64","set_i128","set_i16","set_i32","set_i64","set_i8","set_isize","set_list","set_list_with_options","set_optional","set_or_remove","set_u128","set_u16","set_u32","set_u64","set_u8","set_usize","types","vars","EnvmntError","InvalidType","Missing","ReadFile","borrow","borrow_mut","fmt","fmt","from","into","source","to_string","try_from","try_into","type_id","All","EnvmntResult","ExpandOptions","ExpansionType","ListOptions","OS","Unix","UnixBrackets","UnixBracketsWithDefaults","UnixPrefix","Windows","borrow","borrow","borrow","borrow_mut","borrow_mut","borrow_mut","clone","clone","clone","clone_into","clone_into","clone_into","clone_with_expansion_type","default","default_to_empty","eq","expansion_type","fmt","fmt","fmt","from","from","from","ignore_empty","into","into","into","new","new","separator","to_owned","to_owned","to_owned","try_from","try_from","try_from","try_into","try_into","try_into","type_id","type_id","type_id"],"q":["envmnt","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","envmnt::errors","","","","","","","","","","","","","","","envmnt::types","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","",""],"d":["Expand options","Expansion Type - unix/windows style","Get/Set list options","Returns true if the provided environment variable is …","Returns true if the provided environment variable is …","Decrements and returns the new value stored by the given …","errors","Parses the provided env file and loads all environment …","Sets all the provided env key/value pairs.","Returns true environment variable is defined.","Expands the provided string value by replacing the …","Returns the first environment variable found.","Returns the environment variable value or a default value …","Returns the environment variable value or a default value …","Returns the environment variable value or a default value …","Returns the environment variable value or a default value …","Returns the environment variable value or a default value …","Returns the environment variable value or a default value …","Returns the environment variable value or a default value …","Returns the environment variable value or a default value …","Returns the requested environment variable as a string …","Returns the requested environment variable as a string …","Returns the environment variable value or if is not …","Returns the environment variable value. If the variable …","Returns the parsed environment variable value.","Returns the parsed environment variable value or if is …","Removes the provided environment variable and returns its …","Sets the environment variable value and returns the …","Returns the environment variable value or a default value …","Returns the environment variable value or a default value …","Returns the environment variable value or a default value …","Returns the environment variable value or a default value …","Returns the environment variable value or a default value …","Returns the environment variable value or a default value …","Increments and returns the new value stored by the given …","Returns false if environment variable value if falsy. The …","Returns true if all of environment variables are defined.","Returns true if any of environment variables is defined.","Returns true if the provided environment variable is …","Returns false if environment variable value if falsy. Any …","Parses the provided env file and loads all environment …","Parses the provided content as a map of key/value. The …","Parses the provided env file and returns its content as a …","Removes the provided environment variable.","Removes all provided environment variables.","Sets the environment variable value.","Sets all the provided env key/value pairs.","Sets the environment variable with a true/false value as …","Sets the environment variable value.","Sets the environment variable value.","Sets the environment variable value.","Sets the environment variable value.","Sets the environment variable value.","Sets the environment variable value.","Sets the environment variable value.","Sets the environment variable value.","Sets the provided string vector as an environment …","Sets the provided string vector as an environment …","Sets the environment variable if the provided option …","Sets the environment variable if the provided option …","Sets the environment variable value.","Sets the environment variable value.","Sets the environment variable value.","Sets the environment variable value.","Sets the environment variable value.","Sets the environment variable value.","types","Returns all environment variables as a vector.","Enumeration of possible errors emitted in this library","Environment variable has not a compatible type","Environment variable not found","File not found error","","","","Formats the value using the given formatter.","","","","","","","","All supported styles for all platforms (not including …","Envmt Library Result","Expand options","Expansion Type - unix/windows style","Get/Set list options","Current OS supported styles (Unix/Windows)","All unix supported styles","Unix brackets environment style, for example: ${MY_ENV}","Unix brackets like format with default value support …","Unix prefix environment style, for example: $MY_ENV","Windows environment style, for example: %MY_ENV%","","","","","","","","","","","","","Clones and modifies the expansion type","","If true (default), empty variables will be replaced with …","","The expansion type (unix/windows/…)","","","","","","","if true, empty list will not be set and empty string will …","","","","Creates and returns a new instance.","Creates and returns a new instance.","The separator used to merge/split the values","","","","","","","","","","","",""],"i":[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,1,1,1,1,1,1,1,1,1,1,1,1,1,2,0,0,0,0,2,2,2,2,2,2,3,2,4,3,2,4,3,2,4,3,2,4,4,3,4,2,4,3,2,4,3,2,4,3,3,2,4,3,4,3,3,2,4,3,2,4,3,2,4,3,2,4],"f":[null,null,null,[[["asref",8,["osstr"]],["osstr",3],["str",15]],["bool",15]],[[["asref",8,["osstr"]],["osstr",3],["str",15]],["bool",15]],[[["asref",8,["osstr"]],["osstr",3]],["isize",15]],null,[[["str",15]],["envmntresult",6]],[[["indexmap",3]]],[[["asref",8,["osstr"]],["osstr",3]],["bool",15]],[[["str",15],["option",4,["expandoptions"]],["expandoptions",6]],["string",3]],[[["str",15],["vec",3]],["string",3]],[[["asref",8,["osstr"]],["osstr",3],["f32",15]],["f32",15]],[[["asref",8,["osstr"]],["osstr",3],["f64",15]],["f64",15]],[[["asref",8,["osstr"]],["osstr",3],["i128",15]],["i128",15]],[[["asref",8,["osstr"]],["osstr",3],["i16",15]],["i16",15]],[[["asref",8,["osstr"]],["osstr",3],["i32",15]],["i32",15]],[[["asref",8,["osstr"]],["osstr",3],["i64",15]],["i64",15]],[[["asref",8,["osstr"]],["osstr",3],["i8",15]],["i8",15]],[[["asref",8,["osstr"]],["osstr",3],["isize",15]],["isize",15]],[[["asref",8,["osstr"]],["osstr",3]],[["option",4,["vec"]],["vec",3,["string"]]]],[[["asref",8,["osstr"]],["osstr",3],["listoptions",6]],[["option",4,["vec"]],["vec",3,["string"]]]],[[["asref",8,["osstr"]],["osstr",3],["str",15]],["string",3]],[[["asref",8,["osstr"]],["osstr",3]],["string",3]],[[],["envmntresult",6]],[[],["envmntresult",6]],[[["asref",8,["osstr"]],["osstr",3]],[["option",4,["string"]],["string",3]]],[[["asref",8,["osstr"]],["osstr",3]],[["option",4,["string"]],["string",3]]],[[["asref",8,["osstr"]],["osstr",3],["u128",15]],["u128",15]],[[["asref",8,["osstr"]],["osstr",3],["u16",15]],["u16",15]],[[["asref",8,["osstr"]],["osstr",3],["u32",15]],["u32",15]],[[["asref",8,["osstr"]],["osstr",3],["u64",15]],["u64",15]],[[["asref",8,["osstr"]],["osstr",3],["u8",15]],["u8",15]],[[["asref",8,["osstr"]],["osstr",3],["usize",15]],["usize",15]],[[["asref",8,["osstr"]],["osstr",3]],["isize",15]],[[["asref",8,["osstr"]],["osstr",3]],["bool",15]],[[["vec",3]],["bool",15]],[[["vec",3]],["bool",15]],[[["asref",8,["osstr"]],["osstr",3],["str",15]],["bool",15]],[[["asref",8,["osstr"]],["osstr",3],["bool",15]],["bool",15]],[[["str",15]],["envmntresult",6]],[[["str",15]],[["indexmap",3,["string","string"]],["string",3]]],[[["str",15]],[["indexmap",3,["string","string"]],["envmntresult",6,["indexmap"]]]],[[["asref",8,["osstr"]],["osstr",3]]],[[["vec",3]]],[[["asref",8,["osstr"]],["osstr",3]]],[[["indexmap",3]]],[[["asref",8,["osstr"]],["osstr",3],["bool",15]]],[[["asref",8,["osstr"]],["osstr",3],["f32",15]]],[[["asref",8,["osstr"]],["osstr",3],["f64",15]]],[[["asref",8,["osstr"]],["osstr",3],["i128",15]]],[[["asref",8,["osstr"]],["osstr",3],["i16",15]]],[[["asref",8,["osstr"]],["osstr",3],["i32",15]]],[[["asref",8,["osstr"]],["osstr",3],["i64",15]]],[[["asref",8,["osstr"]],["osstr",3],["i8",15]]],[[["asref",8,["osstr"]],["osstr",3],["isize",15]]],[[["asref",8,["osstr"]],["osstr",3],["vec",3]]],[[["osstr",3],["listoptions",6],["asref",8,["osstr"]],["vec",3]]],[[["asref",8,["osstr"]],["osstr",3],["option",4]],["bool",15]],[[["asref",8,["osstr"]],["osstr",3],["option",4]],["bool",15]],[[["asref",8,["osstr"]],["osstr",3],["u128",15]]],[[["asref",8,["osstr"]],["osstr",3],["u16",15]]],[[["asref",8,["osstr"]],["osstr",3],["u32",15]]],[[["asref",8,["osstr"]],["osstr",3],["u64",15]]],[[["asref",8,["osstr"]],["osstr",3],["u8",15]]],[[["asref",8,["osstr"]],["osstr",3],["usize",15]]],null,[[],["vec",3]],null,null,null,null,[[]],[[]],[[["formatter",3]],["result",6]],[[["formatter",3]],[["result",4,["error"]],["error",3]]],[[]],[[]],[[],[["option",4,["error"]],["error",8]]],[[],["string",3]],[[],["result",4]],[[],["result",4]],[[],["typeid",3]],null,null,null,null,null,null,null,null,null,null,null,[[]],[[]],[[]],[[]],[[]],[[]],[[],["listoptions",3]],[[],["expansiontype",4]],[[],["expandoptions",3]],[[]],[[]],[[]],[[["expandoptions",3],["expansiontype",4]],["expandoptions",3]],[[],["listoptions",3]],null,[[["expansiontype",4]],["bool",15]],null,[[["formatter",3]],["result",6]],[[["formatter",3]],["result",6]],[[["formatter",3]],["result",6]],[[]],[[]],[[]],null,[[]],[[]],[[]],[[],["listoptions",3]],[[],["expandoptions",3]],null,[[]],[[]],[[]],[[],["result",4]],[[],["result",4]],[[],["result",4]],[[],["result",4]],[[],["result",4]],[[],["result",4]],[[],["typeid",3]],[[],["typeid",3]],[[],["typeid",3]]],"p":[[4,"EnvmntError"],[4,"ExpansionType"],[3,"ListOptions"],[3,"ExpandOptions"]]}\
}');
if (window.initSearch) {window.initSearch(searchIndex)};