#include <node.hpp>

Public Member Functions
node property getters
NodeData const *	get () const RYML_NOEXCEPT
	returns the data or null when the id is NONE More...

template<class U = Impl>
auto	get () RYML_NOEXCEPT -> NodeData *
	returns the data or null when the id is NONE More...

NodeType	type () const RYML_NOEXCEPT
	Forward to Tree::type(). More...

const char *	type_str () const RYML_NOEXCEPT
	Forward to Tree::type_str(). 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...

bool	is_key_anchor () const noexcept

bool	is_val_hanchor () const noexcept

bool	is_anchor () const noexcept

bool	is_anchor_or_ref () const noexcept

style predicates
bool	type_has_any (NodeType_e bits) const RYML_NOEXCEPT
	Forward to Tree::type_has_any(). More...

bool	type_has_all (NodeType_e bits) const RYML_NOEXCEPT
	Forward to Tree::type_has_all(). More...

bool	type_has_none (NodeType_e 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_sl () const RYML_NOEXCEPT
	Forward to Tree::is_flow_sl(). More...

bool	is_flow_ml () const RYML_NOEXCEPT
	Forward to Tree::is_flow_ml(). More...

bool	is_flow () const RYML_NOEXCEPT
	Forward to Tree::is_flow(). 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...

bool	has_siblings () const RYML_NOEXCEPT

hierarchy getters
template<class U = Impl>
auto	doc (id_type i) RYML_NOEXCEPT -> Impl
	Forward to Tree::doc(). More...

ConstImpl	doc (id_type i) const RYML_NOEXCEPT
	Forward to Tree::doc(). More...

template<class U = Impl>
auto	parent () RYML_NOEXCEPT -> Impl
	Forward to Tree::parent(). More...

ConstImpl	parent () const RYML_NOEXCEPT
	Forward to Tree::parent(). More...

template<class U = Impl>
auto	first_child () RYML_NOEXCEPT -> Impl
	Forward to Tree::first_child(). More...

ConstImpl	first_child () const RYML_NOEXCEPT
	Forward to Tree::first_child(). More...

template<class U = Impl>
auto	last_child () RYML_NOEXCEPT -> Impl
	Forward to Tree::last_child(). More...

ConstImpl	last_child () const RYML_NOEXCEPT
	Forward to Tree::last_child(). More...

template<class U = Impl>
auto	child (id_type pos) RYML_NOEXCEPT -> Impl
	Forward to Tree::child(). More...

ConstImpl	child (id_type pos) const RYML_NOEXCEPT
	Forward to Tree::child(). More...

template<class U = Impl>
auto	find_child (csubstr name) RYML_NOEXCEPT -> Impl
	Forward to Tree::find_child(). More...

ConstImpl	find_child (csubstr name) const RYML_NOEXCEPT
	Forward to Tree::find_child(). More...

template<class U = Impl>
auto	prev_sibling () RYML_NOEXCEPT -> Impl
	Forward to Tree::prev_sibling(). More...

ConstImpl	prev_sibling () const RYML_NOEXCEPT
	Forward to Tree::prev_sibling(). More...

template<class U = Impl>
auto	next_sibling () RYML_NOEXCEPT -> Impl
	Forward to Tree::next_sibling(). More...

ConstImpl	next_sibling () const RYML_NOEXCEPT
	Forward to Tree::next_sibling(). More...

template<class U = Impl>
auto	first_sibling () RYML_NOEXCEPT -> Impl
	Forward to Tree::first_sibling(). More...

ConstImpl	first_sibling () const RYML_NOEXCEPT
	Forward to Tree::first_sibling(). More...

template<class U = Impl>
auto	last_sibling () RYML_NOEXCEPT -> Impl
	Forward to Tree::last_sibling(). More...

ConstImpl	last_sibling () const RYML_NOEXCEPT
	Forward to Tree::last_sibling(). More...

template<class U = Impl>
auto	sibling (id_type pos) RYML_NOEXCEPT -> Impl
	Forward to Tree::sibling(). More...

ConstImpl	sibling (id_type pos) const RYML_NOEXCEPT
	Forward to Tree::sibling(). More...

template<class U = Impl>
auto	find_sibling (csubstr name) RYML_NOEXCEPT -> Impl
	Forward to Tree::find_sibling(). More...

ConstImpl	find_sibling (csubstr name) const RYML_NOEXCEPT
	Forward to Tree::find_sibling(). More...

template<class U = Impl>
auto	ancestor_doc () RYML_NOEXCEPT -> Impl
	Forward to Tree::ancestor_doc(). More...

ConstImpl	ancestor_doc () const RYML_NOEXCEPT
	Forward to Tree::ancestor_doc(). More...

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...

square_brackets
O(num_nodes). Forward to Tree::depth_desc(). Node must be readable. operator[]
template<class U = Impl>
auto	operator[] (csubstr key) RYML_NOEXCEPT -> Impl
	Find child by key; complexity is O(num_children). More...

template<class U = Impl>
auto	operator[] (id_type pos) RYML_NOEXCEPT -> Impl
	Find child by position; complexity is O(pos). More...

ConstImpl	operator[] (csubstr key) const RYML_NOEXCEPT
	Find a child by key; complexity is O(num_children). More...

ConstImpl	operator[] (id_type pos) const RYML_NOEXCEPT
	Find a child by position; complexity is O(pos). More...

at
These functions are the analogue to operator[], with the difference that they emit an error instead of an assertion. That is, if any of the pre or post conditions is violated, an error is always emitted (resulting in a call to the error callback).
template<class U = Impl>
auto	at (csubstr key) -> Impl
	Find child by key; complexity is O(num_children). More...

template<class U = Impl>
auto	at (id_type pos) -> Impl
	Find child by position; complexity is O(pos). More...

ConstImpl	at (csubstr key) const
	Get a child by name, with error checking; complexity is O(num_children). More...

ConstImpl	at (id_type pos) const
	Get a child by position, with error checking; complexity is O(pos). More...

locations
Location	location (Parser const &parser) const

deserialization
template<class T >
ConstImpl const &	operator>> (T &v) const
	deserialize the node's val to the given variable, forwarding to the user-overrideable read() function. More...

template<class T >
ConstImpl const &	operator>> (Key< T > v) const
	deserialize the node's key to the given variable, forwarding to the user-overrideable read() function; use key() to disambiguate; for example: `node >> ryml::key(var)` More...

template<class T >
bool	get_if (csubstr name, T *var) const
	look for a child by name, if it exists assign to var. More...

template<class T >
bool	get_if (csubstr name, T *var, T const &fallback) const
	look for a child by name, if it exists assign to var, otherwise default to fallback. More...

deserialization_base64
ConstImpl const &	operator>> (Key< fmt::base64_wrapper > w) const
	deserialize the node's key as base64. More...

ConstImpl const &	operator>> (fmt::base64_wrapper w) const
	deserialize the node's val as base64. More...

size_t	deserialize_key (fmt::base64_wrapper v) const
	decode the base64-encoded key and assign the decoded blob to the given buffer/ More...

size_t	deserialize_val (fmt::base64_wrapper v) const
	decode the base64-encoded key and assign the decoded blob to the given buffer/ More...

iteration
using	iterator = detail::child_iterator< Impl >

using	const_iterator = detail::child_iterator< ConstImpl >

using	children_view = detail::children_view_< Impl >

using	const_children_view = detail::children_view_< ConstImpl >

template<class U = Impl>
auto	begin () RYML_NOEXCEPT -> iterator
	get a mutable iterator to the first child. More...

const_iterator	begin () const RYML_NOEXCEPT
	get an iterator to the first child More...

const_iterator	cbegin () const RYML_NOEXCEPT
	get an iterator to the first child More...

template<class U = Impl>
auto	end () RYML_NOEXCEPT -> iterator
	get an iterator to after the last child. More...

const_iterator	end () const RYML_NOEXCEPT
	get an iterator to after the last child More...

const_iterator	cend () const RYML_NOEXCEPT
	get an iterator to after the last child More...

template<class U = Impl>
auto	children () RYML_NOEXCEPT -> children_view
	get an iterable view over children. More...

const_children_view	children () const RYML_NOEXCEPT
	get an iterable view over children More...

const_children_view	cchildren () const RYML_NOEXCEPT
	get an iterable view over children More...

template<class U = Impl>
auto	siblings () RYML_NOEXCEPT -> children_view
	get an iterable view over all siblings (including the calling node) More...

const_children_view	siblings () const RYML_NOEXCEPT
	get an iterable view over all siblings (including the calling node) More...

const_children_view	csiblings () const RYML_NOEXCEPT
	get an iterable view over all siblings (including the calling node) More...

template<class Visitor >
bool	visit (Visitor fn, id_type indentation_level=0, bool skip_root=true) const RYML_NOEXCEPT
	visit every child node calling fn(node) More...

template<class Visitor , class U = Impl>
auto	visit (Visitor fn, id_type indentation_level=0, bool skip_root=true) RYML_NOEXCEPT -> bool
	visit every child node calling fn(node) More...

template<class Visitor >
bool	visit_stacked (Visitor fn, id_type indentation_level=0, bool skip_root=true) const RYML_NOEXCEPT
	visit every child node calling fn(node, level) More...

template<class Visitor , class U = Impl>
auto	visit_stacked (Visitor fn, id_type indentation_level=0, bool skip_root=true) RYML_NOEXCEPT -> bool
	visit every child node calling fn(node, level) More...

Detailed Description

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

Definition at line 176 of file node.hpp.

Member Typedef Documentation

◆ iterator

template<class Impl , class ConstImpl >

using c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::iterator = detail::child_iterator<Impl>

Definition at line 749 of file node.hpp.

◆ const_iterator

template<class Impl , class ConstImpl >

using c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::const_iterator = detail::child_iterator<ConstImpl>

Definition at line 750 of file node.hpp.

◆ children_view

template<class Impl , class ConstImpl >

using c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::children_view = detail::children_view_<Impl>

Definition at line 751 of file node.hpp.

◆ const_children_view

template<class Impl , class ConstImpl >

using c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::const_children_view = detail::children_view_<ConstImpl>

Definition at line 752 of file node.hpp.

Member Function Documentation

◆ get() [1/2]

template<class Impl , class ConstImpl >

NodeData const* c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::get ( ) const

inline

returns the data or null when the id is NONE

Definition at line 202 of file node.hpp.

202 { return ((Impl const*)this)->readable() ? tree_->get(id_) : nullptr; }

◆ get() [2/2]

template<class Impl , class ConstImpl >

template<class U = Impl>

auto c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::get ( ) -> NodeData*

inline

returns the data or null when the id is NONE

Definition at line 206 of file node.hpp.

206 { return ((Impl const*)this)->readable() ? tree__->get(id__) : nullptr; }

◆ type()

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 208 of file node.hpp.

◆ type_str()

template<class Impl , class ConstImpl >

const char* c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::type_str ( ) const

inline

Forward to Tree::type_str().

Node must be readable.

Definition at line 209 of file node.hpp.

◆ key()

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 211 of file node.hpp.

◆ key_tag()

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 212 of file node.hpp.

◆ key_ref()

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 213 of file node.hpp.

◆ key_anchor()

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 214 of file node.hpp.

◆ val()

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 216 of file node.hpp.

◆ val_tag()

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 217 of file node.hpp.

◆ val_ref()

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 218 of file node.hpp.

◆ val_anchor()

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 219 of file node.hpp.

◆ keysc()

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 221 of file node.hpp.

◆ valsc()

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 222 of file node.hpp.

◆ key_is_null()

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 224 of file node.hpp.

◆ val_is_null()

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 225 of file node.hpp.

◆ is_key_unfiltered()

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 227 of file node.hpp.

◆ is_val_unfiltered()

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 228 of file node.hpp.

◆ empty()

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 237 of file node.hpp.

◆ is_stream()

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 238 of file node.hpp.

◆ is_doc()

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 239 of file node.hpp.

◆ is_container()

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 240 of file node.hpp.

◆ is_map()

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 241 of file node.hpp.

◆ is_seq()

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 242 of file node.hpp.

◆ has_val()

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 243 of file node.hpp.

◆ has_key()

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 244 of file node.hpp.

◆ is_val()

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 245 of file node.hpp.

◆ is_keyval()

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 246 of file node.hpp.

◆ has_key_tag()

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 247 of file node.hpp.

◆ has_val_tag()

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 248 of file node.hpp.

◆ has_key_anchor()

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 249 of file node.hpp.

◆ has_val_anchor()

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 250 of file node.hpp.

◆ has_anchor()

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 251 of file node.hpp.

◆ is_key_ref()

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 252 of file node.hpp.

◆ is_val_ref()

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 253 of file node.hpp.

◆ is_ref()

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 254 of file node.hpp.

◆ parent_is_seq()

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 255 of file node.hpp.

◆ parent_is_map()

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 256 of file node.hpp.

◆ is_key_anchor()

template<class Impl , class ConstImpl >

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

inlinenoexcept

Definition at line 258 of file node.hpp.

258 { _C4RR(); return tree_->has_key_anchor(id_); }

_C4RR

#define _C4RR()

Definition: node.hpp:1023

◆ is_val_hanchor()

template<class Impl , class ConstImpl >

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

inlinenoexcept

Definition at line 259 of file node.hpp.

259 { _C4RR(); return tree_->has_val_anchor(id_); }

◆ is_anchor()

template<class Impl , class ConstImpl >

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

inlinenoexcept

Definition at line 260 of file node.hpp.

260 { _C4RR(); return tree_->has_anchor(id_); }

◆ is_anchor_or_ref()

template<class Impl , class ConstImpl >

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

inlinenoexcept

Definition at line 261 of file node.hpp.

261 { _C4RR(); return tree_->is_anchor_or_ref(id_); }

◆ type_has_any()

template<class Impl , class ConstImpl >

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

inline

Forward to Tree::type_has_any().

Node must be readable.

Definition at line 272 of file node.hpp.

◆ type_has_all()

template<class Impl , class ConstImpl >

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

inline

Forward to Tree::type_has_all().

Node must be readable.

Definition at line 273 of file node.hpp.

◆ type_has_none()

template<class Impl , class ConstImpl >

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

inline

Forward to Tree::type_has_none().

Node must be readable.

Definition at line 274 of file node.hpp.

◆ key_style()

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 276 of file node.hpp.

◆ val_style()

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 277 of file node.hpp.

◆ is_container_styled()

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 279 of file node.hpp.

◆ is_block()

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 280 of file node.hpp.

◆ is_flow_sl()

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 281 of file node.hpp.

◆ is_flow_ml()

template<class Impl , class ConstImpl >

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

inline

Forward to Tree::is_flow_ml().

Node must be readable.

Definition at line 282 of file node.hpp.

◆ is_flow()

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 283 of file node.hpp.

◆ is_key_styled()

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 285 of file node.hpp.

◆ is_val_styled()

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 286 of file node.hpp.

◆ is_key_literal()

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 287 of file node.hpp.

◆ is_val_literal()

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 288 of file node.hpp.

◆ is_key_folded()

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 289 of file node.hpp.

◆ is_val_folded()

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 290 of file node.hpp.

◆ is_key_squo()

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 291 of file node.hpp.

◆ is_val_squo()

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 292 of file node.hpp.

◆ is_key_dquo()

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 293 of file node.hpp.

◆ is_val_dquo()

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 294 of file node.hpp.

◆ is_key_plain()

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 295 of file node.hpp.

◆ is_val_plain()

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 296 of file node.hpp.

◆ is_key_quoted()

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 297 of file node.hpp.

◆ is_val_quoted()

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 298 of file node.hpp.

◆ is_quoted()

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 299 of file node.hpp.

◆ is_root()

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 310 of file node.hpp.

◆ has_parent()

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 311 of file node.hpp.

◆ is_ancestor()

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 312 of file node.hpp.

◆ has_child() [1/3]

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 314 of file node.hpp.

◆ has_child() [2/3]

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 315 of file node.hpp.

◆ has_child() [3/3]

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 316 of file node.hpp.

◆ has_children()

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 317 of file node.hpp.

◆ has_sibling() [1/3]

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 319 of file node.hpp.

◆ has_sibling() [2/3]

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 320 of file node.hpp.

◆ has_sibling() [3/3]

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 321 of file node.hpp.

◆ has_other_siblings()

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 322 of file node.hpp.

◆ has_siblings()

template<class Impl , class ConstImpl >

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

inline

Definition at line 324 of file node.hpp.

324 { _C4RR(); return tree_->has_siblings(id_); }

◆ doc() [1/2]

template<class Impl , class ConstImpl >

template<class U = Impl>

auto c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::doc ( id_type i ) -> Impl

inline

Forward to Tree::doc().

Node must be readable.

Definition at line 336 of file node.hpp.

◆ doc() [2/2]

template<class Impl , class ConstImpl >

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

inline

Forward to Tree::doc().

Node must be readable. succeeds even when the node may have invalid or seed id

Definition at line 337 of file node.hpp.

◆ parent() [1/2]

template<class Impl , class ConstImpl >

template<class U = Impl>

auto c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::parent ( ) -> Impl

inline

Forward to Tree::parent().

Node must be readable.

Definition at line 340 of file node.hpp.

◆ parent() [2/2]

template<class Impl , class ConstImpl >

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

inline

Forward to Tree::parent().

Node must be readable.

Definition at line 341 of file node.hpp.

◆ first_child() [1/2]

template<class Impl , class ConstImpl >

template<class U = Impl>

auto c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::first_child ( ) -> Impl

inline

Forward to Tree::first_child().

Node must be readable.

Definition at line 344 of file node.hpp.

◆ first_child() [2/2]

template<class Impl , class ConstImpl >

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

inline

Forward to Tree::first_child().

Node must be readable.

Definition at line 345 of file node.hpp.

◆ last_child() [1/2]

template<class Impl , class ConstImpl >

template<class U = Impl>

auto c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::last_child ( ) -> Impl

inline

Forward to Tree::last_child().

Node must be readable.

Definition at line 348 of file node.hpp.

◆ last_child() [2/2]

template<class Impl , class ConstImpl >

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

inline

Forward to Tree::last_child().

Node must be readable.

Definition at line 349 of file node.hpp.

◆ child() [1/2]

template<class Impl , class ConstImpl >

template<class U = Impl>

auto c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::child ( id_type pos ) -> Impl

inline

Forward to Tree::child().

Node must be readable.

Definition at line 352 of file node.hpp.

◆ child() [2/2]

template<class Impl , class ConstImpl >

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

inline

Forward to Tree::child().

Node must be readable.

Definition at line 353 of file node.hpp.

◆ find_child() [1/2]

template<class Impl , class ConstImpl >

template<class U = Impl>

auto c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::find_child ( csubstr name ) -> Impl

inline

Forward to Tree::find_child().

Node must be readable.

Definition at line 356 of file node.hpp.

◆ find_child() [2/2]

template<class Impl , class ConstImpl >

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

inline

Forward to Tree::find_child().

Node must be readable.

Definition at line 357 of file node.hpp.

◆ prev_sibling() [1/2]

template<class Impl , class ConstImpl >

template<class U = Impl>

auto c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::prev_sibling ( ) -> Impl

inline

Forward to Tree::prev_sibling().

Node must be readable.

Definition at line 360 of file node.hpp.

◆ prev_sibling() [2/2]

template<class Impl , class ConstImpl >

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

inline

Forward to Tree::prev_sibling().

Node must be readable.

Definition at line 361 of file node.hpp.

◆ next_sibling() [1/2]

template<class Impl , class ConstImpl >

template<class U = Impl>

auto c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::next_sibling ( ) -> Impl

inline

Forward to Tree::next_sibling().

Node must be readable.

Definition at line 364 of file node.hpp.

◆ next_sibling() [2/2]

template<class Impl , class ConstImpl >

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

inline

Forward to Tree::next_sibling().

Node must be readable.

Definition at line 365 of file node.hpp.

◆ first_sibling() [1/2]

template<class Impl , class ConstImpl >

template<class U = Impl>

auto c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::first_sibling ( ) -> Impl

inline

Forward to Tree::first_sibling().

Node must be readable.

Definition at line 368 of file node.hpp.

◆ first_sibling() [2/2]

template<class Impl , class ConstImpl >

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

inline

Forward to Tree::first_sibling().

Node must be readable.

Definition at line 369 of file node.hpp.

◆ last_sibling() [1/2]

template<class Impl , class ConstImpl >

template<class U = Impl>

auto c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::last_sibling ( ) -> Impl

inline

Forward to Tree::last_sibling().

Node must be readable.

Definition at line 372 of file node.hpp.

◆ last_sibling() [2/2]

template<class Impl , class ConstImpl >

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

inline

Forward to Tree::last_sibling().

Node must be readable.

Definition at line 373 of file node.hpp.

◆ sibling() [1/2]

template<class Impl , class ConstImpl >

template<class U = Impl>

auto c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::sibling ( id_type pos ) -> Impl

inline

Forward to Tree::sibling().

Node must be readable.

Definition at line 376 of file node.hpp.

◆ sibling() [2/2]

template<class Impl , class ConstImpl >

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

inline

Forward to Tree::sibling().

Node must be readable.

Definition at line 377 of file node.hpp.

◆ find_sibling() [1/2]

template<class Impl , class ConstImpl >

template<class U = Impl>

auto c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::find_sibling ( csubstr name ) -> Impl

inline

Forward to Tree::find_sibling().

Node must be readable.

Definition at line 380 of file node.hpp.

◆ find_sibling() [2/2]

template<class Impl , class ConstImpl >

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

inline

Forward to Tree::find_sibling().

Node must be readable.

Definition at line 381 of file node.hpp.

◆ ancestor_doc() [1/2]

template<class Impl , class ConstImpl >

template<class U = Impl>

auto c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::ancestor_doc ( ) -> Impl

inline

Forward to Tree::ancestor_doc().

Node must be readable.

Definition at line 384 of file node.hpp.

◆ ancestor_doc() [2/2]

template<class Impl , class ConstImpl >

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

inline

Forward to Tree::ancestor_doc().

Node must be readable.

Definition at line 385 of file node.hpp.

◆ num_children()

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 387 of file node.hpp.

◆ num_siblings()

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 388 of file node.hpp.

◆ num_other_siblings()

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 389 of file node.hpp.

◆ child_pos()

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 390 of file node.hpp.

◆ sibling_pos()

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 391 of file node.hpp.

◆ depth_asc()

template<class Impl , class ConstImpl >

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

inline

Definition at line 393 of file node.hpp.

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

◆ depth_desc()

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 394 of file node.hpp.

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

◆ operator[]() [1/4]

template<class Impl , class ConstImpl >

template<class U = Impl>

auto c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::operator[] ( csubstr key ) -> Impl

inline

Find child by key; complexity is O(num_children).

Returns the requested node, or an object in seed state if no such child is found (see NodeRef for an explanation of what is seed state). When the object is in seed state, using it to read from the tree is UB. The seed node can be used to write to the tree provided that its create() method is called prior to writing, which happens in most modifying methods in NodeRef. It is the caller's responsibility to verify that the returned node is readable before subsequently using it to read from the tree.

Warning: the calling object must be readable. This precondition is asserted. The assertion is performed only if RYML_USE_ASSERT is set to true. As with the non-const overload, it is UB to call this method if the node is not readable.

See also: https://github.com/biojppm/rapidyaml/issues/389

Definition at line 423 of file node.hpp.

     {
         _C4RR();
         id_type ch = tree__->find_child(id__, key);
         return ch != NONE ? Impl(tree__, ch) : Impl(tree__, id__, key);
     }

◆ operator[]() [2/4]

template<class Impl , class ConstImpl >

template<class U = Impl>

auto c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::operator[] ( id_type pos ) -> Impl

inline

Find child by position; complexity is O(pos).

Returns the requested node, or an object in seed state if no such child is found (see NodeRef for an explanation of what is seed state). When the object is in seed state, using it to read from the tree is UB. The seed node can be used to write to the tree provided that its create() method is called prior to writing, which happens in most modifying methods in NodeRef. It is the caller's responsibility to verify that the returned node is readable before subsequently using it to read from the tree.

Warning: the calling object must be readable. This precondition is asserted. The assertion is performed only if RYML_USE_ASSERT is set to true. As with the non-const overload, it is UB to call this method if the node is not readable.

See also: https://github.com/biojppm/rapidyaml/issues/389

Definition at line 449 of file node.hpp.

     {
         _C4RR();
         id_type ch = tree__->child(id__, pos);
         return ch != NONE ? Impl(tree__, ch) : Impl(tree__, id__, pos);
     }

◆ operator[]() [3/4]

template<class Impl , class ConstImpl >

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

inline

Find a child by key; complexity is O(num_children).

Behaves similar to the non-const overload, but further asserts that the returned node is readable (because it can never be in a seed state). The assertion is performed only if RYML_USE_ASSERT is set to true. As with the non-const overload, it is UB to use the return value if it is not valid.

See also: https://github.com/biojppm/rapidyaml/issues/389

Definition at line 465 of file node.hpp.

     {
         _C4RR();
         id_type ch = tree_->find_child(id_, key);
         _RYML_ASSERT_VISIT_(tree_->m_callbacks, ch != NONE, tree_, id_);
         return {tree_, ch};
     }

◆ operator[]() [4/4]

template<class Impl , class ConstImpl >

ConstImpl c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::operator[] ( id_type pos ) const

inline

Find a child by position; complexity is O(pos).

Behaves similar to the non-const overload, but further asserts that the returned node is readable (because it can never be in a seed state). This assertion is performed only if RYML_USE_ASSERT is set to true. As with the non-const overload, it is UB to use the return value if it is not valid.

See also: https://github.com/biojppm/rapidyaml/issues/389

Definition at line 482 of file node.hpp.

     {
         _C4RR();
         id_type ch = tree_->child(id_, pos);
         _RYML_ASSERT_VISIT_(tree_->m_callbacks, ch != NONE, tree_, id_);
         return {tree_, ch};
     }

◆ at() [1/4]

template<class Impl , class ConstImpl >

template<class U = Impl>

auto c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::at ( csubstr key ) -> Impl

inline

Find child by key; complexity is O(num_children).

Returns the requested node, or an object in seed state if no such child is found (see NodeRef for an explanation of what is seed state). When the object is in seed state, using it to read from the tree is UB. The seed node can be subsequently used to write to the tree provided that its create() method is called prior to writing, which happens inside most mutating methods in NodeRef. It is the caller's responsibility to verify that the returned node is readable before subsequently using it to read from the tree.

Warning: This method will call the error callback (regardless of build type or of the value of RYML_USE_ASSERT) whenever any of the following preconditions is violated: a) the object is valid (points at a tree and a node), b) the calling object must be readable (must not be in seed state), c) the calling object must be pointing at a MAP node. The preconditions are similar to the non-const operator[](csubstr), but instead of using assertions, this function directly checks those conditions and calls the error callback if any of the checks fail.

