NimYAML Home Testing Ground Docs: Overview Serialization Modules NimYAML 2.x Source on GitHub

Module yaml/loading

The loading API enables you to load a YAML character stream into native Nim value. Along with the dumping API, this forms the highest-level API of NimYAML.

Imports

native, parser, internal

Procs

proc load[K](input: Stream | string; target: var K) {.
    ...raises: [YamlConstructionError, IOError, OSError, YamlParserError].}
Loads a Nim value from a YAML character stream.
proc loadAs[K](input: Stream | string): K {.
    ...raises: [YamlConstructionError, IOError, OSError, YamlParserError].}
Loads the given YAML input to a value of the type K and returns it
proc loadMultiDoc[K](input: Stream | string; target: var seq[K])

Exports

YamlStreamError, endMapEvent, hash, constructObject, startSeqEvent, defineCoreTag, ignore, collectionStyle, yamlTag, construct, yTagExclamationMark, peek=, yTagValue, yTagNull, constructObject, yamlTag, CollectionStyle, EventKind, hash, representObject, YamlStream, constructChild, startSeqEvent, yTagInteger, constructObject, constructionError, yTagSet, representChild, constructObjectDefault, endDocEvent, yTagMapping, implicit, startStreamEvent, ScalarStyle, constructObject, ==, presentTag, representObject, SerializationOptions, constructObject, nimyamlTagRepositoryPrefix, Anchor, representChild, newYamlConstructionError, defineTag, representObject, constructObject, YamlLoadingError, defaultVal, Event, constructChild, constructObject, yamlTag, endStreamEvent, peek, $, constructObjectDefault, representObject, representObject, Mark, transient, representObject, yTagYaml, constructObject, newBufferYamlStream, $, ConstructionContext, TagStyle, ==, scalarEvent, yamlTagRepositoryPrefix, constructScalarItem, yTagQuestionMark, constructObject, representChild, constructObject, representObject, representObject, yTagBoolean, put, hasSpecificTag, constructChild, getLastTokenContext, yamlTag, ==, representObject, yTagPairs, constructObject, yamlTag, yTagOrderedMap, representChild, Tag, Properties, mitems, aliasEvent, yamlTag, representObject, emptyProperties, put, startDocEvent, startMapEvent, constructChild, constructObject, basicInit, $, scalarEvent, endSeqEvent, initConstructionContext, startMapEvent, yTagNimField, initYamlStream, constructObject, next, yTagFloat, constructObject, yamlTag, constructChild, renderAttrs, YamlSerializationError, AnchorStyle, BufferYamlStream, representChild, yamlTag, yTagString, yamlTag, constructChild, represent, yTagSequence, yTagBinary, representObject, yTagMerge, sparse, constructObject, representObject, constructObject, SerializationContext, representChild, representObject, yAnchorNone, yamlTag, properties, initSerializationContext, representObject, YamlConstructionError, items, yamlTag, representObject, yTagTimestamp, representObject