stdlib/yamlView source ↗
yaml
61 items · generated by scribe fromstdlib/yaml.fd· synced 2026-11-15
Contents
- YamlValue (struct)
- YamlEntry (struct)
- YamlDoc (struct)
- yaml_load_all (function)
- yaml_load (function)
- yaml_parse (function)
- yaml_get (function)
- yaml_has (function)
- yaml_kind (function)
- yaml_get_str (function)
- yaml_get_int (function)
- yaml_get_float (function)
- yaml_get_bool (function)
- yaml_list_len (function)
YamlValue
kind: “str” | “int” | “float” | “bool” | “null” | “map” | “list”. sval holds scalars; maps/lists only mark structure (children are other entries under a longer path).
pub struct YamlValue {Fields:
| Name | Type |
|---|---|
kind | str |
sval | str |
Defined at line 66
YamlEntry
One entry: dotted path → value. List indexes appear as digits.
pub struct YamlEntry {Fields:
| Name | Type |
|---|---|
path | str |
value | YamlValue |
Defined at line 72
YamlDoc
One document: its entries, or ok = false and the error.
pub struct YamlDoc {Fields:
| Name | Type |
|---|---|
ok | bool |
error | str |
entries | Vec<YamlEntry> |
Defined at line 78
yaml_load_all
Every document of a YAML stream, strictly (see the module header).
pub fn yaml_load_all(text: str) -> Vec<YamlDoc> {Parameters:
text:str
Returns: Vec<YamlDoc>
Defined at line 1583
yaml_load
One YAML document, strictly; an empty text gives no entries. A stream of more than one document is an error (use yaml_load_all).
pub fn yaml_load(text: str) -> YamlDoc {Parameters:
text:str
Returns: YamlDoc
Defined at line 1589
yaml_parse
Parse YAML text into Vec
pub fn yaml_parse(text: str) -> Vec<YamlEntry> {Parameters:
text:str
Returns: Vec<YamlEntry>
Defined at line 1617
yaml_get
Value at dotted path; kind “missing” when absent.
pub fn yaml_get(doc: Vec<YamlEntry>, path: str) -> YamlValue {Parameters:
doc:Vec<YamlEntry>path:str
Returns: YamlValue
Defined at line 1647
yaml_has
pub fn yaml_has(doc: Vec<YamlEntry>, path: str) -> bool {Parameters:
doc:Vec<YamlEntry>path:str
Returns: bool
Defined at line 1657
yaml_kind
pub fn yaml_kind(doc: Vec<YamlEntry>, path: str) -> str {Parameters:
doc:Vec<YamlEntry>path:str
Returns: str
Defined at line 1661
yaml_get_str
Scalar string at path ("" when absent).
pub fn yaml_get_str(doc: Vec<YamlEntry>, path: str) -> str {Parameters:
doc:Vec<YamlEntry>path:str
Returns: str
Defined at line 1666
yaml_get_int
Int at path (decimal, 0o octal or 0x hex), default when absent or not an int.
pub fn yaml_get_int(doc: Vec<YamlEntry>, path: str, default: i64) -> i64 {Parameters:
doc:Vec<YamlEntry>path:strdefault:i64
Returns: i64
Defined at line 1672
yaml_get_float
pub fn yaml_get_float(doc: Vec<YamlEntry>, path: str, default: f64) -> f64 {Parameters:
doc:Vec<YamlEntry>path:strdefault:f64
Returns: f64
Defined at line 1697
yaml_get_bool
pub fn yaml_get_bool(doc: Vec<YamlEntry>, path: str, default: bool) -> bool {Parameters:
doc:Vec<YamlEntry>path:strdefault:bool
Returns: bool
Defined at line 1708
yaml_list_len
Number of items in the list at path (0 if not a list).
pub fn yaml_list_len(doc: Vec<YamlEntry>, path: str) -> i64 {Parameters:
doc:Vec<YamlEntry>path:str
Returns: i64
Defined at line 1717
Generated by scribe, the Fides documentation generator