Expand description
§styx-tree
High-level syntax tree for the Styx configuration language. Provides a convenient API for working with parsed Styx documents.
§Sponsors
Thanks to all individual sponsors:
…along with corporate sponsors:
…without whom this work could not exist.
§License
Licensed under either of:
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option. Document tree representation for Styx configuration files.
This crate provides a high-level API for working with Styx documents, including parsing, accessing values by path, and serialization.
Structs§
- Document
- A Styx document (root is always an implicit object).
- Entry
- An entry in an object.
- Object
- An object (mapping of keys to values).
- Parse
Error - A parser error with source location.
- Scalar
- A scalar value.
- Sequence
- A sequence of values.
- Span
- A span representing a range in the source text.
- Tag
- A tag on a value.
- Tree
Builder - Builder that constructs a tree from parse events.
- Value
- A Styx value: optional tag + optional payload.
Enums§
- Build
Error - Error during tree building.
- Parse
Error Kind - Parse error kinds.
- Payload
- The payload of a value.
- Scalar
Kind - Kind of scalar.
- Separator
- Separator mode for object entries.
Functions§
- parse
- Parse a Styx document into a tree.