Note: since it is valid behavior for the returned node to be in seed state, the error callback is not invoked when this happens.

Definition at line 530 of file node.hpp.

     {
         _RYML_CHECK_BASIC(tree_ != nullptr);
         _RYML_CHECK_VISIT_(tree_->m_callbacks, (id_ >= 0 && id_ < tree_->capacity()), tree_, id_);
         _RYML_CHECK_VISIT_(tree_->m_callbacks, ((Impl const*)this)->readable(), tree_, id_);
         _RYML_CHECK_VISIT_(tree_->m_callbacks, tree_->is_map(id_), tree_, id_);
         id_type ch = tree__->find_child(id__, key);
         return ch != NONE ? Impl(tree__, ch) : Impl(tree__, id__, key);
     }

◆ at() [2/4]

template<class Impl , class ConstImpl >

template<class U = Impl>

auto c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::at ( id_type pos ) -> Impl

inline

Find child by position; complexity is O(pos).

Returns the requested node, or an object in seed state if no such child is found (see NodeRef for an explanation of what is seed state). When the object is in seed state, using it to read from the tree is UB. The seed node can be used to write to the tree provided that its create() method is called prior to writing, which happens in most modifying methods in NodeRef. It is the caller's responsibility to verify that the returned node is readable before subsequently using it to read from the tree.

