Serialization helpers

Classes
struct	c4::yml::Key< K >
struct	c4::yml::Key< fmt::const_base64_wrapper >
struct	c4::yml::Key< fmt::base64_wrapper >

Functions
template<class K >
Key< K >	c4::yml::key (K &k)
Key< fmt::const_base64_wrapper >	c4::yml::key (fmt::const_base64_wrapper w)
Key< fmt::base64_wrapper >	c4::yml::key (fmt::base64_wrapper w)
template<class T >
void	c4::yml::write (NodeRef *n, T const &v)
template<class T >
bool	c4::yml::read (ConstNodeRef const &n, T *v)
template<class T >
bool	c4::yml::read (NodeRef const &n, T *v)
template<class T >
bool	c4::yml::readkey (ConstNodeRef const &n, T *v)
template<class T >
bool	c4::yml::readkey (NodeRef const &n, T *v)
template<class T >
auto	c4::yml::read (Tree const *tree, id_type id, T *v) -> typename std::enable_if<!std::is_arithmetic< T >::value, bool >::type
	convert the val of a scalar node to a particular non-arithmetic non-float type, by forwarding its val to from_chars<T>(). More...
template<class T >
auto	c4::yml::readkey (Tree const *tree, id_type id, T *v) -> typename std::enable_if<!std::is_arithmetic< T >::value, bool >::type
	convert the key of a node to a particular non-arithmetic non-float type, by forwarding its key to from_chars<T>(). More...
template<class T >
size_t	c4::yml::to_chars_float (substr buf, T val)
	encode a floating point value to a string. More...
template<class T >
bool	c4::yml::from_chars_float (csubstr buf, T *val)
	decode a floating point from string. More...
template<class T >
csubstr	c4::yml::serialize_to_arena (Tree *tree, T const &a)

Detailed Description

Function Documentation

key() [1/3]

template<class K >

Key<K> c4::yml::key ( K &  k )

inline

Definition at line 45 of file node.hpp.

{ return Key<K>{k}; }

key() [2/3]

Key<fmt::const_base64_wrapper> c4::yml::key ( fmt::const_base64_wrapper  w )

inline

Definition at line 46 of file node.hpp.

{ return {w}; }

key() [3/3]

Key<fmt::base64_wrapper> c4::yml::key ( fmt::base64_wrapper  w )

inline

Definition at line 47 of file node.hpp.

{ return {w}; }

write()

template<class T >

void c4::yml::write ( NodeRef *  n, T const &  v  )

inline

Definition at line 1632 of file node.hpp.

{
    n->set_val_serialized(v);
}

References c4::yml::NodeRef::set_val_serialized().

read() [1/3]

template<class T >

bool c4::yml::read ( ConstNodeRef const &  n, T *  v  )

inline

Definition at line 1638 of file node.hpp.

{
    return read(n.m_tree, n.m_id, v);
}

read() [2/3]

template<class T >

bool c4::yml::read ( NodeRef const &  n, T *  v  )

inline

Definition at line 1644 of file node.hpp.

{
    return read(n.tree(), n.id(), v);
}

References c4::yml::read().

readkey() [1/3]

template<class T >

bool c4::yml::readkey ( ConstNodeRef const &  n, T *  v  )

inline

Definition at line 1650 of file node.hpp.

{
    return readkey(n.m_tree, n.m_id, v);
}

readkey() [2/3]

template<class T >

bool c4::yml::readkey ( NodeRef const &  n, T *  v  )

inline

Definition at line 1656 of file node.hpp.

{
    return readkey(n.tree(), n.id(), v);
}

References c4::yml::readkey().

read() [3/3]

template<class T >

auto c4::yml::read ( Tree const *  tree, id_type  id, T *  v  ) -> typename std::enable_if<!std::is_arithmetic<T>::value, bool>::type

inline

convert the val of a scalar node to a particular non-arithmetic non-float type, by forwarding its val to from_chars<T>().

