Yet Another Rust Yaml
Go to file
Paul Stemmet 797a8e4c1e
merge: master <--- fix/#54
* HEAD
| \
| * dacb745 <github@luxolus.com> scanner/test: add complex::zero_indent_multilevel
| * a354d52 <github@luxolus.com> scanner/test: add complex::zero_indent_multilevel_coalesce
| * 835ceb0 <github@luxolus.com> lib/scanner: fix missing token production for zero indents
| /
| master

Signed-off-by: Bazaah <github@luxolus.com>
2022-11-02 13:46:17 +00:00
.git-cliff build: rename and improve template for git tag patchnotes 2022-04-03 16:55:34 +01:00
.github/workflows ci/github: add lint workflow 2022-04-01 22:21:54 +01:00
docs docs: add README, explaining library purpose and status 2022-03-18 15:40:12 +00:00
src scanner/test: add complex::zero_indent_multilevel 2022-11-02 11:50:00 +00:00
.clippy.toml lib: pin rust version to 1.53 2022-03-18 15:26:45 +00:00
.gitignore git: ignore .vim/ 2021-06-23 21:51:33 +01:00
.rustfmt.toml ci/fmt: move rustfmt.toml to repo root 2021-06-22 21:14:34 +00:00
CHANGELOG.md chore: release v0.1.3 2022-04-03 16:55:22 +00:00
Cargo.lock chore: release v0.1.3 2022-04-03 16:55:22 +00:00
Cargo.toml chore: release v0.1.3 2022-04-03 16:55:22 +00:00
LICENSE license/mpl2 2021-09-17 17:32:30 +01:00
cliff.toml build: add git-cliff configuration 2022-04-02 20:55:50 +01:00
justfile build/justfile: fix version prefix in bump-version 2022-04-03 17:53:07 +01:00

docs/README.md

yary

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

  1. Full implementation of the YAML 1.2 schema
  2. Ergonomic, easy to use, well documented API
  3. Safe handling of untrusted inputs
  4. Zero copy deserialization (where allowed)
  5. 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.