c4::yml::detail::RoNodeMethods< Impl, ConstImpl > Struct Template Reference

a CRTP base providing read-only methods for ConstNodeRef and NodeRef More...

#include <node.hpp>

Inheritance diagram for c4::yml::detail::RoNodeMethods< Impl, ConstImpl >:

Public Member Functions
node property getters
NodeType	type () const RYML_NOEXCEPT
	Forward to Tree::type(). More...
csubstr	key () const RYML_NOEXCEPT
	Forward to Tree::key(). More...
csubstr	key_tag () const RYML_NOEXCEPT
	Forward to Tree::key_tag(). More...
csubstr	key_ref () const RYML_NOEXCEPT
	Forward to Tree::key_ref(). More...
csubstr	key_anchor () const RYML_NOEXCEPT
	Forward to Tree::key_anchor(). More...
csubstr	val () const RYML_NOEXCEPT
	Forward to Tree::val(). More...
csubstr	val_tag () const RYML_NOEXCEPT
	Forward to Tree::val_tag(). More...
csubstr	val_ref () const RYML_NOEXCEPT
	Forward to Tree::val_ref(). More...
csubstr	val_anchor () const RYML_NOEXCEPT
	Forward to Tree::val_anchor(). More...
NodeScalar const &	keysc () const RYML_NOEXCEPT
	Forward to Tree::keysc(). More...
NodeScalar const &	valsc () const RYML_NOEXCEPT
	Forward to Tree::valsc(). More...
bool	key_is_null () const RYML_NOEXCEPT
	Forward to Tree::key_is_null(). More...
bool	val_is_null () const RYML_NOEXCEPT
	Forward to Tree::val_is_null(). More...
bool	is_key_unfiltered () const noexcept
	Forward to Tree::is_key_unfiltered(). More...
bool	is_val_unfiltered () const noexcept
	Forward to Tree::is_val_unfiltered(). More...
node type predicates
bool	empty () const RYML_NOEXCEPT
	Forward to Tree::empty(). More...
bool	is_stream () const RYML_NOEXCEPT
	Forward to Tree::is_stream(). More...
bool	is_doc () const RYML_NOEXCEPT
	Forward to Tree::is_doc(). More...
bool	is_container () const RYML_NOEXCEPT
	Forward to Tree::is_container(). More...
bool	is_map () const RYML_NOEXCEPT
	Forward to Tree::is_map(). More...
bool	is_seq () const RYML_NOEXCEPT
	Forward to Tree::is_seq(). More...
bool	has_val () const RYML_NOEXCEPT
	Forward to Tree::has_val(). More...
bool	has_key () const RYML_NOEXCEPT
	Forward to Tree::has_key(). More...
bool	is_val () const RYML_NOEXCEPT
	Forward to Tree::is_val(). More...
bool	is_keyval () const RYML_NOEXCEPT
	Forward to Tree::is_keyval(). More...
bool	has_key_tag () const RYML_NOEXCEPT
	Forward to Tree::has_key_tag(). More...
bool	has_val_tag () const RYML_NOEXCEPT
	Forward to Tree::has_val_tag(). More...
bool	has_key_anchor () const RYML_NOEXCEPT
	Forward to Tree::has_key_anchor(). More...
bool	has_val_anchor () const RYML_NOEXCEPT
	Forward to Tree::has_val_anchor(). More...
bool	has_anchor () const RYML_NOEXCEPT
	Forward to Tree::has_anchor(). More...
bool	is_key_ref () const RYML_NOEXCEPT
	Forward to Tree::is_key_ref(). More...
bool	is_val_ref () const RYML_NOEXCEPT
	Forward to Tree::is_val_ref(). More...
bool	is_ref () const RYML_NOEXCEPT
	Forward to Tree::is_ref(). More...
bool	parent_is_seq () const RYML_NOEXCEPT
	Forward to Tree::parent_is_seq(). More...
bool	parent_is_map () const RYML_NOEXCEPT
	Forward to Tree::parent_is_map(). More...
style predicates
bool	type_has_any (type_bits bits) const RYML_NOEXCEPT
	Forward to Tree::type_has_any(). More...
bool	type_has_all (type_bits bits) const RYML_NOEXCEPT
	Forward to Tree::type_has_all(). More...
bool	type_has_none (type_bits bits) const RYML_NOEXCEPT
	Forward to Tree::type_has_none(). More...
NodeType	key_style () const RYML_NOEXCEPT
	Forward to Tree::key_style(). More...
NodeType	val_style () const RYML_NOEXCEPT
	Forward to Tree::val_style(). More...
bool	is_container_styled () const RYML_NOEXCEPT
	Forward to Tree::is_container_styled(). More...
bool	is_block () const RYML_NOEXCEPT
	Forward to Tree::is_block(). More...
