Holds a pointer to an existing tree, and a node id. More...

#include <node.hpp>

Public Types
using	tree_type = Tree const

Public Member Functions
construction
	ConstNodeRef () noexcept
	ConstNodeRef (Tree const &t) noexcept
	ConstNodeRef (Tree const *t) noexcept
	ConstNodeRef (Tree const *t, id_type id) noexcept
	ConstNodeRef (ConstNodeRef const &) noexcept=default
	ConstNodeRef (ConstNodeRef &&) noexcept=default
	ConstNodeRef (NodeRef const &) noexcept
	ConstNodeRef (NodeRef &&) noexcept
assignment
ConstNodeRef &	operator= (ConstNodeRef const &) noexcept=default
ConstNodeRef &	operator= (ConstNodeRef &&) noexcept=default
ConstNodeRef &	operator= (NodeRef const &) noexcept
ConstNodeRef &	operator= (NodeRef &&) noexcept
member getters
Tree const *	tree () const noexcept
id_type	id () const noexcept
comparisons
bool	operator== (ConstNodeRef const &that) const RYML_NOEXCEPT
bool	operator!= (ConstNodeRef const &that) const RYML_NOEXCEPT
node property getters
NodeData const *	get () const RYML_NOEXCEPT
	Forward to Tree::type().
hierarchy getters
ConstNodeRef	parent () const RYML_NOEXCEPT
	Forward to Tree::parent().
ConstNodeRef	first_child () const RYML_NOEXCEPT
	Forward to Tree::first_child().
ConstNodeRef	last_child () const RYML_NOEXCEPT
	Forward to Tree::last_child().
ConstNodeRef	child (id_type pos) const RYML_NOEXCEPT
	Forward to Tree::child().
ConstNodeRef	find_child (csubstr name) const RYML_NOEXCEPT
	Forward to Tree::find_child().
ConstNodeRef	prev_sibling () const RYML_NOEXCEPT
	Forward to Tree::prev_sibling().
ConstNodeRef	next_sibling () const RYML_NOEXCEPT
	Forward to Tree::next_sibling().
ConstNodeRef	first_sibling () const RYML_NOEXCEPT
	Forward to Tree::first_sibling().
ConstNodeRef	last_sibling () const RYML_NOEXCEPT
	Forward to Tree::last_sibling().
ConstNodeRef	sibling (id_type pos) const RYML_NOEXCEPT
	Forward to Tree::sibling().
ConstNodeRef	find_sibling (csubstr name) const RYML_NOEXCEPT
	Forward to Tree::find_sibling().
ConstNodeRef	ancestor_doc () const RYML_NOEXCEPT
	Forward to Tree::ancestor_doc().
ConstNodeRef	doc (id_type i) const RYML_NOEXCEPT
	Forward to Tree::doc().
ReadResult	child_r (id_type pos, ConstNodeRef *child) const RYML_NOEXCEPT
ReadResult	find_child_r (csubstr name, ConstNodeRef *child) const RYML_NOEXCEPT
	Forward to Tree::child_r().
ReadResult	sibling_r (id_type pos, ConstNodeRef *sibling) const RYML_NOEXCEPT
	Forward to Tree::find_child_r().
ReadResult	find_sibling_r (csubstr name, ConstNodeRef *sibling) const RYML_NOEXCEPT
	Forward to Tree::sibling_r().
square_brackets
Forward to Tree::find_sibling_r(). Node must be readable. operator[]
ConstNodeRef	operator[] (csubstr key) const RYML_NOEXCEPT
	Find a child by key; complexity is O(num_children).
ConstNodeRef	operator[] (id_type pos) const RYML_NOEXCEPT
	Find a child by position; complexity is O(pos).
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).
ConstNodeRef	at (csubstr key) const
	Get a child by name, with error checking; complexity is O(num_children).
ConstNodeRef	at (id_type pos) const
	Get a child by position, with error checking; complexity is O(pos).
node property getters
NodeType	type () const RYML_NOEXCEPT
	Forward to Tree::type().
csubstr	key () const RYML_NOEXCEPT
	Forward to Tree::key().
csubstr	key_tag () const RYML_NOEXCEPT
	Forward to Tree::key_tag().
csubstr	key_ref () const RYML_NOEXCEPT
	Forward to Tree::key_ref().
csubstr	key_anchor () const RYML_NOEXCEPT
	Forward to Tree::key_anchor().
csubstr	val () const RYML_NOEXCEPT
	Forward to Tree::val().
csubstr	val_tag () const RYML_NOEXCEPT
	Forward to Tree::val_tag().
csubstr	val_ref () const RYML_NOEXCEPT
	Forward to Tree::val_ref().
csubstr	val_anchor () const RYML_NOEXCEPT
	Forward to Tree::val_anchor().
NodeScalar const &	keysc () const RYML_NOEXCEPT
	Forward to Tree::keysc().
NodeScalar const &	valsc () const RYML_NOEXCEPT
	Forward to Tree::valsc().
bool	key_is_null () const RYML_NOEXCEPT
	Forward to Tree::key_is_null().
bool	val_is_null () const RYML_NOEXCEPT
	Forward to Tree::val_is_null().
bool	is_key_unfiltered () const noexcept
	Forward to Tree::is_key_unfiltered().
bool	is_val_unfiltered () const noexcept
	Forward to Tree::is_val_unfiltered().
node type predicates
bool	empty () const RYML_NOEXCEPT
	Forward to Tree::empty().
bool	is_stream () const RYML_NOEXCEPT
	Forward to Tree::is_stream().
bool	is_doc () const RYML_NOEXCEPT
	Forward to Tree::is_doc().
bool	is_container () const RYML_NOEXCEPT
	Forward to Tree::is_container().