Warning: This method will call the error callback (regardless of build type or of the value of RYML_USE_ASSERT) whenever any of the following preconditions is violated: a) the object is valid (points at a tree and a node), b) the calling object must be readable (must not be in seed state), c) the calling object must be pointing at a MAP node. The preconditions are similar to the non-const operator[](id_type), but instead of using assertions, this function directly checks those conditions and calls the error callback if any of the checks fail.

Note: since it is valid behavior for the returned node to be in seed state, the error callback is not invoked when this happens.

Definition at line 566 of file node.hpp.

     {
         _RYML_CHECK_BASIC(tree_ != nullptr);
         const id_type cap = tree_->capacity();
         _RYML_CHECK_VISIT_(tree_->m_callbacks, (id_ >= 0 && id_ < cap), tree_, id_);
         _RYML_CHECK_VISIT_(tree_->m_callbacks, (pos >= 0 && pos < cap), tree_, id_);
         _RYML_CHECK_VISIT_(tree_->m_callbacks, ((Impl const*)this)->readable(), tree_, id_);
         _RYML_CHECK_VISIT_(tree_->m_callbacks, tree_->is_container(id_), tree_, id_);
         id_type ch = tree__->child(id__, pos);
         return ch != NONE ? Impl(tree__, ch) : Impl(tree__, id__, pos);
     }