bool	is_flow () const RYML_NOEXCEPT
	Forward to Tree::is_flow(). More...
bool	is_flow_sl () const RYML_NOEXCEPT
	Forward to Tree::is_flow_sl(). More...
bool	is_flow_ml () const RYML_NOEXCEPT
	Forward to Tree::is_flow_ml1(). More...
bool	is_flow_ml1 () const RYML_NOEXCEPT
	Forward to Tree::is_flow_ml1(). More...
bool	is_flow_mln () const RYML_NOEXCEPT
	Forward to Tree::is_flow_mln(). More...
bool	is_flow_mlx () const RYML_NOEXCEPT
	Forward to Tree::is_flow_mlx(). More...
bool	has_flow_space () const RYML_NOEXCEPT
	Forward to Tree::has_flow_space(). More...
bool	is_key_styled () const RYML_NOEXCEPT
	Forward to Tree::is_key_styled(). More...
bool	is_val_styled () const RYML_NOEXCEPT
	Forward to Tree::is_val_styled(). More...
bool	is_key_literal () const RYML_NOEXCEPT
	Forward to Tree::is_key_literal(). More...
bool	is_val_literal () const RYML_NOEXCEPT
	Forward to Tree::is_val_literal(). More...
bool	is_key_folded () const RYML_NOEXCEPT
	Forward to Tree::is_key_folded(). More...
bool	is_val_folded () const RYML_NOEXCEPT
	Forward to Tree::is_val_folded(). More...
bool	is_key_squo () const RYML_NOEXCEPT
	Forward to Tree::is_key_squo(). More...
bool	is_val_squo () const RYML_NOEXCEPT
	Forward to Tree::is_val_squo(). More...
bool	is_key_dquo () const RYML_NOEXCEPT
	Forward to Tree::is_key_dquo(). More...
bool	is_val_dquo () const RYML_NOEXCEPT
	Forward to Tree::is_val_dquo(). More...
bool	is_key_plain () const RYML_NOEXCEPT
	Forward to Tree::is_key_plain(). More...
bool	is_val_plain () const RYML_NOEXCEPT
	Forward to Tree::is_val_plain(). More...
bool	is_key_quoted () const RYML_NOEXCEPT
	Forward to Tree::is_key_quoted(). More...
bool	is_val_quoted () const RYML_NOEXCEPT
	Forward to Tree::is_val_quoted(). More...
bool	is_quoted () const RYML_NOEXCEPT
	Forward to Tree::is_quoted(). More...
hierarchy predicates
bool	is_root () const RYML_NOEXCEPT
	Forward to Tree::is_root(). More...
bool	has_parent () const RYML_NOEXCEPT
	Forward to Tree::has_parent() Node must be readable. More...
bool	is_ancestor (ConstImpl const &ancestor) const RYML_NOEXCEPT
	Forward to Tree::is_ancestor() Node must be readable. More...
bool	has_child (ConstImpl const &n) const RYML_NOEXCEPT
	Forward to Tree::has_child(). More...
bool	has_child (id_type node) const RYML_NOEXCEPT
	Forward to Tree::has_child(). More...
bool	has_child (csubstr name) const RYML_NOEXCEPT
	Forward to Tree::has_child(). More...
bool	has_children () const RYML_NOEXCEPT
	Forward to Tree::has_children(). More...
bool	has_sibling (ConstImpl const &n) const RYML_NOEXCEPT
	Forward to Tree::has_sibling(). More...
bool	has_sibling (id_type node) const RYML_NOEXCEPT
	Forward to Tree::has_sibling(). More...
bool	has_sibling (csubstr name) const RYML_NOEXCEPT
	Forward to Tree::has_sibling(). More...
bool	has_other_siblings () const RYML_NOEXCEPT
	Forward to Tree::has_other_siblings(). More...
hierarchy getters
id_type	num_children () const RYML_NOEXCEPT
	O(num_children). More...
id_type	num_siblings () const RYML_NOEXCEPT
	O(num_children). More...
id_type	num_other_siblings () const RYML_NOEXCEPT
	O(num_siblings). More...
id_type	child_pos (ConstImpl const &n) const RYML_NOEXCEPT
	O(num_children). More...
id_type	sibling_pos (ConstImpl const &n) const RYML_NOEXCEPT
	O(num_siblings). More...
id_type	depth_asc () const RYML_NOEXCEPT
id_type	depth_desc () const RYML_NOEXCEPT
	O(log(num_nodes)). More...
locations
O(num_nodes). Forward to Tree::depth_desc(). Node must be readable.
Location	location (Parser const &parser) const
deserialization: fully checked for lazy code
These methods raise an error if the deserialization failed or optionally if the node is not readable.
template<class T >
void	load (T *v, bool check_readable=true) const
	(1) deserialize the node's contents (val or container) to the given variable, forwarding to the user-overrideable read() function, which can be for ConstNodeRef (see Read from ConstNodeRef) or for tree+id (see Read from Tree). More...
