History

Paul Stemmet a4ce525c15 docs: add notes on yaml graph structure		2022-04-16 14:00:02 +00:00
..
README.md	docs: add README, explaining library purpose and status	2022-03-18 15:40:12 +00:00
flow-logic.md	docs/flow-logic: notes from scalar line joining	2021-06-23 21:51:33 +01:00
graph-notes.md	docs: add notes on yaml graph structure	2022-04-16 14:00:02 +00:00
plain-scalar-indent.txt	docs/plain-scalar-indent: commit notes	2021-08-15 09:03:22 +00:00

README.md

yary

Yet Another Rust YAML, or yary, is a library for efficiently parsing YAML document streams. It primary design goals are:

Full implementation of the YAML 1.2 schema
Ergonomic, easy to use, well documented API
Safe handling of untrusted inputs
Zero copy deserialization (where allowed)
Lazy evaluation of stream content

Library status

alpha

This library is still in the early stages of development. It does have a fully functional YAML 1.2 parser, but no high level bindings, in-memory graph representation, or safety features.

It does expose a single low level API for iterating over YAML stream events, in lib/event, although it is not expected that most users would directly rely on this module's API, instead using higher level constructs.

MSRV

1.53

We make no strong guarantees about when this number will jump, and it will be moved as we consume features of newer Rust versions.