yaml_module library

Classes

CollectionStyle
An enum of collection styles.
FieldRule
A class defining rules for a field in the YAML schema.
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.
YamlModule
YamlNode
An interface for parsed nodes from a YAML source tree.
YamlScalar
A wrapped scalar value parsed from YAML.
YamlValidationSchema
A class representing the validation schema for a YAML file.

Properties

yamlWarningCallback YamlWarningCallback
A callback for emitting a warning.
getter/setter pair

Functions

extractDataImpl(YamlMap yamlContent) Map<String, dynamic>
Extract all data from a YAML file as primitive data types (String, int, bool, List, Map).
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.
loadYamlImpl(String path) Future<YamlMap>
Load YamlMap model from the Yaml file path.
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.
validateYamlImpl(YamlMap yamlContent, YamlValidationSchema schema) Future<void>

Typedefs

YamlWarningCallback = void Function(String message, [SourceSpan? span])
A callback for emitting a warning.

Exceptions / Errors

YamlException
An error thrown by the YAML processor.