yaml_modify library
The yamlicious library.
Adds support for writing yaml files. Ideally this should be folded into the core yaml package.
Classes
- CollectionStyle
- An enum of collection styles.
- ScalarStyle
- An enum of source scalar styles.
- TagDirective
- A directive describing a custom tag handle.
- VersionDirective
- A directive indicating which version of YAML a document was written to.
- YamlDocument
- A YAML document, complete with metadata.
- YamlList
- A read-only List parsed from YAML.
- YamlMap
- A read-only Map parsed from YAML.
- YamlNode
- An interface for parsed nodes from a YAML source tree.
- YamlScalar
- A wrapped scalar value parsed from YAML.
Enums
- YamlStyle
- Yaml formatting control options
Properties
- yamlWarningCallback ↔ YamlWarningCallback
-
A callback for emitting a warning.
getter/setter pair
Functions
-
getModifiableNode(
dynamic node) → dynamic -
json2yaml(
Map< String, dynamic> json, {YamlStyle yamlStyle = YamlStyle.generic}) → String - Converts JSON to YAML representation
-
loadYaml(
String yaml, {Uri? sourceUrl, bool recover = false, ErrorListener? errorListener}) → dynamic - Loads a single document from a YAML string.
-
loadYamlDocument(
String yaml, {Uri? sourceUrl, bool recover = false, ErrorListener? errorListener}) → YamlDocument - Loads a single document from a YAML string as a YamlDocument.
-
loadYamlDocuments(
String yaml, {Uri? sourceUrl}) → List< YamlDocument> - Loads a stream of documents from a YAML string.
-
loadYamlNode(
String yaml, {Uri? sourceUrl, bool recover = false, ErrorListener? errorListener}) → YamlNode - Loads a single document from a YAML string as a YamlNode.
-
loadYamlStream(
String yaml, {Uri? sourceUrl}) → YamlList - Loads a stream of documents from a YAML string.
-
toYamlString(
dynamic node, {bool? sort}) → String -
Serializes
node
into a String and returns it. -
writeYamlString(
dynamic node, StringSink sink) → void -
Serializes
node
into a String and writes it to thesink
.
Typedefs
- YamlWarningCallback = void Function(String message, [SourceSpan? span])
- A callback for emitting a warning.
Exceptions / Errors
- YamlException
- An error thrown by the YAML processor.