YAML2SpecificationCompliance.adoc

Chronicle Wire and YAML 1.2

YAML 1.2 Specification Compliance

Chronicle Wire supports most of the features available from the YAML 2 specification. TEXT wire type supports a narrow subset which is sufficient to encode and parse Wire record graphs, whereas YAML wire type aims to parse most real-life Yaml documents. This section lists those features and suggests workarounds in Chronicle Wire may define the same thing.

YAML 1.2 features supported in Chronicle Wire

The list below lists the features of the specification that are implemented in Chronicle Wire YAML parser.

Note	The numbers refer to the section in the YAML 2 specification. See https://yaml.org/spec/1.2.2/ for more information.

Feature	Strict YAML Specification Compliance	Equivalent Operations in Chronicle Wire
Section 2_1, SequenceOfScalars	Yes
Section 2_2, MappingScalarsToScalars	Yes
Section 2_3, MappingScalarsToSequences	Yes
Section 2_4, SequenceOfMappings	Yes
Section 2_5, SequenceOfSequences	Yes
Section 2_6, MappingOfMappings	Yes
Section 2_7, TwoDocumentsInAStream	Yes
Section 2_8, PlayByPlayFeed	Yes	No special handling of "…​" starting the new document without ending previous one
Section 2_9, SingleDocumentWithTwoComments	Yes
Section 2_10, NodeAppearsTwiceInThisDocument	Yes
Section 2_11, MappingBetweenSequences	No	Key-value ? : syntax is not supported
Section 2_12, CompactNestedMapping	Yes
Section 2_13, InLiteralsNewlinesArePreserved	Yes
Section 2_14, InThefoldedScalars	Yes
Section 2_15, FoldedNewlines	Partial	Folded/literal blocks are supported, but formatting may deviate from spec
Section 2_16, IndentationDeterminesScope	Partial	See above
Section 2_17, QuotedScalars	Yes
Section 2_18, Multi_lineFlowScalars	No	Unquoted multi-line strings are not supported
Section 2_19, Integers	Yes
Section 2_20, FloatingPoint	Partial	Limited Infinity/NaN parsing support
Section 2_21, Miscellaneous	Yes
Section 2_22, Timestamps	Partial	ISO Date-Time format is supported
Section 2_23, VariousExplicitTags	Yes	Supports BytesStore and byte[] types for !!binary
Section 2_24, GlobalTags	No
Section 2_25, UnorderedSets	No
Section 2_26, OrderedMappings	No
Section 2_27, Invoice	Partial
Section 2_28, LogFile	Partial

---

Back to Chronicle Wire project