template<class Wrapper >
void	load (Wrapper const &wrapper, bool check_readable=true) const
	(2) like (1), but for wrapper tag types such as c4::fmt::base64() More...
template<class T >
void	load_key (T *k, bool check_readable=true) const
	(1) deserialize the node's key (necessarily a scalar) to the given variable, forwarding to the user-overrideable read_key() function, which can be for ConstNodeRef (see Read from ConstNodeRef) or for tree+id (see Read from Tree). More...
template<class Wrapper >
void	load_key (Wrapper const &wrapper, bool check_readable=true) const
	(2) like (1), but for wrapper tag types such as c4::fmt::base64() More...
deserialization: asserts node readability, returns success status
template<class T >
ReadResult	deserialize (T *v) const
	(1) deserialize the node's contents (val or container) to the given variable, forwarding to the user-overrideable read() function (see Read from ConstNodeRef). More...
template<class Wrapper >
ReadResult	deserialize (Wrapper const &wrapper) const
	(2) like (1), but for wrapper tag types such as c4::fmt::base64() More...
template<class T >
ReadResult	deserialize_key (T *v) const
	(1) deserialize the node's key (necessarily a scalar) to the given variable, forwarding to the user-overrideable read_key() function (see Read from ConstNodeRef). More...
template<class Wrapper >
ReadResult	deserialize_key (Wrapper const &wrapper) const
	(2) like (1), but for wrapper tag types such as c4::fmt::base64() More...
lookup and deserialize
template<class T >
ReadResult	deserialize_child (csubstr child_key, T *v) const
	(1) find a child by name and deserialize its contents to the given variable (ie call .deserialize() on the child if it exists). More...
template<class T >
ReadResult	deserialize_child (csubstr child_key, T *v, T const &fallback) const
	(2) like (1), but assign from fallback if no such child exists. More...
template<class Wrapper >
ReadResult	deserialize_child (csubstr child_key, Wrapper const &v) const
	(3) like (1), but for wrapper tag types such as c4::fmt::base64() More...
template<class T >
ReadResult	deserialize_child (id_type child_pos, T *v) const
	(1) find a child by position and deserialize its contents to the given variable (ie call .deserialize() on the child if it exists). More...
template<class T >
ReadResult	deserialize_child (id_type child_pos, T *v, T const &fallback) const
	(2) like (1), but assign from fallback if no such child exists More...
template<class Wrapper >
ReadResult	deserialize_child (id_type child_pos, Wrapper const &wrapper) const
	(3) like (1), but for wrapper tag types such as c4::fmt::base64() More...
legacy operators
template<class T >
Impl const &	operator>> (T &v) const
template<class T >
Impl const &	operator>> (T const &wrapper) const
template<class T >
Impl const &	operator>> (Key< T > const &v) const

Protected Member Functions
void	check_val_ () const
void	check_key_ () const
void	assert_val_ () const noexcept
void	assert_key_ () const noexcept

Static Protected Member Functions
static void	err_basic_ (const char *msg)
static void	err_visit_ (Tree const *tree, id_type id, const char *msg)

Detailed Description

template<class Impl, class ConstImpl>
struct c4::yml::detail::RoNodeMethods< Impl, ConstImpl >

a CRTP base providing read-only methods for ConstNodeRef and NodeRef

Definition at line 152 of file node.hpp.

Member Function Documentation

template<class Impl, class ConstImpl>

NodeType c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::type ( ) const

inline

Forward to Tree::type().

Node must be readable.

Definition at line 172 of file node.hpp.

Referenced by sample_style_flow_formatting().

template<class Impl, class ConstImpl>

csubstr c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::key ( ) const

inline

Forward to Tree::key().

Node must be readable.

Definition at line 174 of file node.hpp.

Referenced by sample_quick_overview().

template<class Impl, class ConstImpl>

csubstr c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::key_tag ( ) const

inline

Forward to Tree::key_tag().

Node must be readable.

Definition at line 175 of file node.hpp.

template<class Impl, class ConstImpl>

csubstr c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::key_ref ( ) const

inline

Forward to Tree::key_ref().

Node must be readable.

Definition at line 176 of file node.hpp.

template<class Impl, class ConstImpl>

csubstr c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::key_anchor ( ) const

inline

Forward to Tree::key_anchor().

Node must be readable.

Definition at line 177 of file node.hpp.

template<class Impl, class ConstImpl>

csubstr c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::val ( ) const

inline

Forward to Tree::val().

Node must be readable.

Definition at line 179 of file node.hpp.

Referenced by sample_base64(), sample_create_tree(), sample_fundamental_types(), and sample_quick_overview().