bool	is_map () const RYML_NOEXCEPT
	Forward to Tree::is_map().
bool	is_seq () const RYML_NOEXCEPT
	Forward to Tree::is_seq().
bool	has_val () const RYML_NOEXCEPT
	Forward to Tree::has_val().
bool	has_key () const RYML_NOEXCEPT
	Forward to Tree::has_key().
bool	is_val () const RYML_NOEXCEPT
	Forward to Tree::is_val().
bool	is_keyval () const RYML_NOEXCEPT
	Forward to Tree::is_keyval().
bool	has_key_tag () const RYML_NOEXCEPT
	Forward to Tree::has_key_tag().
bool	has_val_tag () const RYML_NOEXCEPT
	Forward to Tree::has_val_tag().
bool	has_key_anchor () const RYML_NOEXCEPT
	Forward to Tree::has_key_anchor().
bool	has_val_anchor () const RYML_NOEXCEPT
	Forward to Tree::has_val_anchor().
bool	has_anchor () const RYML_NOEXCEPT
	Forward to Tree::has_anchor().
bool	is_key_ref () const RYML_NOEXCEPT
	Forward to Tree::is_key_ref().
bool	is_val_ref () const RYML_NOEXCEPT
	Forward to Tree::is_val_ref().
bool	is_ref () const RYML_NOEXCEPT
	Forward to Tree::is_ref().
bool	parent_is_seq () const RYML_NOEXCEPT
	Forward to Tree::parent_is_seq().
bool	parent_is_map () const RYML_NOEXCEPT
	Forward to Tree::parent_is_map().
style predicates
bool	type_has_any (type_bits bits) const RYML_NOEXCEPT
	Forward to Tree::type_has_any().
bool	type_has_all (type_bits bits) const RYML_NOEXCEPT
	Forward to Tree::type_has_all().
bool	type_has_none (type_bits bits) const RYML_NOEXCEPT
	Forward to Tree::type_has_none().
NodeType	key_style () const RYML_NOEXCEPT
	Forward to Tree::key_style().
NodeType	val_style () const RYML_NOEXCEPT
	Forward to Tree::val_style().
bool	is_container_styled () const RYML_NOEXCEPT
	Forward to Tree::is_container_styled().
bool	is_block () const RYML_NOEXCEPT
	Forward to Tree::is_block().
bool	is_flow () const RYML_NOEXCEPT
	Forward to Tree::is_flow().
bool	is_flow_sl () const RYML_NOEXCEPT
	Forward to Tree::is_flow_sl().
bool	is_flow_ml () const RYML_NOEXCEPT
	Forward to Tree::is_flow_ml1().
bool	is_flow_ml1 () const RYML_NOEXCEPT
	Forward to Tree::is_flow_ml1().
bool	is_flow_mln () const RYML_NOEXCEPT
	Forward to Tree::is_flow_mln().
bool	is_flow_mlx () const RYML_NOEXCEPT
	Forward to Tree::is_flow_mlx().
bool	has_flow_space () const RYML_NOEXCEPT
	Forward to Tree::has_flow_space().
bool	is_key_styled () const RYML_NOEXCEPT
	Forward to Tree::is_key_styled().
bool	is_val_styled () const RYML_NOEXCEPT
	Forward to Tree::is_val_styled().
bool	is_key_literal () const RYML_NOEXCEPT
	Forward to Tree::is_key_literal().
bool	is_val_literal () const RYML_NOEXCEPT
	Forward to Tree::is_val_literal().
bool	is_key_folded () const RYML_NOEXCEPT
	Forward to Tree::is_key_folded().
bool	is_val_folded () const RYML_NOEXCEPT
	Forward to Tree::is_val_folded().
bool	is_key_squo () const RYML_NOEXCEPT
	Forward to Tree::is_key_squo().
bool	is_val_squo () const RYML_NOEXCEPT
	Forward to Tree::is_val_squo().
bool	is_key_dquo () const RYML_NOEXCEPT
	Forward to Tree::is_key_dquo().
bool	is_val_dquo () const RYML_NOEXCEPT
	Forward to Tree::is_val_dquo().
bool	is_key_plain () const RYML_NOEXCEPT
	Forward to Tree::is_key_plain().
bool	is_val_plain () const RYML_NOEXCEPT
	Forward to Tree::is_val_plain().
bool	is_key_quoted () const RYML_NOEXCEPT
	Forward to Tree::is_key_quoted().
bool	is_val_quoted () const RYML_NOEXCEPT
	Forward to Tree::is_val_quoted().
bool	is_quoted () const RYML_NOEXCEPT
	Forward to Tree::is_quoted().
hierarchy predicates
bool	is_root () const RYML_NOEXCEPT
	Forward to Tree::is_root().
bool	has_parent () const RYML_NOEXCEPT
	Forward to Tree::has_parent() Node must be readable.
bool	is_ancestor (ConstNodeRef const &ancestor) const RYML_NOEXCEPT
	Forward to Tree::is_ancestor() Node must be readable.
bool	has_child (ConstNodeRef const &n) const RYML_NOEXCEPT
	Forward to Tree::has_child().
bool	has_children () const RYML_NOEXCEPT
	Forward to Tree::has_children().
bool	has_sibling (ConstNodeRef const &n) const RYML_NOEXCEPT
	Forward to Tree::has_sibling().
bool	has_other_siblings () const RYML_NOEXCEPT
	Forward to Tree::has_other_siblings().
hierarchy getters
id_type	num_children () const RYML_NOEXCEPT
	O(num_children).
id_type	num_siblings () const RYML_NOEXCEPT
	O(num_children).
id_type	num_other_siblings () const RYML_NOEXCEPT
	O(num_siblings).
id_type	child_pos (ConstNodeRef const &n) const RYML_NOEXCEPT
	O(num_children).