convert the val of a scalar node to a particular arithmetic integral non-float type, by forwarding its val to from_chars<T>().

The full string is used.

Returns

false if the conversion failed, or if the key was empty and unquoted

The full string is used.

Returns

false if the conversion failed

Definition at line 1364 of file tree.hpp.

{
    return C4_LIKELY(!(tree->type(id) & VALNIL)) ? from_chars(tree->val(id), v) : false;
}

References from_chars(), and c4::yml::VALNIL.

readkey() [3/3]

template<class T >

auto c4::yml::readkey ( Tree const *  tree, id_type  id, T *  v  ) -> typename std::enable_if<!std::is_arithmetic<T>::value, bool>::type

inline

convert the key of a node to a particular non-arithmetic non-float type, by forwarding its key to from_chars<T>().

convert the key of a node to a particular arithmetic integral non-float type, by forwarding its val to from_chars<T>().

The full string is used.

Returns

false if the conversion failed, or if the key was empty and unquoted

The full string is used.

Returns

false if the conversion failed

Definition at line 1375 of file tree.hpp.

{
    return C4_LIKELY(!(tree->type(id) & KEYNIL)) ? from_chars(tree->key(id), v) : false;
}

References from_chars(), and c4::yml::KEYNIL.

to_chars_float()

template<class T >

size_t c4::yml::to_chars_float	(	substr	buf,
		T	val
	)

encode a floating point value to a string.

Definition at line 1439 of file tree.hpp.

{
    static_assert(std::is_floating_point<T>::value, "must be floating point");
    C4_SUPPRESS_WARNING_GCC_CLANG_WITH_PUSH("-Wfloat-equal");
    if(C4_UNLIKELY(std::isnan(val)))
        return to_chars(buf, csubstr(".nan"));
    else if(C4_UNLIKELY(val == std::numeric_limits<T>::infinity()))
        return to_chars(buf, csubstr(".inf"));
    else if(C4_UNLIKELY(val == -std::numeric_limits<T>::infinity()))
        return to_chars(buf, csubstr("-.inf"));
    return to_chars(buf, val);
    C4_SUPPRESS_WARNING_GCC_CLANG_POP
}

References c4::yml::to_chars().

from_chars_float()

template<class T >

bool c4::yml::from_chars_float	(	csubstr	buf,
		T *	val
	)

decode a floating point from string.

Accepts special values: .nan, .inf, -.inf

Definition at line 1457 of file tree.hpp.

{
    static_assert(std::is_floating_point<T>::value, "must be floating point");
    if(buf.begins_with('+'))
    {
        buf = buf.sub(1);
    }
    if(C4_LIKELY(from_chars(buf, val)))
    {
        return true;
    }
    else if(C4_UNLIKELY(buf == ".nan" || buf == ".NaN" || buf == ".NAN"))
    {
        *val = std::numeric_limits<T>::quiet_NaN();
        return true;
    }
    else if(C4_UNLIKELY(buf == ".inf" || buf == ".Inf" || buf == ".INF"))
    {
        *val = std::numeric_limits<T>::infinity();
        return true;
    }
    else if(C4_UNLIKELY(buf == "-.inf" || buf == "-.Inf" || buf == "-.INF"))
    {
        *val = -std::numeric_limits<T>::infinity();
        return true;
    }
    else
    {
        return false;
    }
}

References from_chars().

serialize_to_arena()

template<class T >

csubstr c4::yml::serialize_to_arena	(	Tree *	tree,
		T const &	a
	)

Definition at line 1553 of file tree.hpp.

{
    substr rem(tree->m_arena.sub(tree->m_arena_pos));
    size_t num = serialize_scalar(rem, a);
    if(num > rem.len)
    {
        rem = tree->_grow_arena(num);
        num = serialize_scalar(rem, a);
        _RYML_ASSERT_VISIT_(tree->m_callbacks, num <= rem.len, tree, NONE);
    }
    rem = tree->_request_span(num);
    return rem;
}

References c4::yml::NONE, and c4::yml::serialize_scalar().