template<class Impl, class ConstImpl>

csubstr c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::val_tag ( ) const

inline

Forward to Tree::val_tag().

Node must be readable.

Definition at line 180 of file node.hpp.

template<class Impl, class ConstImpl>

csubstr c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::val_ref ( ) const

inline

Forward to Tree::val_ref().

Node must be readable.

Definition at line 181 of file node.hpp.

template<class Impl, class ConstImpl>

csubstr c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::val_anchor ( ) const

inline

Forward to Tree::val_anchor().

Node must be readable.

Definition at line 182 of file node.hpp.

template<class Impl, class ConstImpl>

NodeScalar const& c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::keysc ( ) const

inline

Forward to Tree::keysc().

Node must be readable.

Definition at line 184 of file node.hpp.

template<class Impl, class ConstImpl>

NodeScalar const& c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::valsc ( ) const

inline

Forward to Tree::valsc().

Node must be readable.

Definition at line 185 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::key_is_null ( ) const

inline

Forward to Tree::key_is_null().

Node must be readable.

Definition at line 187 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::val_is_null ( ) const

inline

Forward to Tree::val_is_null().

Node must be readable.

Definition at line 188 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_key_unfiltered ( ) const

inlinenoexcept

Forward to Tree::is_key_unfiltered().

Node must be readable.

Definition at line 190 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_val_unfiltered ( ) const

inlinenoexcept

Forward to Tree::is_val_unfiltered().

Node must be readable.

Definition at line 191 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::empty ( ) const

inline

Forward to Tree::empty().

Node must be readable.

Definition at line 203 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_stream ( ) const

inline

Forward to Tree::is_stream().

Node must be readable.

Definition at line 204 of file node.hpp.

Referenced by sample_docs(), and sample_tags().

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_doc ( ) const

inline

Forward to Tree::is_doc().

Node must be readable.

Definition at line 205 of file node.hpp.

Referenced by sample_docs().

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_container ( ) const

inline

Forward to Tree::is_container().

Node must be readable.

Definition at line 206 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_map ( ) const

inline

Forward to Tree::is_map().

Node must be readable.

Definition at line 207 of file node.hpp.

Referenced by c4::yml::read(), read(), sample_parse_in_arena(), sample_parse_in_place(), and sample_parse_reuse_tree().

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_seq ( ) const

inline

Forward to Tree::is_seq().

Node must be readable.

Definition at line 208 of file node.hpp.

Referenced by c4::yml::read(), read(), sample_parse_reuse_tree(), and sample_quick_overview().

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::has_val ( ) const

inline

Forward to Tree::has_val().

Node must be readable.

Definition at line 209 of file node.hpp.

Referenced by sample_quick_overview().

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::has_key ( ) const

inline

Forward to Tree::has_key().

Node must be readable.

Definition at line 210 of file node.hpp.

Referenced by sample_quick_overview().

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_val ( ) const

inline

Forward to Tree::is_val().

Node must be readable.

Definition at line 211 of file node.hpp.

Referenced by sample_quick_overview().

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_keyval ( ) const

inline

Forward to Tree::is_keyval().

Node must be readable.

Definition at line 212 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::has_key_tag ( ) const

inline

Forward to Tree::has_key_tag().

Node must be readable.

Definition at line 213 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::has_val_tag ( ) const

inline

Forward to Tree::has_val_tag().

Node must be readable.

Definition at line 214 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::has_key_anchor ( ) const

inline

Forward to Tree::has_key_anchor().

Node must be readable.

Definition at line 215 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::has_val_anchor ( ) const

inline

Forward to Tree::has_val_anchor().

Node must be readable.

Definition at line 216 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::has_anchor ( ) const

inline

Forward to Tree::has_anchor().

Node must be readable.

Definition at line 217 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_key_ref ( ) const

inline

Forward to Tree::is_key_ref().

Node must be readable.

Definition at line 218 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_val_ref ( ) const

inline

Forward to Tree::is_val_ref().

Node must be readable.

Definition at line 219 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_ref ( ) const

inline

Forward to Tree::is_ref().

Node must be readable.

Definition at line 220 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::parent_is_seq ( ) const

inline

Forward to Tree::parent_is_seq().

Node must be readable.

Definition at line 221 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::parent_is_map ( ) const

inline

Forward to Tree::parent_is_map().

Node must be readable.

Definition at line 222 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::type_has_any ( type_bits  bits ) const

inline

Forward to Tree::type_has_any().

Node must be readable.

Definition at line 234 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::type_has_all ( type_bits  bits ) const

inline

Forward to Tree::type_has_all().

Node must be readable.

Definition at line 235 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::type_has_none ( type_bits  bits ) const

inline

Forward to Tree::type_has_none().

Node must be readable.

