To serialize user scalar types, implement the appropriate function to_chars (see also to_chars: generalized chars to value): More...

Functions
template<class T >
size_t	sample::to_chars (ryml::substr buf, vec2< T > v)

template<class T >
size_t	sample::to_chars (ryml::substr buf, vec3< T > v)

template<class T >
size_t	sample::to_chars (ryml::substr buf, vec4< T > v)

template<class T >
size_t	sample::to_chars (ryml::substr buf, emit_only_vec2< T > v)

template<class T >
size_t	sample::to_chars (ryml::substr buf, emit_only_vec3< T > v)

template<class T >
size_t	sample::to_chars (ryml::substr buf, emit_only_vec4< T > v)

Detailed Description

To serialize user scalar types, implement the appropriate function to_chars (see also to_chars: generalized chars to value):

// any of these can be used:
size_t to_chars(substr buf, T const& v);
size_t to_chars(substr buf, T v); // this also works, and is good when the type is small

See the sample sample_user_scalar_types() for an example usage.

Your implementation of to_chars must format v to the given string view + return the number of characters written into it. The view size (buf.len) must be strictly respected. Return the number of characters that need to be written for the value to be completely serialized in the string. So if the return value is larger than buf.len, ryml will know that the buffer resize the buffer and call this again with a larger buffer of the correct size.

In your implementation, you may be interested in using the formatting facilities in Format utilities and Charconv utilities; refer to their documentation for further details. But this is not mandatory, and anything can be used, provided that the implemented to_chars() fulfills its contract, described above.

Warning: Because of C++'s ADL rules, it is required to overload these functions in the namespace of the type you're serializing (or in the c4 namespace, or in the c4::yml namespace). [Here's an example of an issue where failing to do this was causing problems in some platforms](https://github.com/biojppm/rapidyaml/issues/424)

Note: Please take note of the following pitfall when using serialization functions: you may have to include the header with your to_chars() implementation before any other headers that use functions from it. See the include order at the top of this source file. This constraint also applies to the conversion functions for your types; just like with the STL's headers, they should be included prior to ryml's headers. Lately, some effort was directed to provide forward declarations to alleviate this problem, but it may still occur.