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 >
std::enable_if< ! std::is_floating_point< T >::value, bool >::type	c4::yml::read (NodeRef const &n, T *v)
	convert the val of a scalar node to a floating point type, by forwarding its val to from_chars_float<T>(). More...
template<class T >
auto	c4::yml::read (ConstNodeRef const &n, T *v) -> typename std::enable_if< ! std::is_floating_point< T >::value, bool >::type
	convert the val of a scalar node to a particular type, by forwarding its val to from_chars<T>(). More...

Detailed Description

Function Documentation

key() [1/3]

template<class K >

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

inline

Definition at line 43 of file node.hpp.

{ return Key<K>{k}; }

Referenced by c4::yml::NodeInit::_add_flags(), c4::yml::NodeInit::_check(), c4::yml::NodeInit::clear(), c4::yml::Tree::find_sibling(), c4::yml::Tree::has_child(), c4::yml::Tree::has_sibling(), c4::yml::Tree::operator[](), c4::yml::read(), sample::read(), c4::yml::NodeRef::remove_child(), sample::sample_base64(), sample::sample_iterate_trees(), sample::sample_parse_in_arena(), sample::sample_parse_in_place(), sample::sample_parse_reuse_tree(), sample::sample_quick_overview(), c4::yml::NodeRef::set_key(), c4::yml::Tree::set_key(), c4::yml::write(), and sample::write().

key() [2/3]

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

inline

Definition at line 44 of file node.hpp.

{ return {w}; }

key() [3/3]

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

inline

Definition at line 45 of file node.hpp.

{ return {w}; }

write()

template<class T >

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

inline

Definition at line 1602 of file node.hpp.

{
    n->set_val_serialized(v);
}

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

Referenced by c4::yml::NodeRef::operator<<().

read() [1/2]

template<class T >

std::enable_if< ! std::is_floating_point<T>::value, bool>::type c4::yml::read ( NodeRef const &  n, T *  v  ) -> typename std::enable_if< ! std::is_floating_point< T >::value, bool >::type

inline

convert the val of a scalar node to a floating point type, by forwarding its val to from_chars_float<T>().

Returns

false if the conversion failed

Warning

Unlike non-floating types, only the leading part of the string that may constitute a number is processed. This happens because the float parsing is delegated to fast_float, which is implemented that way. Consequently, for example, all of "34", "34 " "34hg" "34 gh" will be read as 34. If you are not sure about the contents of the data, you can use csubstr::first_real_span() to check before calling >>, for example like this:

csubstr val = node.val();
if(val.first_real_span() == val)
    node >> v;
else
    ERROR("not a real")

convert the val of a scalar node to a floating point type, by forwarding its val to from_chars_float<T>().

The full string is used.

Returns

false if the conversion failed

Definition at line 1676 of file node.hpp.

{
    csubstr val = n.val();
    if(val.empty())
        return false;
    return from_chars_float(val, v);
}

References c4::yml::from_chars_float(), c4::yml::detail::read_skip_plus(), and c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::val().

Referenced by c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::operator>>().

read() [2/2]

template<class T >

auto c4::yml::read ( ConstNodeRef const &  n, T *  v  ) -> typename std::enable_if< ! std::is_floating_point<T>::value, bool>::type

inline

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

The full string is used.

Returns

false if the conversion failed

Definition at line 1643 of file node.hpp.

{
    csubstr val = n.val();
    if(val.empty())
        return false;
    return detail::read_skip_plus(val, v);
}

References c4::yml::detail::read_skip_plus().