id_type	sibling_pos (ConstNodeRef const &n) const RYML_NOEXCEPT
	O(num_siblings).
id_type	depth_asc () const RYML_NOEXCEPT
id_type	depth_desc () const RYML_NOEXCEPT
	O(log(num_nodes)).
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.
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).
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).
deserialization: asserts node readability, returns success status
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).
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).
lookup and deserialize
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).
legacy operators
ConstNodeRef const &	operator>> (T &v) const

Public Attributes
Tree const *	m_tree
id_type	m_id

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)

Friends
struct	detail::RoNodeMethods< ConstNodeRef, ConstNodeRef >

iteration
using	iterator = detail::child_iterator<ConstNodeRef>
using	const_iterator = detail::child_iterator<ConstNodeRef>
using	children_view = detail::children_view<ConstNodeRef>
using	const_children_view = detail::children_view<ConstNodeRef>
const_iterator	begin () const RYML_NOEXCEPT
	get an iterator to the first child
const_iterator	cbegin () const RYML_NOEXCEPT
	get an iterator to the first child
const_iterator	end () const RYML_NOEXCEPT
	get an iterator to after the last child
const_iterator	cend () const RYML_NOEXCEPT
	get an iterator to after the last child
const_children_view	children () const RYML_NOEXCEPT
	get an iterable view over children
const_children_view	cchildren () const RYML_NOEXCEPT
	get an iterable view over children
const_children_view	siblings () const RYML_NOEXCEPT
const_children_view	csiblings () const RYML_NOEXCEPT
	get an iterable view over all siblings (including the calling node)

state queries
see NodeRef for an explanation on what these states mean
bool	invalid () const noexcept
bool	readable () const noexcept
	because a ConstNodeRef cannot be used to write to the tree, readable() has the same meaning as !invalid()
static constexpr bool	is_seed () noexcept
	because a ConstNodeRef cannot be used to write to the tree, it can never be a seed.

Detailed Description

Holds a pointer to an existing tree, and a node id.

It can be used only to read from the tree.

Warning: The lifetime of the tree must be larger than that of this object. It is up to the user to ensure that this happens.

Definition at line 736 of file node.hpp.

Member Typedef Documentation

◆ tree_type

using c4::yml::ConstNodeRef::tree_type = Tree const

Definition at line 740 of file node.hpp.

◆ iterator

using c4::yml::ConstNodeRef::iterator = detail::child_iterator<ConstNodeRef>

Definition at line 974 of file node.hpp.

◆ const_iterator

using c4::yml::ConstNodeRef::const_iterator = detail::child_iterator<ConstNodeRef>

Definition at line 975 of file node.hpp.

◆ children_view

using c4::yml::ConstNodeRef::children_view = detail::children_view<ConstNodeRef>

Definition at line 976 of file node.hpp.

◆ const_children_view

using c4::yml::ConstNodeRef::const_children_view = detail::children_view<ConstNodeRef>

Definition at line 977 of file node.hpp.

Constructor & Destructor Documentation

◆ ConstNodeRef() [1/8]

c4::yml::ConstNodeRef::ConstNodeRef ( )

inlinenoexcept

Definition at line 757 of file node.hpp.

757: m_tree(nullptr), m_id(NONE) {}

c4::yml::ConstNodeRef::m_id

id_type m_id

Definition node.hpp:745

c4::yml::ConstNodeRef::m_tree

Tree const * m_tree

Definition node.hpp:744

c4::yml::NONE

@ NONE

an index to none

Definition common.hpp:131

Referenced by ConstNodeRef(), ConstNodeRef(), ancestor_doc(), at(), at(), child(), child_r(), detail::RoNodeMethods< ConstNodeRef, ConstNodeRef >, doc(), find_child(), find_child_r(), find_sibling(), find_sibling_r(), first_child(), first_sibling(), last_child(), last_sibling(), next_sibling(), operator!=(), operator=(), operator=(), operator=(), operator=(), operator==(), operator[](), operator[](), parent(), prev_sibling(), sibling(), and sibling_r().

◆ ConstNodeRef() [2/8]

c4::yml::ConstNodeRef::ConstNodeRef ( Tree const & t )

inlinenoexcept

Definition at line 758 of file node.hpp.

758: m_tree(&t), m_id(t .root_id()) {}

◆ ConstNodeRef() [3/8]

c4::yml::ConstNodeRef::ConstNodeRef ( Tree const * t )

inlinenoexcept

Definition at line 759 of file node.hpp.

759: m_tree(t ), m_id(t->root_id()) {}

◆ ConstNodeRef() [4/8]

c4::yml::ConstNodeRef::ConstNodeRef	(	Tree const *	t,
		id_type	id )

inlinenoexcept

Definition at line 760 of file node.hpp.

760: m_tree(t), m_id(id) {}

◆ ConstNodeRef() [5/8]

c4::yml::ConstNodeRef::ConstNodeRef ( ConstNodeRef const & )

defaultnoexcept

◆ ConstNodeRef() [6/8]

c4::yml::ConstNodeRef::ConstNodeRef ( ConstNodeRef && )

defaultnoexcept

◆ ConstNodeRef() [7/8]

c4::yml::ConstNodeRef::ConstNodeRef ( NodeRef const & that )

inlinenoexcept

Definition at line 2034 of file node.hpp.

    : m_tree(that.m_tree)
    , m_id(!that.is_seed() ? that.id() : (id_type)NONE)
{
}

◆ ConstNodeRef() [8/8]

c4::yml::ConstNodeRef::ConstNodeRef ( NodeRef && that )

inlinenoexcept

Definition at line 2040 of file node.hpp.

    : m_tree(that.m_tree)
    , m_id(!that.is_seed() ? that.id() : (id_type)NONE)
{
}

