Contains information on how to serialize and deserialize fundamental types, user scalar types, user container types and interop with std scalar/container types.

Fundamental types

ryml provides serialization/deserialization utilities for all fundamental data types in Charconv utilities .

See sample::sample_fundamental_types() for basic examples of serialization of fundamental types.
See sample::sample_empty_null_values() for different ways to serialize and deserialize empty and null values/
When serializing floating point values in C++ earlier than 17, be aware that there may be a truncation of the precision with the default float/double implementations of to_chars: generalized chars to value. To enforce a particular precision, use for example c4::fmt::real, or call directly c4::ftoa() or c4::dtoa(), or any other method (remember that ryml only stores the final string in the tree, so nothing prevents you from creating it in whatever way is most suitable). See the relevant sample: sample::sample_float_precision().
You can also serialize and deserialize base64: see Base64 encoding/decoding and sample::sample_base64

To serialize/deserialize any non-fundamental type will require that you instruct ryml on how to achieve this. That will differ based on whether the type is scalar or container.

User scalar types

See Serialize/deserialize scalar types for serializing user scalar types (ie leaf nodes in the YAML tree, containing a string representation):

See examples on how to Define to_chars to write scalar types
See examples on how to Define from_chars to read scalar types
See the sample sample::sample_user_scalar_types
See the sample sample::sample_formatting for examples of functions from Format utilities that will be very helpful in implementing custom to_chars()/from_chars() functions.
See Charconv utilities for the implementations of to_chars()/from_chars() for the fundamental types.
See Substring: read/write string views and sample::sample_substr() for the many useful utilities in the substring class.

User container types

See Serialize/deserialize container types for when the type is a container (ie, a node which has children, which may themselves be containers).
- See the sample sample::sample_user_container_types
- See the sample sample::sample_std_types, and also...

STL types

ryml does not use any STL containers internally, but it can be used to serialize and deserialize these containers. See sample::sample_std_types() for an example. See the header ryml_std.hpp and also the headers it includes:

scalar types:
- for std::string: ext/c4core/src/c4/std/string.hpp
- for std::string_view: ext/c4core/src/c4/std/string_view.hpp
- for std::vector<char>: ext/c4core/src/c4/std/vector.hpp
container types:
- for std::vector<T>: src/c4/yml/std/vector.hpp
- for std::map<K,V>: src/c4/yml/std/map.hpp