◆ at() [3/4]

template<class Impl , class ConstImpl >

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

inline

Get a child by name, with error checking; complexity is O(num_children).

Behaves as operator[](csubstr) const, but always raises an error (even when RYML_USE_ASSERT is set to false) when the returned node does not exist, or when this node is not readable, or when it is not a map. This behaviour is similar to std::vector::at(), but the error consists in calling the error callback instead of directly raising an exception.

Definition at line 587 of file node.hpp.

     {
         _RYML_CHECK_BASIC(tree_ != nullptr);
         _RYML_CHECK_VISIT_(tree_->m_callbacks, (id_ >= 0 && id_ < tree_->capacity()), tree_, id_);
         _RYML_CHECK_VISIT_(tree_->m_callbacks, ((Impl const*)this)->readable(), tree_, id_);
         _RYML_CHECK_VISIT_(tree_->m_callbacks, tree_->is_map(id_), tree_, id_);
         id_type ch = tree_->find_child(id_, key);
         _RYML_CHECK_VISIT_(tree_->m_callbacks, ch != NONE, tree_, id_);
         return {tree_, ch};
     }

◆ at() [4/4]

template<class Impl , class ConstImpl >

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

inline

Get a child by position, with error checking; complexity is O(pos).

Behaves as operator[](id_type) const, but always raises an error (even when RYML_USE_ASSERT is set to false) when the returned node does not exist, or when this node is not readable, or when it is not a container. This behaviour is similar to std::vector::at(), but the error consists in calling the error callback instead of directly raising an exception.