Member Function Documentation

◆ operator=() [1/4]

ConstNodeRef & c4::yml::ConstNodeRef::operator= ( ConstNodeRef const & )

defaultnoexcept

◆ operator=() [2/4]

ConstNodeRef & c4::yml::ConstNodeRef::operator= ( ConstNodeRef && )

defaultnoexcept

◆ operator=() [3/4]

ConstNodeRef & c4::yml::ConstNodeRef::operator= ( NodeRef const & that )

inlinenoexcept

Definition at line 2047 of file node.hpp.

{
    m_tree = (that.m_tree);
    m_id = (!that.is_seed() ? that.id() : (id_type)NONE);
    return *this;
}

◆ operator=() [4/4]

ConstNodeRef & c4::yml::ConstNodeRef::operator= ( NodeRef && that )

inlinenoexcept

Definition at line 2054 of file node.hpp.

{
    m_tree = (that.m_tree);
    m_id = (!that.is_seed() ? that.id() : (id_type)NONE);
    return *this;
}

◆ invalid()

bool c4::yml::ConstNodeRef::invalid ( ) const

inlinenoexcept

Definition at line 790 of file node.hpp.

790{ return (!m_tree) || (m_id == NONE); }

Referenced by invalid(), and sample_quick_overview().

◆ readable()

bool c4::yml::ConstNodeRef::readable ( ) const

inlinenoexcept

because a ConstNodeRef cannot be used to write to the tree, readable() has the same meaning as !invalid()

Definition at line 793 of file node.hpp.

793{ return m_tree != nullptr && m_id != NONE; }

Referenced by c4::yml::emitrs_json(), c4::yml::emitrs_json(), c4::yml::emitrs_yaml(), c4::yml::emitrs_yaml(), get(), and sample_quick_overview().

◆ is_seed()

constexpr bool c4::yml::ConstNodeRef::is_seed ( )

inlinestaticconstexprnoexcept

because a ConstNodeRef cannot be used to write to the tree, it can never be a seed.

This method is provided for API equivalence between ConstNodeRef and NodeRef.

Definition at line 796 of file node.hpp.

796{ return false; }

◆ tree()

Tree const * c4::yml::ConstNodeRef::tree ( ) const

inlinenoexcept

Definition at line 821 of file node.hpp.

821{ return m_tree; }

Referenced by c4::yml::emit_json(), c4::yml::emit_json(), c4::yml::emit_json(), c4::yml::emit_json(), c4::yml::emit_yaml(), c4::yml::emit_yaml(), c4::yml::emit_yaml(), c4::yml::emit_yaml(), c4::yml::emitrs_json(), c4::yml::emitrs_json(), c4::yml::emitrs_yaml(), c4::yml::emitrs_yaml(), c4::yml::operator<<(), c4::yml::read(), sample_quick_overview(), and tree().

◆ id()

id_type c4::yml::ConstNodeRef::id ( ) const

inlinenoexcept

Definition at line 822 of file node.hpp.

822{ return m_id; }

Referenced by c4::yml::emit_json(), c4::yml::emit_json(), c4::yml::emit_json(), c4::yml::emit_json(), c4::yml::emit_yaml(), c4::yml::emit_yaml(), c4::yml::emit_yaml(), c4::yml::emit_yaml(), c4::yml::emitrs_json(), c4::yml::emitrs_json(), c4::yml::emitrs_yaml(), c4::yml::emitrs_yaml(), c4::yml::operator<<(), c4::yml::read(), c4::yml::read(), c4::yml::read(), read(), sample_docs(), and sample_quick_overview().

◆ operator==()

bool c4::yml::ConstNodeRef::operator== ( ConstNodeRef const & that ) const

inline

Definition at line 831 of file node.hpp.

831{ return that.m_tree == m_tree && m_id == that.m_id; }

◆ operator!=()

bool c4::yml::ConstNodeRef::operator!= ( ConstNodeRef const & that ) const

inline

Definition at line 832 of file node.hpp.

832{ return ! this->operator== (that); }

c4::yml::ConstNodeRef::operator==

bool operator==(ConstNodeRef const &that) const RYML_NOEXCEPT

Definition node.hpp:831

◆ get()

NodeData const * c4::yml::ConstNodeRef::get ( ) const

inline

Forward to Tree::type().

Node must be readable.

Definition at line 841 of file node.hpp.

◆ parent()

ConstNodeRef c4::yml::ConstNodeRef::parent ( ) const

inline

Forward to Tree::parent().

Node must be readable.

Definition at line 853 of file node.hpp.

Referenced by sample_quick_overview().

◆ first_child()

ConstNodeRef c4::yml::ConstNodeRef::first_child ( ) const

inline

Forward to Tree::first_child().

Node must be readable.

Definition at line 854 of file node.hpp.

Referenced by sample_quick_overview().

◆ last_child()

ConstNodeRef c4::yml::ConstNodeRef::last_child ( ) const

inline

Forward to Tree::last_child().

Node must be readable.

Definition at line 855 of file node.hpp.

Referenced by sample_quick_overview().

◆ child()

ConstNodeRef c4::yml::ConstNodeRef::child ( id_type pos ) const

inline

Forward to Tree::child().

Node must be readable.

Definition at line 856 of file node.hpp.

Referenced by child_r(), find_child_r(), and sample_docs().

◆ find_child()

ConstNodeRef c4::yml::ConstNodeRef::find_child ( csubstr name ) const

inline

Forward to Tree::find_child().

Node must be readable.

Definition at line 857 of file node.hpp.

◆ prev_sibling()

ConstNodeRef c4::yml::ConstNodeRef::prev_sibling ( ) const

inline

Forward to Tree::prev_sibling().

Node must be readable.

Definition at line 858 of file node.hpp.

Referenced by sample_quick_overview().