Definition at line 236 of file node.hpp.

template<class Impl, class ConstImpl>

NodeType c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::key_style ( ) const

inline

Forward to Tree::key_style().

Node must be readable.

Definition at line 238 of file node.hpp.

template<class Impl, class ConstImpl>

NodeType c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::val_style ( ) const

inline

Forward to Tree::val_style().

Node must be readable.

Definition at line 239 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_container_styled ( ) const

inline

Forward to Tree::is_container_styled().

Node must be readable.

Definition at line 241 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_block ( ) const

inline

Forward to Tree::is_block().

Node must be readable.

Definition at line 242 of file node.hpp.

Referenced by sample_parse_style(), and sample_style().

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_flow ( ) const

inline

Forward to Tree::is_flow().

Node must be readable.

Definition at line 243 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_flow_sl ( ) const

inline

Forward to Tree::is_flow_sl().

Node must be readable.

Definition at line 244 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_flow_ml ( ) const

inline

Forward to Tree::is_flow_ml1().

Node must be readable.

Definition at line 246 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_flow_ml1 ( ) const

inline

Forward to Tree::is_flow_ml1().

Node must be readable.

Definition at line 247 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_flow_mln ( ) const

inline

Forward to Tree::is_flow_mln().

Node must be readable.

Definition at line 248 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_flow_mlx ( ) const

inline

Forward to Tree::is_flow_mlx().

Node must be readable.

Definition at line 249 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::has_flow_space ( ) const

inline

Forward to Tree::has_flow_space().

Node must be readable.

Definition at line 250 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_key_styled ( ) const

inline

Forward to Tree::is_key_styled().

Node must be readable.

Definition at line 252 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_val_styled ( ) const

inline

Forward to Tree::is_val_styled().

Node must be readable.

Definition at line 253 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_key_literal ( ) const

inline

Forward to Tree::is_key_literal().

Node must be readable.

Definition at line 254 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_val_literal ( ) const

inline

Forward to Tree::is_val_literal().

Node must be readable.

Definition at line 255 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_key_folded ( ) const

inline

Forward to Tree::is_key_folded().

Node must be readable.

Definition at line 256 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_val_folded ( ) const

inline

Forward to Tree::is_val_folded().

Node must be readable.

Definition at line 257 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_key_squo ( ) const

inline

Forward to Tree::is_key_squo().

Node must be readable.

Definition at line 258 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_val_squo ( ) const

inline

Forward to Tree::is_val_squo().

Node must be readable.

Definition at line 259 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_key_dquo ( ) const

inline

Forward to Tree::is_key_dquo().

Node must be readable.

Definition at line 260 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_val_dquo ( ) const

inline

Forward to Tree::is_val_dquo().

Node must be readable.

Definition at line 261 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_key_plain ( ) const

inline

Forward to Tree::is_key_plain().

Node must be readable.

Definition at line 262 of file node.hpp.

Referenced by sample_create_tree_style().

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_val_plain ( ) const

inline

Forward to Tree::is_val_plain().

Node must be readable.

Definition at line 263 of file node.hpp.

Referenced by sample_create_tree_style().

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_key_quoted ( ) const

inline

Forward to Tree::is_key_quoted().

Node must be readable.

Definition at line 264 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_val_quoted ( ) const

inline

Forward to Tree::is_val_quoted().

Node must be readable.

Definition at line 265 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_quoted ( ) const

inline

Forward to Tree::is_quoted().

Node must be readable.

Definition at line 266 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_root ( ) const

inline

Forward to Tree::is_root().

Node must be readable.

Definition at line 278 of file node.hpp.

Referenced by sample_docs().

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::has_parent ( ) const

inline

Forward to Tree::has_parent() Node must be readable.

Definition at line 279 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::is_ancestor ( ConstImpl const &  ancestor ) const

inline

Forward to Tree::is_ancestor() Node must be readable.

Definition at line 280 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::has_child ( ConstImpl const &  n ) const

inline

Forward to Tree::has_child().

Node must be readable.

Definition at line 282 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::has_child ( id_type  node ) const

inline

Forward to Tree::has_child().

Node must be readable.

Definition at line 283 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::has_child ( csubstr  name ) const

inline

Forward to Tree::has_child().

Node must be readable.

Definition at line 284 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::has_children ( ) const

inline

Forward to Tree::has_children().

Node must be readable.

Definition at line 285 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::has_sibling ( ConstImpl const &  n ) const

inline

Forward to Tree::has_sibling().

Node must be readable.

Definition at line 287 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::has_sibling ( id_type  node ) const

inline

Forward to Tree::has_sibling().

Node must be readable.

Definition at line 288 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::has_sibling ( csubstr  name ) const

inline

Forward to Tree::has_sibling().

Node must be readable.

