var searchIndex = {};
searchIndex["amethyst_config"] = {"doc":"Loading configuration (.yaml/.yml) files into a structure for easy usage","items":[[4,"Yaml","amethyst_config","A YAML node is stored as this `Yaml` enumeration, which provides an easy way to\naccess your YAML document.",null,null],[13,"Real","","Float types are stored as String and parsed on demand.\nNote that f64 does NOT implement Eq trait and can NOT be stored in BTreeMap.",0,null],[13,"Integer","","YAML int is stored as i64.",0,null],[13,"String","","YAML scalar.",0,null],[13,"Boolean","","YAML bool, e.g. `true` or `false`.",0,null],[13,"Array","","YAML array, can be accessed as a `Vec`.",0,null],[13,"Hash","","YAML hash, can be accessed as a `BTreeMap`.",0,null],[13,"Alias","","Alias, not fully supported yet.",0,null],[13,"Null","","YAML null, e.g. `null` or `~`.",0,null],[13,"BadValue","","Accessing a nonexistent node via the Index trait returns `BadValue`. This\nsimplifies error handling in the calling code. Invalid type conversion also\nreturns `BadValue`.",0,null],[3,"ConfigMeta","","Metadata for a configuration structure",null,null],[12,"path","","Where the file is located, defaults to "config/config.yml"",1,null],[12,"fields","","List from top-level to bottom-level configs",1,null],[12,"parent","","Parent meta",1,null],[12,"ty","","String representation of the type",1,null],[12,"name","","Name of the field",1,null],[12,"bad_value","","Whether key is bad or not",1,null],[12,"options","","Options to display to user, usually used for enums",1,null],[3,"LoggingConfig","","",null,null],[12,"file_path","","",2,null],[12,"output_level","","",2,null],[12,"logging_level","","",2,null],[3,"DisplayConfig","","",null,null],[12,"title","","",3,null],[12,"brightness","","",3,null],[12,"fullscreen","","",3,null],[12,"dimensions","","",3,null],[12,"min_dimensions","","",3,null],[12,"max_dimensions","","",3,null],[12,"vsync","","",3,null],[12,"multisampling","","",3,null],[12,"visibility","","",3,null],[3,"Config","","",null,null],[12,"display","","Configuration for display and graphics",4,null],[12,"logging","","Configuration for output",4,null],[4,"ConfigError","","Configuration error",null,null],[13,"YamlScan","","",5,null],[13,"YamlParse","","",5,null],[13,"NonConfig","","",5,null],[13,"FileError","","",5,null],[13,"MultipleExternalFiles","","",5,null],[13,"MissingExternalFile","","",5,null],[5,"to_string","","Converts a Yaml object into a .yml/.yaml format",null,{"inputs":[{"name":"yaml"}],"output":{"name":"string"}}],[11,"to_string","","",5,null],[11,"fmt","","",5,null],[11,"fmt","","",5,null],[11,"fmt","","",1,null],[11,"clone","","",1,null],[11,"default","","",1,{"inputs":[],"output":{"name":"self"}}],[11,"tree","","Displays the meta's fields in order e.g. Config->nested_config->field",1,null],[11,"root","","Returns the highest level parent or the root meta of the configuration",1,null],[8,"Element","","Trait for fields inside of a configuration struct.",null,null],[10,"from_yaml","","Convert yaml element into a rust type,\nRaises an error if it is not the yaml element expected",6,{"inputs":[{"name":"configmeta"},{"name":"yaml"}],"output":{"name":"result"}}],[10,"to_yaml","","Converts rust type into a yaml element for writing\nRequires the path for external configs",6,null],[11,"set_meta","","Sets the meta data of a config structure, only works on config structures",6,null],[11,"meta","","Returns meta data if it is a config structure",6,null],[11,"from_file_raw","","From a file relative to current config",6,{"inputs":[{"name":"configmeta"},{"name":"path"}],"output":{"name":"result"}}],[11,"from_file","","From a file relative to project",6,{"inputs":[{"name":"path"}],"output":{"name":"result"}}],[11,"write_file","","Recursively writes to files given the configuration's current context.",6,null],[11,"fmt","","",2,null],[11,"clone","","",2,null],[11,"to_string","","",2,null],[11,"default","","",2,{"inputs":[],"output":{"name":"self"}}],[11,"from_yaml","","",2,{"inputs":[{"name":"configmeta"},{"name":"yaml"}],"output":{"name":"result"}}],[11,"to_yaml","","",2,null],[11,"set_meta","","",2,null],[11,"meta","","",2,null],[11,"write_file","","",2,null],[11,"fmt","","",3,null],[11,"clone","","",3,null],[11,"to_string","","",3,null],[11,"default","","",3,{"inputs":[],"output":{"name":"self"}}],[11,"from_yaml","","",3,{"inputs":[{"name":"configmeta"},{"name":"yaml"}],"output":{"name":"result"}}],[11,"to_yaml","","",3,null],[11,"set_meta","","",3,null],[11,"meta","","",3,null],[11,"write_file","","",3,null],[11,"fmt","","",4,null],[11,"clone","","",4,null],[11,"to_string","","",4,null],[11,"default","","",4,{"inputs":[],"output":{"name":"self"}}],[11,"from_yaml","","",4,{"inputs":[{"name":"configmeta"},{"name":"yaml"}],"output":{"name":"result"}}],[11,"to_yaml","","",4,null],[11,"set_meta","","",4,null],[11,"meta","","",4,null],[11,"write_file","","",4,null],[14,"config!","","Automatically generates a struct/enums for loading in yaml files.",null,null],[11,"as_bool","","",0,null],[11,"as_i64","","",0,null],[11,"as_str","","",0,null],[11,"as_hash","","",0,null],[11,"as_vec","","",0,null],[11,"is_null","","",0,null],[11,"is_badvalue","","",0,null],[11,"as_f64","","",0,null],[11,"from_str","","",0,{"inputs":[{"name":"str"}],"output":{"name":"yaml"}}],[11,"hash","","",0,null],[11,"cmp","","",0,null],[11,"fmt","","",0,null],[11,"partial_cmp","","",0,null],[11,"lt","","",0,null],[11,"le","","",0,null],[11,"gt","","",0,null],[11,"ge","","",0,null],[11,"eq","","",0,null],[11,"ne","","",0,null],[11,"clone","","",0,null],[11,"index","","",0,null],[11,"index","","",0,null],[11,"set_meta","","Sets the meta data of a config structure, only works on config structures",6,null],[11,"meta","","Returns meta data if it is a config structure",6,null],[11,"from_file_raw","","From a file relative to current config",6,{"inputs":[{"name":"configmeta"},{"name":"path"}],"output":{"name":"result"}}],[11,"from_file","","From a file relative to project",6,{"inputs":[{"name":"path"}],"output":{"name":"result"}}],[11,"write_file","","Recursively writes to files given the configuration's current context.",6,null]],"paths":[[4,"Yaml"],[3,"ConfigMeta"],[3,"LoggingConfig"],[3,"DisplayConfig"],[3,"Config"],[4,"ConfigError"],[8,"Element"]]};
initSearch(searchIndex);