◆ next_sibling()

ConstNodeRef c4::yml::ConstNodeRef::next_sibling ( ) const

inline

Forward to Tree::next_sibling().

Node must be readable.

Definition at line 859 of file node.hpp.

Referenced by sample_quick_overview().

◆ first_sibling()

ConstNodeRef c4::yml::ConstNodeRef::first_sibling ( ) const

inline

Forward to Tree::first_sibling().

Node must be readable.

Definition at line 860 of file node.hpp.

Referenced by sample_quick_overview().

◆ last_sibling()

ConstNodeRef c4::yml::ConstNodeRef::last_sibling ( ) const

inline

Forward to Tree::last_sibling().

Node must be readable.

Definition at line 861 of file node.hpp.

Referenced by sample_quick_overview().

◆ sibling()

ConstNodeRef c4::yml::ConstNodeRef::sibling ( id_type pos ) const

inline

Forward to Tree::sibling().

Node must be readable.

Definition at line 862 of file node.hpp.

Referenced by find_sibling_r(), and sibling_r().

◆ find_sibling()

ConstNodeRef c4::yml::ConstNodeRef::find_sibling ( csubstr name ) const

inline

Forward to Tree::find_sibling().

Node must be readable.

Definition at line 863 of file node.hpp.

◆ ancestor_doc()

ConstNodeRef c4::yml::ConstNodeRef::ancestor_doc ( ) const

inline

Forward to Tree::ancestor_doc().

Node must be readable.

Definition at line 864 of file node.hpp.

◆ doc()

ConstNodeRef c4::yml::ConstNodeRef::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 865 of file node.hpp.

◆ child_r()

ReadResult c4::yml::ConstNodeRef::child_r	(	id_type	pos,
		ConstNodeRef *	child ) const

inline

Definition at line 867 of file node.hpp.

867{ assert_readable_(); child->m_tree = m_tree; ReadResult result = m_tree-> child_r(m_id, pos, &child->m_id); return result; }; /**< Forward to @ref Tree::child_r(). Node must be readable. */

c4::yml::ConstNodeRef::child

ConstNodeRef child(id_type pos) const RYML_NOEXCEPT

Forward to Tree::child().

Definition node.hpp:856

c4::yml::ConstNodeRef::child_r

ReadResult child_r(id_type pos, ConstNodeRef *child) const RYML_NOEXCEPT

Definition node.hpp:867

Referenced by child_r().

◆ find_child_r()

ReadResult c4::yml::ConstNodeRef::find_child_r	(	csubstr	name,
		ConstNodeRef *	child ) const

inline

Forward to Tree::child_r().

Node must be readable.

Definition at line 868 of file node.hpp.

868{ assert_readable_(); child->m_tree = m_tree; ReadResult result = m_tree->find_child_r(m_id, name, &child->m_id); return result; }; /**< Forward to @ref Tree::find_child_r(). Node must be readable. */

◆ sibling_r()

ReadResult c4::yml::ConstNodeRef::sibling_r	(	id_type	pos,
		ConstNodeRef *	sibling ) const

inline

Forward to Tree::find_child_r().

Node must be readable.

Definition at line 870 of file node.hpp.

870{ assert_readable_(); sibling->m_tree = m_tree; ReadResult result = m_tree-> sibling_r(m_id, pos, &sibling->m_id); return result; }; /**< Forward to @ref Tree::sibling_r(). Node must be readable. */

c4::yml::ConstNodeRef::sibling_r

ReadResult sibling_r(id_type pos, ConstNodeRef *sibling) const RYML_NOEXCEPT

Forward to Tree::find_child_r().

Definition node.hpp:870

c4::yml::ConstNodeRef::sibling

ConstNodeRef sibling(id_type pos) const RYML_NOEXCEPT

Forward to Tree::sibling().

Definition node.hpp:862

Referenced by sibling_r().

◆ find_sibling_r()

ReadResult c4::yml::ConstNodeRef::find_sibling_r	(	csubstr	name,
		ConstNodeRef *	sibling ) const

inline

Forward to Tree::sibling_r().

Node must be readable.

Definition at line 871 of file node.hpp.

871{ assert_readable_(); sibling->m_tree = m_tree; ReadResult result = m_tree->find_sibling_r(m_id, name, &sibling->m_id); return result; }; /**< Forward to @ref Tree::find_sibling_r(). Node must be readable. */

◆ operator[]() [1/2]

ConstNodeRef c4::yml::ConstNodeRef::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 890 of file node.hpp.

    {
        assert_readable_();
        id_type ch = m_tree->find_child(m_id, key);
        RYML_ASSERT_VISIT_CB_(m_tree->m_callbacks, ch != NONE, m_tree, m_id);
        return {m_tree, ch};
    }

◆ operator[]() [2/2]

ConstNodeRef c4::yml::ConstNodeRef::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 907 of file node.hpp.

    {
        assert_readable_();
        id_type ch = m_tree->child(m_id, pos);
        RYML_ASSERT_VISIT_CB_(m_tree->m_callbacks, ch != NONE, m_tree, m_id);
        return {m_tree, ch};
    }

◆ at() [1/2]

ConstNodeRef c4::yml::ConstNodeRef::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 938 of file node.hpp.

    {
        check_readable_();
        RYML_CHECK_VISIT_CB_(m_tree->m_callbacks, m_tree->is_map(m_id), m_tree, m_id);
        id_type ch = m_tree->find_child(m_id, key);
        RYML_CHECK_VISIT_CB_(m_tree->m_callbacks, ch != NONE, m_tree, m_id);
        return {m_tree, ch};
    }

◆ at() [2/2]