Definition at line 289 of file node.hpp.

template<class Impl, class ConstImpl>

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::has_other_siblings ( ) const

inline

Forward to Tree::has_other_siblings().

Node must be readable.

Definition at line 290 of file node.hpp.

template<class Impl, class ConstImpl>

id_type c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::num_children ( ) const

inline

O(num_children).

Forward to Tree::num_children().

Definition at line 302 of file node.hpp.

Referenced by sample_docs(), sample_parse_reuse_tree(), and sample_tags().

template<class Impl, class ConstImpl>

id_type c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::num_siblings ( ) const

inline

O(num_children).

Forward to Tree::num_siblings().

Definition at line 303 of file node.hpp.

Referenced by sample_quick_overview().

template<class Impl, class ConstImpl>

id_type c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::num_other_siblings ( ) const

inline

O(num_siblings).

Forward to Tree::num_other_siblings().

Definition at line 304 of file node.hpp.

template<class Impl, class ConstImpl>

id_type c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::child_pos ( ConstImpl const &  n ) const

inline

O(num_children).

Forward to Tree::child_pos().

Definition at line 305 of file node.hpp.

template<class Impl, class ConstImpl>

id_type c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::sibling_pos ( ConstImpl const &  n ) const

inline

O(num_siblings).

Forward to Tree::sibling_pos().

Definition at line 306 of file node.hpp.

template<class Impl, class ConstImpl>

id_type c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::depth_asc ( ) const

inline

Definition at line 308 of file node.hpp.

{ this_assert_readable_(); return tree_->depth_asc(id_); } /** O(log(num_nodes)). Forward to Tree::depth_asc(). Node must be readable. */

template<class Impl, class ConstImpl>

id_type c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::depth_desc ( ) const

inline

O(log(num_nodes)).

Forward to Tree::depth_asc(). Node must be readable.

Definition at line 309 of file node.hpp.

{ this_assert_readable_(); return tree_->depth_desc(id_); } /** O(num_nodes). Forward to Tree::depth_desc(). Node must be readable. */

template<class Impl, class ConstImpl>

Location c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::location ( Parser const &  parser ) const

inline

Definition at line 318 of file node.hpp.

Referenced by sample_location_tracking(), and sample_quick_overview().

    {
        this_assert_readable_();
        return tree_->location(parser, id_);
    }

template<class Impl, class ConstImpl>

template<class T >

void c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::load ( T *  v, bool  check_readable = true  ) const

inline

(1) deserialize the node's contents (val or container) to the given variable, forwarding to the user-overrideable read() function, which can be for ConstNodeRef (see Read from ConstNodeRef) or for tree+id (see Read from Tree).

This method differs from ConstNodeRef::deserialize() in that here the error callback is called if the deserialization failed, or (optionally) the node is not readable.

Definition at line 345 of file node.hpp.

Referenced by sample_base64(), sample_deserialize_error(), sample_float_precision(), sample_fundamental_types(), sample_lightning_overview(), sample_parse_in_arena(), sample_parse_in_place(), sample_std_types(), sample_user_container_types(), sample_user_container_types_brief(), and sample_user_scalar_types().

    {
        if(check_readable)
            check_val_();
        else
            assert_val_(); // assert otherwise
        // we can call read() directly because we checked everything
        // (or the caller told us so)
        // use the adapter ctor to accomodate legacy read() implementations
        const ReadResult result(read((ConstImpl const&)*this, v), id_);
        if C4_UNLIKELY(!result)
            err_visit_(tree_, result.node, "could not deserialize node");
    }

template<class Impl, class ConstImpl>

template<class Wrapper >

void c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::load ( Wrapper const &  wrapper, bool  check_readable = true  ) const

inline

(2) like (1), but for wrapper tag types such as c4::fmt::base64()

Definition at line 361 of file node.hpp.

    {
        RYML_CHECK_TYPE_IS_WRAPPER_LIKE_(Wrapper);
        if(check_readable)
            check_val_();
        else
            assert_val_(); // assert otherwise
        // we can call read() directly because we checked everything
        // (or the caller told us so)
        // use the adapter ctor to accomodate legacy read() implementations
        const ReadResult result(read((ConstImpl const&)*this, wrapper), id_);
        if C4_UNLIKELY(!result)
            err_visit_(tree_, result.node, "could not deserialize node");
    }

template<class Impl, class ConstImpl>

template<class T >

void c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::load_key ( T *  k, bool  check_readable = true  ) const

inline

(1) deserialize the node's key (necessarily a scalar) to the given variable, forwarding to the user-overrideable read_key() function, which can be for ConstNodeRef (see Read from ConstNodeRef) or for tree+id (see Read from Tree).

This method differs from ConstNodeRef::deserialize_key() in that here the error callback is called if the deserialization failed, or (optionally) the node is not readable.