Definition at line 607 of file node.hpp.

     {
         _RYML_CHECK_BASIC(tree_ != nullptr);
         const id_type cap = tree_->capacity();
         _RYML_CHECK_VISIT_(tree_->m_callbacks, (id_ >= 0 && id_ < cap), tree_, id_);
         _RYML_CHECK_VISIT_(tree_->m_callbacks, (pos >= 0 && pos < cap), tree_, id_);
         _RYML_CHECK_VISIT_(tree_->m_callbacks, ((Impl const*)this)->readable(), tree_, id_);
         _RYML_CHECK_VISIT_(tree_->m_callbacks, tree_->is_container(id_), tree_, id_);
         const id_type ch = tree_->child(id_, pos);
         _RYML_CHECK_VISIT_(tree_->m_callbacks, ch != NONE, tree_, id_);
         return {tree_, ch};
     }

◆ location()

template<class Impl , class ConstImpl >

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

inline

Definition at line 627 of file node.hpp.

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

◆ operator>>() [1/4]

template<class Impl , class ConstImpl >

template<class T >

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

inline

deserialize the node's val to the given variable, forwarding to the user-overrideable read() function.

Definition at line 643 of file node.hpp.

     {
         _C4RR();
         if( ! read((ConstImpl const&)*this, &v))
             _RYML_ERR_VISIT_(tree_->m_callbacks, tree_, id_, "could not deserialize value");
         return *((ConstImpl const*)this);
     }