ConstNodeRef c4::yml::ConstNodeRef::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 956 of file node.hpp.

    {
        check_readable_();
        const id_type cap = m_tree->capacity();
        RYML_CHECK_VISIT_CB_(m_tree->m_callbacks, (pos >= 0 && pos < cap), m_tree, m_id);
        RYML_CHECK_VISIT_CB_(m_tree->m_callbacks, m_tree->is_container(m_id), m_tree, m_id);
        const id_type ch = m_tree->child(m_id, pos);
        RYML_CHECK_VISIT_CB_(m_tree->m_callbacks, ch != NONE, m_tree, m_id);
        return {m_tree, ch};
    }

◆ begin()

const_iterator c4::yml::ConstNodeRef::begin ( ) const

inline

get an iterator to the first child

Definition at line 980 of file node.hpp.

◆ cbegin()

const_iterator c4::yml::ConstNodeRef::cbegin ( ) const

inline

get an iterator to the first child

Definition at line 981 of file node.hpp.

◆ end()

const_iterator c4::yml::ConstNodeRef::end ( ) const

inline

get an iterator to after the last child

Definition at line 983 of file node.hpp.

◆ cend()

const_iterator c4::yml::ConstNodeRef::cend ( ) const

inline

get an iterator to after the last child

Definition at line 984 of file node.hpp.

◆ children()

const_children_view c4::yml::ConstNodeRef::children ( ) const

inline

get an iterable view over children

Definition at line 987 of file node.hpp.

Referenced by c4::yml::read(), sample_docs(), sample_float_precision(), sample_iterate_tree(), sample_quick_overview(), and sample_tags().

◆ cchildren()

const_children_view c4::yml::ConstNodeRef::cchildren ( ) const

inline

get an iterable view over children

Definition at line 988 of file node.hpp.

◆ siblings()

const_children_view c4::yml::ConstNodeRef::siblings ( ) const

inline

Definition at line 990 of file node.hpp.

990{ assert_readable_(); return detail::make_siblings_view<const_children_view>(m_tree, m_id); } /** get an iterable view over all siblings (including the calling node) */

◆ csiblings()

const_children_view c4::yml::ConstNodeRef::csiblings ( ) const

inline

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

Definition at line 991 of file node.hpp.

991{ assert_readable_(); return detail::make_siblings_view<const_children_view>(m_tree, m_id); } /** get an iterable view over all siblings (including the calling node) */

◆ type()

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

inlineinherited

Forward to Tree::type().

Node must be readable.

Definition at line 172 of file node.hpp.

◆ key()

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

inlineinherited

Forward to Tree::key().

Node must be readable.

Definition at line 174 of file node.hpp.

Referenced by c4::yml::ConstNodeRef::at(), and c4::yml::ConstNodeRef::operator[]().

◆ key_tag()

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

inlineinherited

Forward to Tree::key_tag().

Node must be readable.

Definition at line 175 of file node.hpp.

◆ key_ref()

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

inlineinherited

Forward to Tree::key_ref().

Node must be readable.

Definition at line 176 of file node.hpp.

◆ key_anchor()

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

inlineinherited

Forward to Tree::key_anchor().

Node must be readable.

Definition at line 177 of file node.hpp.

◆ val()

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

inlineinherited

Forward to Tree::val().

Node must be readable.

Definition at line 179 of file node.hpp.

◆ val_tag()

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

inlineinherited

Forward to Tree::val_tag().

Node must be readable.

Definition at line 180 of file node.hpp.

◆ val_ref()

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

inlineinherited

Forward to Tree::val_ref().

Node must be readable.

Definition at line 181 of file node.hpp.

◆ val_anchor()

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

inlineinherited

Forward to Tree::val_anchor().

Node must be readable.

Definition at line 182 of file node.hpp.

◆ keysc()

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

inlineinherited

Forward to Tree::keysc().

Node must be readable.

Definition at line 184 of file node.hpp.

◆ valsc()

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

inlineinherited

Forward to Tree::valsc().

Node must be readable.

Definition at line 185 of file node.hpp.

◆ key_is_null()

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

inlineinherited

Forward to Tree::key_is_null().

Node must be readable.

Definition at line 187 of file node.hpp.

◆ val_is_null()

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

inlineinherited

Forward to Tree::val_is_null().

Node must be readable.

Definition at line 188 of file node.hpp.

◆ is_key_unfiltered()

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

inlinenoexceptinherited

Forward to Tree::is_key_unfiltered().

Node must be readable.

Definition at line 190 of file node.hpp.

◆ is_val_unfiltered()

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

inlinenoexceptinherited

Forward to Tree::is_val_unfiltered().

Node must be readable.

Definition at line 191 of file node.hpp.

◆ empty()

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

inlineinherited

Forward to Tree::empty().

Node must be readable.

Definition at line 203 of file node.hpp.

◆ is_stream()

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

inlineinherited

Forward to Tree::is_stream().

Node must be readable.

Definition at line 204 of file node.hpp.

◆ is_doc()

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

inlineinherited

Forward to Tree::is_doc().

Node must be readable.

Definition at line 205 of file node.hpp.

◆ is_container()

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

inlineinherited

Forward to Tree::is_container().

Node must be readable.

Definition at line 206 of file node.hpp.

◆ is_map()

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

inlineinherited

Forward to Tree::is_map().

Node must be readable.

Definition at line 207 of file node.hpp.

◆ is_seq()

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

inlineinherited

Forward to Tree::is_seq().

Node must be readable.

Definition at line 208 of file node.hpp.

◆ has_val()

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

inlineinherited

Forward to Tree::has_val().

Node must be readable.

Definition at line 209 of file node.hpp.

◆ has_key()

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

inlineinherited

Forward to Tree::has_key().

Node must be readable.

Definition at line 210 of file node.hpp.

◆ is_val()

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

inlineinherited

Forward to Tree::is_val().

Node must be readable.