Definition at line 385 of file node.hpp.

    {
        if(check_readable)
            check_key_();
        else
            assert_key_(); // assert otherwise
        // we can call read_key() directly because we checked
        // everything (or the caller told us so)
        // use the adapter ctor to accomodate legacy read_key() implementations
        const ReadResult result(read_key((ConstImpl const&)*this, k), id_);
        if C4_UNLIKELY(!result)
            err_visit_(tree_, result.node, "could not deserialize key");
    }

template<class Impl, class ConstImpl>

template<class Wrapper >

void c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::load_key ( Wrapper const &  wrapper, bool  check_readable = true  ) const

inline

(2) like (1), but for wrapper tag types such as c4::fmt::base64()

Definition at line 401 of file node.hpp.

    {
        RYML_CHECK_TYPE_IS_WRAPPER_LIKE_(Wrapper);
        if(check_readable)
            check_key_();
        else
            assert_key_(); // assert otherwise
        // we can call read_key() directly because we checked
        // everything (or the caller told us so)
        // use the adapter ctor to accomodate legacy read_key() implementations
        const ReadResult result(read_key((ConstImpl const&)*this, wrapper), id_);
        if C4_UNLIKELY(!result)
            err_visit_(tree_, result.node, "could not deserialize key");
    }

template<class Impl, class ConstImpl>

template<class T >

ReadResult c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::deserialize ( T *  v ) const

inline

(1) deserialize the node's contents (val or container) to the given variable, forwarding to the user-overrideable read() function (see Read from ConstNodeRef).

Returns

a ReadResult with the deserialization status.

Definition at line 428 of file node.hpp.

Referenced by sample_deserialize_error().

    {
        assert_val_();
        // use the adapter ctor to accomodate legacy read() implementations
        return ReadResult(read((ConstImpl const&)*this, v), id_);
    }

template<class Impl, class ConstImpl>

template<class Wrapper >

ReadResult c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::deserialize ( Wrapper const &  wrapper ) const

inline

(2) like (1), but for wrapper tag types such as c4::fmt::base64()

Definition at line 437 of file node.hpp.

    {
        RYML_CHECK_TYPE_IS_WRAPPER_LIKE_(Wrapper);
        assert_val_();
        // use the adapter ctor to accomodate legacy read() implementations
        return ReadResult(read((ConstImpl const&)*this, wrapper), id_);
    }

template<class Impl, class ConstImpl>

template<class T >

ReadResult c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::deserialize_key ( T *  v ) const

inline

(1) deserialize the node's key (necessarily a scalar) to the given variable, forwarding to the user-overrideable read_key() function (see Read from ConstNodeRef).

Returns

a ReadResult with the deserialization status.

Definition at line 451 of file node.hpp.

    {
        assert_key_();
        // use the adapter ctor to accomodate legacy read_key() implementations
        return ReadResult(read_key((ConstImpl const&)*this, v), id_);
    }

template<class Impl, class ConstImpl>

template<class Wrapper >

ReadResult c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::deserialize_key ( Wrapper const &  wrapper ) const

inline

(2) like (1), but for wrapper tag types such as c4::fmt::base64()

Definition at line 460 of file node.hpp.

    {
        RYML_CHECK_TYPE_IS_WRAPPER_LIKE_(Wrapper);
        assert_key_();
        // use the adapter ctor to accomodate legacy read_key() implementations
        return ReadResult(read_key((ConstImpl const&)*this, wrapper), id_);
    }

template<class Impl, class ConstImpl>

template<class T >

ReadResult c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::deserialize_child ( csubstr  child_key, T *  v  ) const

inline

(1) find a child by name and deserialize its contents to the given variable (ie call .deserialize() on the child if it exists).

Otherwise, the variable is kept unchanged.

Returns

a ReadResult set with this node's id if no child exists, or the ReadResult from the deserialization.

See also

see also ConstNodeRef::find_child_r()

Definition at line 485 of file node.hpp.

Referenced by read().

    {
        this_assert_readable_();
        ConstImpl ch;
        ReadResult r = this_->find_child_r(child_key, &ch);
        if(r)
            r = ch.deserialize(v);
        return r;
    }

template<class Impl, class ConstImpl>

template<class T >

ReadResult c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::deserialize_child ( csubstr  child_key, T *  v, T const &  fallback  ) const

inline

(2) like (1), but assign from fallback if no such child exists.

Definition at line 496 of file node.hpp.

    {
        this_assert_readable_();
        ConstImpl ch;
        if(this_->find_child_r(child_key, &ch))
            return ch.deserialize(v);
        *v = fallback;
        return ReadResult();
    }

template<class Impl, class ConstImpl>

template<class Wrapper >

ReadResult c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::deserialize_child ( csubstr  child_key, Wrapper const &  v  ) const