◆ operator>>() [2/4]

template<class Impl , class ConstImpl >

template<class T >

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

inline

deserialize the node's key to the given variable, forwarding to the user-overrideable read() function; use key() to disambiguate; for example: node >> ryml::key(var)

Definition at line 655 of file node.hpp.

     {
         _C4RR();
         if( ! readkey((ConstImpl const&)*this, &v.k))
             _RYML_ERR_VISIT_(tree_->m_callbacks, tree_, id_, "could not deserialize key");
         return *((ConstImpl const*)this);
     }

◆ get_if() [1/2]

template<class Impl , class ConstImpl >

template<class T >

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::get_if	(	csubstr	name,
		T *	var
	)		const

inline

look for a child by name, if it exists assign to var.

return true if the child existed.

Definition at line 666 of file node.hpp.

     {
         _C4RR();
         ConstImpl ch = find_child(name);
         if(!ch.readable())
             return false;
         ch >> *var;
         return true;
     }

◆ get_if() [2/2]

template<class Impl , class ConstImpl >

template<class T >

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::get_if	(	csubstr	name,
		T *	var,
		T const &	fallback
	)		const

inline

look for a child by name, if it exists assign to var, otherwise default to fallback.

return true if the child existed.

Definition at line 680 of file node.hpp.

     {
         _C4RR();
         ConstImpl ch = find_child(name);
         if(ch.readable())
         {
             ch >> *var;
             return true;
         }
         else
         {
             *var = fallback;
             return false;
         }
     }