Definition at line 211 of file node.hpp.

◆ is_keyval()

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

inlineinherited

Forward to Tree::is_keyval().

Node must be readable.

Definition at line 212 of file node.hpp.

◆ has_key_tag()

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

inlineinherited

Forward to Tree::has_key_tag().

Node must be readable.

Definition at line 213 of file node.hpp.

◆ has_val_tag()

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

inlineinherited

Forward to Tree::has_val_tag().

Node must be readable.

Definition at line 214 of file node.hpp.

◆ has_key_anchor()

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

inlineinherited

Forward to Tree::has_key_anchor().

Node must be readable.

Definition at line 215 of file node.hpp.

◆ has_val_anchor()

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

inlineinherited

Forward to Tree::has_val_anchor().

Node must be readable.

Definition at line 216 of file node.hpp.

◆ has_anchor()

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

inlineinherited

Forward to Tree::has_anchor().

Node must be readable.

Definition at line 217 of file node.hpp.

◆ is_key_ref()

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

inlineinherited

Forward to Tree::is_key_ref().

Node must be readable.

Definition at line 218 of file node.hpp.

◆ is_val_ref()

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

inlineinherited

Forward to Tree::is_val_ref().

Node must be readable.

Definition at line 219 of file node.hpp.

◆ is_ref()

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

inlineinherited

Forward to Tree::is_ref().

Node must be readable.

Definition at line 220 of file node.hpp.

◆ parent_is_seq()

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

inlineinherited

Forward to Tree::parent_is_seq().

Node must be readable.

Definition at line 221 of file node.hpp.

◆ parent_is_map()

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

inlineinherited

Forward to Tree::parent_is_map().

Node must be readable.

Definition at line 222 of file node.hpp.

◆ type_has_any()

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

inlineinherited

Forward to Tree::type_has_any().

Node must be readable.

Definition at line 234 of file node.hpp.

◆ type_has_all()

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

inlineinherited

Forward to Tree::type_has_all().

Node must be readable.

Definition at line 235 of file node.hpp.

◆ type_has_none()

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

inlineinherited

Forward to Tree::type_has_none().

Node must be readable.

Definition at line 236 of file node.hpp.

◆ key_style()

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

inlineinherited

Forward to Tree::key_style().

Node must be readable.

Definition at line 238 of file node.hpp.

◆ val_style()

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

inlineinherited

Forward to Tree::val_style().

Node must be readable.

Definition at line 239 of file node.hpp.

◆ is_container_styled()

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

inlineinherited

Forward to Tree::is_container_styled().

Node must be readable.

Definition at line 241 of file node.hpp.

◆ is_block()

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

inlineinherited

Forward to Tree::is_block().

Node must be readable.

Definition at line 242 of file node.hpp.

◆ is_flow()

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

inlineinherited

Forward to Tree::is_flow().

Node must be readable.

Definition at line 243 of file node.hpp.

◆ is_flow_sl()

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

inlineinherited

Forward to Tree::is_flow_sl().

Node must be readable.

Definition at line 244 of file node.hpp.

◆ is_flow_ml()

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

inlineinherited

Forward to Tree::is_flow_ml1().

Node must be readable.

Definition at line 246 of file node.hpp.

◆ is_flow_ml1()

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

inlineinherited

Forward to Tree::is_flow_ml1().

Node must be readable.

Definition at line 247 of file node.hpp.

◆ is_flow_mln()

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

inlineinherited

Forward to Tree::is_flow_mln().

Node must be readable.

Definition at line 248 of file node.hpp.

◆ is_flow_mlx()

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

inlineinherited

Forward to Tree::is_flow_mlx().

Node must be readable.

Definition at line 249 of file node.hpp.

◆ has_flow_space()

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

inlineinherited

Forward to Tree::has_flow_space().

Node must be readable.

Definition at line 250 of file node.hpp.

◆ is_key_styled()

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

inlineinherited

Forward to Tree::is_key_styled().

Node must be readable.

Definition at line 252 of file node.hpp.

◆ is_val_styled()

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

inlineinherited

Forward to Tree::is_val_styled().

Node must be readable.

Definition at line 253 of file node.hpp.

◆ is_key_literal()

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

inlineinherited

Forward to Tree::is_key_literal().

Node must be readable.

Definition at line 254 of file node.hpp.

◆ is_val_literal()

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

inlineinherited

Forward to Tree::is_val_literal().

Node must be readable.

Definition at line 255 of file node.hpp.

◆ is_key_folded()

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

inlineinherited

Forward to Tree::is_key_folded().

Node must be readable.

Definition at line 256 of file node.hpp.

◆ is_val_folded()

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

inlineinherited

Forward to Tree::is_val_folded().

Node must be readable.

Definition at line 257 of file node.hpp.

◆ is_key_squo()

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

inlineinherited

Forward to Tree::is_key_squo().

Node must be readable.

Definition at line 258 of file node.hpp.

◆ is_val_squo()

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

inlineinherited

Forward to Tree::is_val_squo().

Node must be readable.

Definition at line 259 of file node.hpp.

◆ is_key_dquo()

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

inlineinherited

Forward to Tree::is_key_dquo().

Node must be readable.

Definition at line 260 of file node.hpp.

◆ is_val_dquo()

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

inlineinherited

Forward to Tree::is_val_dquo().

Node must be readable.

Definition at line 261 of file node.hpp.

◆ is_key_plain()

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

inlineinherited

Forward to Tree::is_key_plain().

Node must be readable.

Definition at line 262 of file node.hpp.

◆ is_val_plain()

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

inlineinherited

Forward to Tree::is_val_plain().

Node must be readable.

Definition at line 263 of file node.hpp.

◆ is_key_quoted()

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

inlineinherited

Forward to Tree::is_key_quoted().

