Read from Tree

Implementation of deserialization from a tree. More...

Functions
template<class T>
ReadResult	c4::yml::read (Tree const *tree, id_type id, T *v)
	Deserialize a scalar node's val from a tree object, returning false if the conversion failed.
template<class Wrapper>
ReadResult	c4::yml::read (Tree const *tree, id_type id, Wrapper const &w)
	overload to enable use of wrapper tag-types like eg c4::fmt::base64()
template<class T>
ReadResult	c4::yml::read_key (Tree const *tree, id_type id, T *v)
	Deserialize a node's key from a tree object, returning false if the conversion failed.
template<class Wrapper>
ReadResult	c4::yml::read_key (Tree const *tree, id_type id, Wrapper const &w)
	overload to enable use of wrapper tag-types like eg c4::fmt::base64()

Detailed Description

Implementation of deserialization from a tree.

Function Documentation

read() [1/2]

template<class T>

ReadResult c4::yml::read ( Tree const * tree, id_type id, T * v )

inline

Deserialize a scalar node's val from a tree object, returning false if the conversion failed.

Returns

false if the conversion failed

See also

scalar_deserialize()

the counterpart function read_key()

Definition at line 1871 of file tree.hpp.

{
    // caller only checks that type is one of VAL|MAP|SEQ (because it
    // can't be more concrete than that). Here, we expect a VAL so now
    // we can check for that:
    NodeData const* C4_RESTRICT nd = tree->_p(id);
    return ReadResult((nd->m_type & VAL) && scalar_deserialize(nd->m_val.scalar, v), id);
}

read() [2/2]

template<class Wrapper>

ReadResult c4::yml::read ( Tree const * tree, id_type id, Wrapper const & w )

inline

overload to enable use of wrapper tag-types like eg c4::fmt::base64()

Definition at line 1882 of file tree.hpp.

{
    // caller only checks that type is one of VAL|MAP|SEQ (because it
    // can't be more concrete than that). Here, we expect a VAL so now
    // we can check for that:
    NodeData const* C4_RESTRICT nd = tree->_p(id);
    return ReadResult((nd->m_type & VAL) && from_chars(nd->m_val.scalar, w), id);
}

read_key() [1/2]

template<class T>

ReadResult c4::yml::read_key ( Tree const * tree, id_type id, T * v )

inline

Deserialize a node's key from a tree object, returning false if the conversion failed.

Returns

false if the conversion failed

See also

the counterpart function read(Tree const*, id_type, T*)

Definition at line 1898 of file tree.hpp.

{
    // caller already checks availability of key
    return ReadResult(scalar_deserialize(tree->_p(id)->m_key.scalar, v), id);
}

read_key() [2/2]

template<class Wrapper>

ReadResult c4::yml::read_key ( Tree const * tree, id_type id, Wrapper const & w )

inline

overload to enable use of wrapper tag-types like eg c4::fmt::base64()

Definition at line 1906 of file tree.hpp.

{
    // caller already checks availability of key
    return ReadResult(from_chars(tree->_p(id)->m_key.scalar, w), id);
}