◆ operator>>() [3/4]

template<class Impl , class ConstImpl >

ConstImpl const& c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::operator>> ( Key< fmt::base64_wrapper > w ) const

inline

deserialize the node's key as base64.

lightweight wrapper over deserialize_key()

Definition at line 700 of file node.hpp.

     {
         deserialize_key(w.wrapper);
         return *((ConstImpl const*)this);
     }

◆ operator>>() [4/4]

template<class Impl , class ConstImpl >

ConstImpl const& c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::operator>> ( fmt::base64_wrapper w ) const

inline

deserialize the node's val as base64.

lightweight wrapper over deserialize_val()

Definition at line 707 of file node.hpp.

     {
         deserialize_val(w);
         return *((ConstImpl const*)this);
     }

◆ deserialize_key()

template<class Impl , class ConstImpl >

size_t c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::deserialize_key ( fmt::base64_wrapper v ) const

inline

decode the base64-encoded key and assign the decoded blob to the given buffer/

Returns: the size of base64-decoded blob

Definition at line 716 of file node.hpp.

     {
         _C4RR();
         return from_chars(key(), &v);
     }

◆ deserialize_val()

template<class Impl , class ConstImpl >

size_t c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::deserialize_val ( fmt::base64_wrapper v ) const

inline

decode the base64-encoded key and assign the decoded blob to the given buffer/

Returns: the size of base64-decoded blob

Definition at line 724 of file node.hpp.

     {
         _C4RR();
         return from_chars(val(), &v);
     };

◆ begin() [1/2]

template<class Impl , class ConstImpl >

template<class U = Impl>

auto c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::begin ( ) -> iterator

inline

get a mutable iterator to the first child.

NOT AVAILABLE for ConstNodeRef.

Definition at line 755 of file node.hpp.

◆ begin() [2/2]

template<class Impl , class ConstImpl >

const_iterator c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::begin ( ) const

inline

get an iterator to the first child

Definition at line 756 of file node.hpp.

◆ cbegin()

template<class Impl , class ConstImpl >

const_iterator c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::cbegin ( ) const

inline

get an iterator to the first child

Definition at line 757 of file node.hpp.

◆ end() [1/2]

template<class Impl , class ConstImpl >

template<class U = Impl>

auto c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::end ( ) -> iterator

inline

get an iterator to after the last child.

NOT AVAILABLE for ConstNodeRef.

Definition at line 760 of file node.hpp.

◆ end() [2/2]

template<class Impl , class ConstImpl >

const_iterator c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::end ( ) const

inline

get an iterator to after the last child

Definition at line 762 of file node.hpp.

◆ cend()

template<class Impl , class ConstImpl >

const_iterator c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::cend ( ) const

inline

get an iterator to after the last child

Definition at line 764 of file node.hpp.

◆ children() [1/2]

template<class Impl , class ConstImpl >

template<class U = Impl>

auto c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::children ( ) -> children_view

inline

get an iterable view over children.

NOT AVAILABLE for ConstNodeRef.

Definition at line 767 of file node.hpp.

◆ children() [2/2]

template<class Impl , class ConstImpl >

const_children_view c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::children ( ) const

inline

get an iterable view over children

Definition at line 768 of file node.hpp.

◆ cchildren()

template<class Impl , class ConstImpl >

const_children_view c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::cchildren ( ) const

inline

get an iterable view over children

Definition at line 769 of file node.hpp.

◆ siblings() [1/2]

template<class Impl , class ConstImpl >