Node must be readable.

Definition at line 264 of file node.hpp.

◆ is_val_quoted()

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

inlineinherited

Forward to Tree::is_val_quoted().

Node must be readable.

Definition at line 265 of file node.hpp.

◆ is_quoted()

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

inlineinherited

Forward to Tree::is_quoted().

Node must be readable.

Definition at line 266 of file node.hpp.

◆ is_root()

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

inlineinherited

Forward to Tree::is_root().

Node must be readable.

Definition at line 278 of file node.hpp.

◆ has_parent()

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

inlineinherited

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

Definition at line 279 of file node.hpp.

◆ is_ancestor()

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

inlineinherited

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

Definition at line 280 of file node.hpp.

◆ has_child()

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

inlineinherited

Forward to Tree::has_child().

Node must be readable.

Definition at line 282 of file node.hpp.

◆ has_children()

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

inlineinherited

Forward to Tree::has_children().

Node must be readable.

Definition at line 285 of file node.hpp.

◆ has_sibling()

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

inlineinherited

Forward to Tree::has_sibling().

Node must be readable.

Definition at line 287 of file node.hpp.

◆ has_other_siblings()

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

inlineinherited

Forward to Tree::has_other_siblings().

Node must be readable.

Definition at line 290 of file node.hpp.

◆ num_children()

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

inlineinherited

O(num_children).

Forward to Tree::num_children().

Definition at line 302 of file node.hpp.

◆ num_siblings()

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

inlineinherited

O(num_children).

Forward to Tree::num_siblings().

Definition at line 303 of file node.hpp.

◆ num_other_siblings()

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

inlineinherited

O(num_siblings).

Forward to Tree::num_other_siblings().

Definition at line 304 of file node.hpp.

◆ child_pos()

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

inlineinherited

O(num_children).

Forward to Tree::child_pos().

Definition at line 305 of file node.hpp.

◆ sibling_pos()

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

inlineinherited

O(num_siblings).

Forward to Tree::sibling_pos().

Definition at line 306 of file node.hpp.

◆ depth_asc()

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

inlineinherited

Definition at line 308 of file node.hpp.

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

c4::yml::detail::RoNodeMethods

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

Definition node.hpp:153

c4::yml::detail::RoNodeMethods::depth_asc

id_type depth_asc() const RYML_NOEXCEPT

Definition node.hpp:308

◆ depth_desc()

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

inlineinherited

O(log(num_nodes)).

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

Definition at line 309 of file node.hpp.

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

c4::yml::detail::RoNodeMethods::depth_desc

id_type depth_desc() const RYML_NOEXCEPT

O(log(num_nodes)).

Definition node.hpp:309

◆ location()

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

inlineinherited

Definition at line 318 of file node.hpp.

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

◆ load()

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

inlineinherited

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

    {
        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");
    }

◆ load_key()

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

inlineinherited

(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");
    }

◆ deserialize()

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

inlineinherited

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

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

◆ deserialize_key()

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

inlineinherited

(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_);
    }

◆ deserialize_child()

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

inlineinherited

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

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

◆ operator>>()

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

inlineinherited

Definition at line 573 of file node.hpp.

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

c4::yml::detail::RoNodeMethods< ConstNodeRef, ConstNodeRef >::load

void load(T *v, bool check_readable=true) const

Definition node.hpp:345

◆ check_val_()

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

inlineprotectedinherited

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");
    }

◆ check_key_()

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

inlineprotectedinherited

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");
    }

◆ err_basic_()

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

inlinestaticprotectedinherited

Definition at line 609 of file node.hpp.

    {
        RYML_ERR_BASIC_(msg);
    }

◆ err_visit_()

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

inlinestaticprotectedinherited

Definition at line 615 of file node.hpp.

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

◆ assert_val_()

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

inlineprotectednoexceptinherited

Definition at line 624 of file node.hpp.

624{}

◆ assert_key_()

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

inlineprotectednoexceptinherited

Definition at line 625 of file node.hpp.

625{}

◆ detail::RoNodeMethods< ConstNodeRef, ConstNodeRef >

friend struct detail::RoNodeMethods< ConstNodeRef, ConstNodeRef >

friend

Definition at line 749 of file node.hpp.

Member Data Documentation

◆ m_tree

Tree const* c4::yml::ConstNodeRef::m_tree

◆ m_id

id_type c4::yml::ConstNodeRef::m_id

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

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

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Friends

iteration

state queries

Detailed Description

Member Typedef Documentation

◆ tree_type

◆ iterator

◆ const_iterator

◆ children_view

◆ const_children_view

Constructor & Destructor Documentation

◆ ConstNodeRef() [1/8]

◆ ConstNodeRef() [2/8]

◆ ConstNodeRef() [3/8]

◆ ConstNodeRef() [4/8]

◆ ConstNodeRef() [5/8]

◆ ConstNodeRef() [6/8]

◆ ConstNodeRef() [7/8]

◆ ConstNodeRef() [8/8]

Member Function Documentation

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

◆ invalid()

◆ readable()

◆ is_seed()

◆ tree()

◆ id()

◆ operator==()

◆ operator!=()

◆ get()

◆ parent()

◆ first_child()

◆ last_child()

◆ child()

◆ find_child()

◆ prev_sibling()

◆ next_sibling()

◆ first_sibling()

◆ last_sibling()

◆ sibling()

◆ find_sibling()

◆ ancestor_doc()

◆ doc()

◆ child_r()

◆ find_child_r()

◆ sibling_r()

◆ find_sibling_r()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ at() [1/2]

◆ at() [2/2]

◆ begin()

◆ cbegin()

◆ end()

◆ cend()

◆ children()

◆ cchildren()

◆ siblings()

◆ csiblings()

◆ type()

◆ 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()