- Generated by
1.15.0
|
rapidyaml 0.15.2
parse and emit YAML, and do it fast
|
| Quickstart | Example code for every feature |
| Overview | |
| Using csubstr | |
| Parsing | |
| Tree | |
| Serialization | |
| Emitting | |
| JSON | |
| YAML styles | |
| YAML anchors | |
| YAML tags | |
| YAML documents | |
| Errors and error handlers | |
| Allocators | |
| Static trees | |
| Sample helpers | Helper utilities used in the quickstart |
| Parse utilities | |
| Parse in place with existing parser | parse a mutable YAML source buffer (re)using an existing parser |
| Parse in place with temporary parser | parse a mutable YAML source buffer |
| Parse in arena with existing parser | parse a read-only (immutable) YAML source buffer |
| Parse in arena with temporary parser | parse a read-only (immutable) YAML source buffer |
| Scalar charconv helpers | These functions are used by the parser and emitter to convert scalars to and from chars |
| Scalar filter processors | These are internal utilities used by ParseEngine to filter YAML scalars; normally there is no reason for a user to be manually using these classes |
| Event Handlers | Rapidyaml implements its parsing logic with a two-level model, where a ParseEngine object reads through the YAML source, and dispatches events to an EventHandler bound to the ParseEngine |
| Node types | |
| Tree utilities | |
| Arena utils | Implementation utils for serializing scalars in a tree's arena |
| Write to Tree | Implementation of serialization to a tree |
| Read from Tree | Implementation of deserialization from a tree |
| Node classes | High-level node classes |
| Emit utilities | Utilities to emit YAML and JSON, either to a memory buffer or to a file or ostream-like class |
| Emit to a memory buffer | |
| Emit to a container | Overloads to emit to contiguous memory container of char like std::string or std::vector<char> |
| Emit to file | |
| Emit to an STL-like ostream | |
| Writer objects to use with an Emitter | |
| Scalar style helpers | These functions are used by the emitter to choose a scalar style when a scalar does not have it set |
| Scalar charconv helpers | These functions are used by the parser and emitter to convert scalars to and from chars |
| Serialization/deserialization | |
| How to use (de)serialization | Shows basic use of the calls to serialize and deserialize |
| Serialization of user types | Shows how to implement serialization for custom user types |
| Serialization overview | Shows how user-provided functions fit into ryml's structure |
| Serialization for Tree | Shows ryml's default implementation of tree serialization |
| Serialization for nodes | Shows ryml's default implementation of node serialization |
| Scalar charconv helpers | These functions are used by the parser and emitter to convert scalars to and from chars |
| Anchor/Reference utilities | |
| Tag utilities | |
| File utils | Functions for loading/saving a file from/to disk |
| file_put_contents() | Save a buffer to disk |
| file_get_contents() | Load a file from disk into a buffer |
| stdin_get_contents() | Load a file from stdin (or similar stream-like file) into a buffer |
| Scalar utilities | |
| Scalar style helpers | These functions are used by the emitter to choose a scalar style when a scalar does not have it set |
| Scalar charconv helpers | These functions are used by the parser and emitter to convert scalars to and from chars |
| Scalar filter processors | These are internal utilities used by ParseEngine to filter YAML scalars; normally there is no reason for a user to be manually using these classes |
| Error handling | Utilities to report handle errors, and to build and report error messages |
| Callbacks for errors and allocation | Functions called by ryml to allocate/free memory and to report errors |
| String traits classes | |
| Substring: read/write string views | |
| substr adapters | c4::to_substr() and c4::to_csubstr() are used in generic code like c4::format() |
| substr left-comparison operators | |
| Charconv utilities | Lightweight, very fast generic type-safe wrappers for converting individual values to/from strings |
| Get number of digits | |
| Write with known number of digits | Writes a value without checking the buffer length with regards to the required number of digits to encode the value |
| Write a value | Writes a value without checking the buffer length decimal number – but asserting |
| Read a value | |
| itoa: signed to chars | |
| utoa: unsigned to chars | |
| atoi: chars to signed | |
| atou: chars to unsigned | |
| overflows: does a number string overflow a type | |
| ftoa: float32 to chars | |
| dtoa: float64 to chars | |
| atof: chars to float32 | |
| atod: chars to float64 | |
| xtoa: generic value to chars | Dispatches to the most appropriate and efficient conversion function |
| atox: generic chars to value | Dispatches to the most appropriate and efficient conversion function |
| to_chars: generalized chars to value | Convert the given value, writing into the string |
| from_chars: generalized chars to value | Read a value from the string, which must be trimmed to the value (ie, no leading/trailing whitespace) |
| Format utilities | Provides generic and type-safe formatting/scanning utilities built on top of to_chars: generalized chars to value and from_chars: generalized chars to value, forwarding the arguments to these functions, which in turn use the Charconv utilities utilities |
| Format specifiers | Format specifiers are tag types and functions that are used together with to_chars: generalized chars to value and from_chars: generalized chars to value |
| cat: concatenate arguments to string | |
| uncat: read concatenated arguments from string | |
| catsep: cat arguments to string with separator | |
| uncatsep: deserialize the separated arguments from a string | |
| format: formatted string interpolation | |
| unformat: formatted read from string | |
| Base64 encoding/decoding | |
| Base64 format specifiers | |
| UTF utilities |
1.15.0