template<class U = Impl>

auto c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::siblings ( ) -> children_view

inline

get an iterable view over all siblings (including the calling node)

Definition at line 773 of file node.hpp.

     {
         _C4RR();
         NodeData const *nd = tree__->get(id__);
         return (nd->m_parent != NONE) ? // does it have a parent?
             children_view(iterator(tree__, tree_->get(nd->m_parent)->m_first_child), iterator(tree__, NONE))
             :
             children_view(end(), end());
     }

◆ siblings() [2/2]

template<class Impl , class ConstImpl >

const_children_view c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::siblings ( ) const

inline

get an iterable view over all siblings (including the calling node)

Definition at line 783 of file node.hpp.

     {
         _C4RR();
         NodeData const *nd = tree_->get(id_);
         return (nd->m_parent != NONE) ? // does it have a parent?
             const_children_view(const_iterator(tree_, tree_->get(nd->m_parent)->m_first_child), const_iterator(tree_, NONE))
             :
             const_children_view(end(), end());
     }

◆ csiblings()

template<class Impl , class ConstImpl >

const_children_view c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::csiblings ( ) const

inline

get an iterable view over all siblings (including the calling node)

Definition at line 793 of file node.hpp.

793 { return siblings(); }

c4::yml::detail::RoNodeMethods::siblings

auto siblings() RYML_NOEXCEPT -> children_view

get an iterable view over all siblings (including the calling node)

Definition: node.hpp:773

◆ visit() [1/2]

template<class Impl , class ConstImpl >

template<class Visitor >

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::visit	(	Visitor	fn,
		id_type	indentation_level = `0`,
		bool	skip_root = `true`
	)		const

inline

visit every child node calling fn(node)

Definition at line 797 of file node.hpp.

     {
         _C4RR();
         return detail::_visit(*(ConstImpl const*)this, fn, indentation_level, skip_root);
     }

◆ visit() [2/2]

template<class Impl , class ConstImpl >

template<class Visitor , class U = Impl>

auto c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::visit	(	Visitor	fn,
		id_type	indentation_level = `0`,
		bool	skip_root = `true`
	)		-> bool

inline

visit every child node calling fn(node)

Definition at line 804 of file node.hpp.

     {
         _C4RR();
         return detail::_visit(*(Impl*)this, fn, indentation_level, skip_root);
     }

◆ visit_stacked() [1/2]

template<class Impl , class ConstImpl >

template<class Visitor >

bool c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::visit_stacked	(	Visitor	fn,
		id_type	indentation_level = `0`,
		bool	skip_root = `true`
	)		const

inline

visit every child node calling fn(node, level)

Definition at line 813 of file node.hpp.

     {
         _C4RR();
         return detail::_visit_stacked(*(ConstImpl const*)this, fn, indentation_level, skip_root);
     }

◆ visit_stacked() [2/2]

template<class Impl , class ConstImpl >

template<class Visitor , class U = Impl>

auto c4::yml::detail::RoNodeMethods< Impl, ConstImpl >::visit_stacked	(	Visitor	fn,
		id_type	indentation_level = `0`,
		bool	skip_root = `true`
	)		-> bool

inline

visit every child node calling fn(node, level)

Definition at line 820 of file node.hpp.

     {
         _C4RR();
         return detail::_visit_stacked(*(Impl*)this, fn, indentation_level, skip_root);
     }

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

/home/docs/checkouts/readthedocs.org/user_builds/rapidyaml/checkouts/v0.13.0/src/c4/yml/node.hpp

Public Member Functions

iteration

Detailed Description

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

Member Typedef Documentation

◆ iterator

◆ const_iterator

◆ children_view

◆ const_children_view

Member Function Documentation

◆ get() [1/2]

◆ get() [2/2]

◆ type()

◆ type_str()

◆ key()

◆ key_tag()

◆ key_ref()

◆ key_anchor()

◆ val()

◆ val_tag()

◆ val_ref()

◆ val_anchor()

◆ keysc()

◆ valsc()

◆ key_is_null()

◆ val_is_null()

◆ is_key_unfiltered()

◆ is_val_unfiltered()

◆ empty()

◆ is_stream()

◆ is_doc()

◆ is_container()

◆ is_map()

◆ is_seq()

◆ has_val()

◆ has_key()

◆ is_val()

◆ is_keyval()

◆ has_key_tag()

◆ has_val_tag()

◆ has_key_anchor()

◆ has_val_anchor()

◆ has_anchor()

◆ is_key_ref()

◆ is_val_ref()

◆ is_ref()

◆ parent_is_seq()

◆ parent_is_map()

◆ is_key_anchor()

◆ is_val_hanchor()

◆ is_anchor()

◆ is_anchor_or_ref()

◆ type_has_any()

◆ type_has_all()

◆ type_has_none()

◆ key_style()

◆ val_style()

◆ is_container_styled()

◆ is_block()

◆ is_flow_sl()

◆ is_flow_ml()

◆ is_flow()

◆ is_key_styled()

◆ is_val_styled()

◆ is_key_literal()

◆ is_val_literal()

◆ is_key_folded()

◆ is_val_folded()

◆ is_key_squo()

◆ is_val_squo()

◆ is_key_dquo()

◆ is_val_dquo()

◆ is_key_plain()

◆ is_val_plain()

◆ is_key_quoted()

◆ is_val_quoted()

◆ is_quoted()

◆ is_root()

◆ has_parent()

◆ is_ancestor()

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