inline

(3) like (1), but for wrapper tag types such as c4::fmt::base64()

Definition at line 507 of file node.hpp.

    {
        this_assert_readable_();
        ConstImpl ch;
        ReadResult r = this_->find_child_r(child_key, &ch);
        if(r)
            r = ch.deserialize(v);
        return r;
    }

template<class Impl, class ConstImpl>

template<class T >

ReadResult c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::deserialize_child ( id_type  child_pos, T *  v  ) const

inline

(1) find a child by position and deserialize its contents to the given variable (ie call .deserialize() on the child if it exists).

Otherwise, the variable is kept unchanged.

Returns

a ReadResult set with this node's id if no child exists, or the ReadResult from the deserialization.

See also

see also ConstNodeRef::child_r()

Definition at line 526 of file node.hpp.

    {
        this_assert_readable_();
        ConstImpl ch;
        ReadResult r = this_->child_r(child_pos, &ch);
        if(r)
            r = ch.deserialize(v);
        return r;
    }

template<class Impl, class ConstImpl>

template<class T >

ReadResult c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::deserialize_child ( id_type  child_pos, T *  v, T const &  fallback  ) const

inline

(2) like (1), but assign from fallback if no such child exists

Definition at line 537 of file node.hpp.

    {
        this_assert_readable_();
        ConstImpl ch;
        if(this_->child_r(child_pos, &ch))
            return ch.deserialize(v);
        *v = fallback;
        return ReadResult();
    }

template<class Impl, class ConstImpl>

template<class Wrapper >

ReadResult c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::deserialize_child ( id_type  child_pos, Wrapper const &  wrapper  ) const

inline

(3) like (1), but for wrapper tag types such as c4::fmt::base64()

Definition at line 549 of file node.hpp.

    {
        this_assert_readable_();
        ConstImpl ch;
        ReadResult r = this_->child_r(child_pos, &ch);
        if(r)
            r = ch.deserialize(wrapper);
        return r;
    }

template<class Impl, class ConstImpl>

template<class T >

Impl const& c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::operator>> ( T &  v ) const

inline

Definition at line 573 of file node.hpp.

{ load(&v); return (Impl const&)*this; }

template<class Impl, class ConstImpl>

template<class T >

Impl const& c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::operator>> ( T const &  wrapper ) const

inline

Definition at line 577 of file node.hpp.

{ load(wrapper); return (Impl const&)*this; }

template<class Impl, class ConstImpl>

template<class T >

Impl const& c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::operator>> ( Key< T > const &  v ) const

inline

Definition at line 581 of file node.hpp.

{ load_key(&v.k); return (Impl const&)*this; }

template<class Impl, class ConstImpl>

void c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::check_val_ ( ) const

inlineprotected

Definition at line 589 of file node.hpp.

    {
        if C4_UNLIKELY(!tree_)
            err_basic_("node not readable");
        else if C4_UNLIKELY(!(((Impl const* C4_RESTRICT)this)->readable()))
            err_visit_(tree_, id_, "node not readable");
        else if C4_UNLIKELY(!(tree_->type(id_) & (VAL|MAP|SEQ)))
            err_visit_(tree_, id_, "node has no contents");
    }

template<class Impl, class ConstImpl>

void c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::check_key_ ( ) const

inlineprotected

Definition at line 598 of file node.hpp.

    {
        if C4_UNLIKELY(!tree_)
            err_basic_("node not readable");
        else if C4_UNLIKELY(!(((Impl const* C4_RESTRICT)this)->readable()))
            err_visit_(tree_, id_, "node not readable");
        else if C4_UNLIKELY(!(tree_->type(id_) & KEY))
            err_visit_(tree_, id_, "node has no key");
    }

template<class Impl, class ConstImpl>

static void c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::err_basic_ ( const char *  msg )

inlinestaticprotected

Definition at line 609 of file node.hpp.

    {
        RYML_ERR_BASIC_(msg);
    }

template<class Impl, class ConstImpl>

static void c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::err_visit_ ( Tree const *  tree, id_type  id, const char *  msg  )

inlinestaticprotected

Definition at line 615 of file node.hpp.

    {
        RYML_ERR_VISIT_CB_(tree->m_callbacks, tree, id, msg);
    }

template<class Impl, class ConstImpl>

void c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::assert_val_ ( ) const

inlineprotectednoexcept

Definition at line 624 of file node.hpp.

{}

template<class Impl, class ConstImpl>

void c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::assert_key_ ( ) const

inlineprotectednoexcept

Definition at line 625 of file node.hpp.

{}

---

The documentation for this struct was generated from the following file:

• /tmp/B.egjz6vsx/BUILD/rapidyaml-0.16.0-build/rapidyaml-0.16.0/src/c4/yml/node.hpp