table Class Reference

A TOML table. More...

#include <table.hpp>

Inheritance diagram for table:

Collaboration diagram for table:

Public Member Functions
TOML_NODISCARD_CTOR TOML_EXPORTED_MEMBER_FUNCTION	table () noexcept
	Default constructor.
TOML_EXPORTED_MEMBER_FUNCTION	~table () noexcept
TOML_NODISCARD_CTOR TOML_EXPORTED_MEMBER_FUNCTION	table (const table &)
	Copy constructor.
TOML_NODISCARD_CTOR TOML_EXPORTED_MEMBER_FUNCTION	table (table &&other) noexcept
	Move constructor.
TOML_NODISCARD_CTOR TOML_EXPORTED_MEMBER_FUNCTION	table (std::initializer_list< impl::table_init_pair > kvps)
	Constructs a table with one or more initial key-value pairs.
TOML_EXPORTED_MEMBER_FUNCTION table &	operator= (const table &)
	Copy-assignment operator.
TOML_EXPORTED_MEMBER_FUNCTION table &	operator= (table &&rhs) noexcept
	Move-assignment operator.
Type checks
TOML_CONST_INLINE_GETTER node_type	type () const noexcept final
	Returns #toml::node_type::table.
TOML_PURE_GETTER TOML_EXPORTED_MEMBER_FUNCTION bool	is_homogeneous (node_type ntype) const noexcept final
TOML_PURE_GETTER TOML_EXPORTED_MEMBER_FUNCTION bool	is_homogeneous (node_type ntype, node *&first_nonmatch) noexcept final
TOML_PURE_GETTER TOML_EXPORTED_MEMBER_FUNCTION bool	is_homogeneous (node_type ntype, const node *&first_nonmatch) const noexcept final
TOML_CONST_INLINE_GETTER bool	is_table () const noexcept final
	Returns true.
TOML_CONST_INLINE_GETTER bool	is_array () const noexcept final
	Returns false.
TOML_PURE_GETTER bool	is_array_of_tables () const noexcept final
	Returns false.
TOML_CONST_INLINE_GETTER bool	is_value () const noexcept final
	Returns false.
TOML_CONST_INLINE_GETTER bool	is_string () const noexcept final
	Returns false.
TOML_CONST_INLINE_GETTER bool	is_integer () const noexcept final
	Returns false.
TOML_CONST_INLINE_GETTER bool	is_floating_point () const noexcept final
	Returns false.
TOML_CONST_INLINE_GETTER bool	is_number () const noexcept final
	Returns false.
TOML_CONST_INLINE_GETTER bool	is_boolean () const noexcept final
	Returns false.
TOML_CONST_INLINE_GETTER bool	is_date () const noexcept final
	Returns false.
TOML_CONST_INLINE_GETTER bool	is_time () const noexcept final
	Returns false.
TOML_CONST_INLINE_GETTER bool	is_date_time () const noexcept final
	Returns false.
Type casts
TOML_CONST_INLINE_GETTER table *	as_table () noexcept final
	Returns a pointer to the table.
TOML_CONST_INLINE_GETTER array *	as_array () noexcept final
	Returns nullptr.
TOML_CONST_INLINE_GETTER toml::value< std::string > *	as_string () noexcept final
	Returns nullptr.
TOML_CONST_INLINE_GETTER toml::value< int64_t > *	as_integer () noexcept final
	Returns nullptr.
TOML_CONST_INLINE_GETTER toml::value< double > *	as_floating_point () noexcept final
	Returns nullptr.
TOML_CONST_INLINE_GETTER toml::value< bool > *	as_boolean () noexcept final
	Returns nullptr.
TOML_CONST_INLINE_GETTER toml::value< date > *	as_date () noexcept final
	Returns nullptr.
TOML_CONST_INLINE_GETTER toml::value< time > *	as_time () noexcept final
	Returns nullptr.
TOML_CONST_INLINE_GETTER toml::value< date_time > *	as_date_time () noexcept final
	Returns nullptr.
TOML_CONST_INLINE_GETTER const table *	as_table () const noexcept final
	Returns a const-qualified pointer to the table.
TOML_CONST_INLINE_GETTER const array *	as_array () const noexcept final
	Returns nullptr.
TOML_CONST_INLINE_GETTER const toml::value< std::string > *	as_string () const noexcept final
	Returns nullptr.
TOML_CONST_INLINE_GETTER const toml::value< int64_t > *	as_integer () const noexcept final
	Returns nullptr.
TOML_CONST_INLINE_GETTER const toml::value< double > *	as_floating_point () const noexcept final
	Returns nullptr.
TOML_CONST_INLINE_GETTER const toml::value< bool > *	as_boolean () const noexcept final
	Returns nullptr.
TOML_CONST_INLINE_GETTER const toml::value< date > *	as_date () const noexcept final
	Returns nullptr.
TOML_CONST_INLINE_GETTER const toml::value< time > *	as_time () const noexcept final
	Returns nullptr.
TOML_CONST_INLINE_GETTER const toml::value< date_time > *	as_date_time () const noexcept final
	Returns nullptr.
Metadata
TOML_PURE_INLINE_GETTER bool	is_inline () const noexcept
	Returns true if this table is an inline table.
void	is_inline (bool val) noexcept
	Sets whether this table is a TOML inline table.
Value retrieval
TOML_PURE_GETTER TOML_EXPORTED_MEMBER_FUNCTION node *	get (std::string_view key) noexcept
	Gets the node at a specific key.
TOML_PURE_INLINE_GETTER const node *	get (std::string_view key) const noexcept
	Gets the node at a specific key (const overload).
TOML_NODISCARD node *	get (std::wstring_view key)
	Gets the node at a specific key.
TOML_NODISCARD const node *	get (std::wstring_view key) const
	Gets the node at a specific key (const overload).
template<typename T >
TOML_PURE_GETTER impl::wrap_node< T > *	get_as (std::string_view key) noexcept
	Gets the node at a specific key if it is a particular type.
template<typename T >
TOML_PURE_GETTER const impl::wrap_node< T > *	get_as (std::string_view key) const noexcept
	Gets the node at a specific key if it is a particular type (const overload).
template<typename T >
TOML_NODISCARD impl::wrap_node< T > *	get_as (std::wstring_view key)
	Gets the node at a specific key if it is a particular type.
template<typename T >
TOML_NODISCARD const impl::wrap_node< T > *	get_as (std::wstring_view key) const
	Gets the node at a specific key if it is a particular type (const overload).
TOML_NODISCARD TOML_EXPORTED_MEMBER_FUNCTION node &	at (std::string_view key)
	Gets a reference to the element at a specific key, throwing std::out_of_range if none existed.
TOML_NODISCARD const node &	at (std::string_view key) const
	Gets a reference to the element at a specific key, throwing std::out_of_range if none existed.
TOML_NODISCARD node &	at (std::wstring_view key)
	Gets a reference to the element at a specific key, throwing std::out_of_range if none existed.
TOML_NODISCARD const node &	at (std::wstring_view key) const
	Gets a reference to the element at a specific key, throwing std::out_of_range if none existed.
Size and Capacity
TOML_PURE_INLINE_GETTER bool	empty () const noexcept
	Returns true if the table is empty.
TOML_PURE_INLINE_GETTER size_t	size () const noexcept
	Returns the number of key-value pairs in the table.
Searching
TOML_PURE_GETTER iterator	lower_bound (std::string_view key) noexcept
	Returns an iterator to the first key-value pair with key that is not less than the given key.
TOML_PURE_GETTER const_iterator	lower_bound (std::string_view key) const noexcept
	Returns a const iterator to the first key-value pair with key that is not less than the given key.
TOML_NODISCARD iterator	lower_bound (std::wstring_view key)
	Returns an iterator to the first key-value pair with key that is not less than the given key.
TOML_NODISCARD const_iterator	lower_bound (std::wstring_view key) const
	Returns a const iterator to the first key-value pair with key that is not less than the given key.
TOML_PURE_GETTER TOML_EXPORTED_MEMBER_FUNCTION iterator	find (std::string_view key) noexcept
	Gets an iterator to the node at a specific key.
TOML_PURE_GETTER TOML_EXPORTED_MEMBER_FUNCTION const_iterator	find (std::string_view key) const noexcept
	Gets an iterator to the node at a specific key (const overload)
TOML_PURE_GETTER bool	contains (std::string_view key) const noexcept
	Returns true if the table contains a node at the given key.
TOML_NODISCARD iterator	find (std::wstring_view key)
	Gets an iterator to the node at a specific key.
TOML_NODISCARD const_iterator	find (std::wstring_view key) const
	Gets an iterator to the node at a specific key (const overload).
TOML_NODISCARD bool	contains (std::wstring_view key) const
	Returns true if the table contains a node at the given key.
Erasure
iterator	erase (iterator pos) noexcept
	Removes the specified key-value pair from the table.
iterator	erase (const_iterator pos) noexcept
	Removes the specified key-value pair from the table (const iterator overload).
iterator	erase (const_iterator begin, const_iterator end) noexcept
	Removes the key-value pairs in the range [first, last) from the table.
TOML_EXPORTED_MEMBER_FUNCTION size_t	erase (std::string_view key) noexcept
	Removes the value with the given key from the table.
size_t	erase (std::wstring_view key)
	Removes the value with the given key from the table.
TOML_EXPORTED_MEMBER_FUNCTION table &	prune (bool recursive=true) &noexcept
	Removes empty child arrays and tables.
table &&	prune (bool recursive=true) &&noexcept
	Removes empty child arrays and tables (rvalue overload).
TOML_EXPORTED_MEMBER_FUNCTION void	clear () noexcept
	Removes all key-value pairs from the table.
Node views
TOML_NODISCARD node_view< node >	operator[] (std::string_view key) noexcept
	Gets a node_view for the selected value.
TOML_NODISCARD node_view< const node >	operator[] (std::string_view key) const noexcept
	Gets a node_view for the selected value (const overload).
TOML_NODISCARD node_view< node >	operator[] (std::wstring_view key)
	Gets a node_view for the selected value.
TOML_NODISCARD node_view< const node >	operator[] (std::wstring_view key) const
	Gets a node_view for the selected value (const overload).

Friends
std::ostream &	operator<< (std::ostream &lhs, const table &rhs)
	Prints the table out to a stream as formatted TOML.
Equality
TOML_NODISCARD friend bool	operator== (const table &lhs, const table &rhs) noexcept
	Equality operator.
TOML_NODISCARD friend bool	operator!= (const table &lhs, const table &rhs) noexcept
	Inequality operator.

Iteration
using	iterator = toml::table_iterator
	A BidirectionalIterator for iterating over key-value pairs in a toml::table.
using	const_iterator = toml::const_table_iterator
	A BidirectionalIterator for iterating over const key-value pairs in a toml::table.
TOML_PURE_INLINE_GETTER iterator	begin () noexcept
	Returns an iterator to the first key-value pair.
TOML_PURE_INLINE_GETTER const_iterator	begin () const noexcept
	Returns an iterator to the first key-value pair.
TOML_PURE_INLINE_GETTER const_iterator	cbegin () const noexcept
	Returns an iterator to the first key-value pair.
TOML_PURE_INLINE_GETTER iterator	end () noexcept
	Returns an iterator to one-past-the-last key-value pair.
TOML_PURE_INLINE_GETTER const_iterator	end () const noexcept
	Returns an iterator to one-past-the-last key-value pair.
TOML_PURE_INLINE_GETTER const_iterator	cend () const noexcept
	Returns an iterator to one-past-the-last key-value pair.
template<typename Func >
table &	for_each (Func &&visitor) &noexcept(for_each_is_nothrow< Func &&, table & >::value)
	Invokes a visitor on each key-value pair in the table.
template<typename Func >
table &&	for_each (Func &&visitor) &&noexcept(for_each_is_nothrow< Func &&, table && >::value)
	Invokes a visitor on each key-value pair in the table (rvalue overload).
template<typename Func >
const table &	for_each (Func &&visitor) const &noexcept(for_each_is_nothrow< Func &&, const table & >::value)
	Invokes a visitor on each key-value pair in the table (const lvalue overload).
template<typename Func >
const table &&	for_each (Func &&visitor) const &&noexcept(for_each_is_nothrow< Func &&, const table && >::value)
	Invokes a visitor on each key-value pair in the table (const rvalue overload).

Insertion and Emplacement
using	raw_value_type = impl::remove_cvref< ValueType >
using	value_type = std::conditional_t< std::is_void_v< raw_value_type >, impl::emplaced_type_of< ValueArgs &&... >, raw_value_type >
using	unwrapped_type = impl::remove_cvref< impl::unwrap_node< value_type > >
KeyType &&	key
KeyType ValueArgs &&	args
	else
map_iterator	ipos = insert_with_hint(hint, toml::key{static_cast<KeyType&&>(key)}, nullptr)
return	iterator {ipos}
Iter	end
Iter value_flags	flags
	TOML_CONSTRAINED_TEMPLATE ((is_key_or_convertible< KeyType && >||impl::is_wide_string< KeyType >), typename ValueType=void, typename KeyType, typename... ValueArgs) iterator emplace_hint(const_iterator hint
	Emplaces a new value at a specific key if one did not already exist.
if	constexpr (impl::is_wide_string< KeyType >)
	if (!ipos->second)
	TOML_CONSTRAINED_TEMPLATE ((is_key_or_convertible< KeyType && >||impl::is_wide_string< KeyType >), typename KeyType, typename ValueType) std
	Inserts a new value at a specific key if one did not already exist.
	TOML_CONSTRAINED_TEMPLATE ((!is_key_or_convertible< Iter > &&!impl::is_wide_string< Iter >), typename Iter) void insert(Iter begin
	Inserts a series of key-value pairs into the table.
Iter value_flags bool	insert_or_assign (KeyType &&key, ValueType &&val, value_flags flags=preserve_source_value_flags)
	TOML_CONSTRAINED_TEMPLATE ((is_key_or_convertible< KeyType && >||impl::is_wide_string< KeyType >), typename ValueType=void, typename KeyType, typename... ValueArgs) std
	Emplaces a new value at a specific key if one did not already exist.

Detailed Description

A TOML table.

\detail The interface of this type is modeled after std::map, with some additional considerations made for the heterogeneous nature of a TOML table.

\cpp toml::table tbl = toml::parse(R"( @iverbatim [animals] cats = [ "tiger", "lion", "puma" ] birds = [ "macaw", "pigeon", "canary" ] fish = [ "salmon", "trout", "carp" ] @endiverbatim )"sv);

// operator[] retrieves node-views std::cout << "cats: " << tbl["animals"]["cats"] << "\n"; std::cout << "fish[1]: " << tbl["animals"]["fish"][1] << "\n";

// at_path() does fully-qualified "toml path" lookups std::cout << "cats: " << tbl.at_path("animals.cats") << "\n"; std::cout << "fish[1]: " << tbl.at_path("animals.fish[1]") << "\n"; \ecpp

\out cats: ['tiger', 'lion', 'puma'] fish[1] : 'trout' cats : ['tiger', 'lion', 'puma'] fish[1] : 'trout' \eout

Definition at line 190 of file table.hpp.

Member Typedef Documentation

const_iterator

using table::const_iterator = toml::const_table_iterator

A BidirectionalIterator for iterating over const key-value pairs in a toml::table.

Definition at line 645 of file table.hpp.

iterator

using table::iterator = toml::table_iterator

A BidirectionalIterator for iterating over key-value pairs in a toml::table.

Definition at line 642 of file table.hpp.

raw_value_type

using table::raw_value_type = impl::remove_cvref<ValueType>

Definition at line 1258 of file table.hpp.

unwrapped_type

using table::unwrapped_type = impl::remove_cvref<impl::unwrap_node<value_type> >

Definition at line 1274 of file table.hpp.

value_type

using table::value_type = std::conditional_t<std::is_void_v<raw_value_type>, impl::emplaced_type_of<ValueArgs&&...>, raw_value_type>

Definition at line 1259 of file table.hpp.

Constructor & Destructor Documentation

table() [1/4]

TOML_NODISCARD_CTOR TOML_EXPORTED_MEMBER_FUNCTION table::table ( )

noexcept

Default constructor.

~table()

TOML_EXPORTED_MEMBER_FUNCTION table::~table ( )

noexcept

table() [2/4]

TOML_NODISCARD_CTOR TOML_EXPORTED_MEMBER_FUNCTION table::table

(

const table &

)

Copy constructor.

table() [3/4]

TOML_NODISCARD_CTOR TOML_EXPORTED_MEMBER_FUNCTION table::table ( table &&  other )

noexcept

Move constructor.

table() [4/4]

TOML_NODISCARD_CTOR TOML_EXPORTED_MEMBER_FUNCTION table::table ( std::initializer_list< impl::table_init_pair >  kvps )

inlineexplicit

Constructs a table with one or more initial key-value pairs.

\detail \cpp auto tbl = toml::table{ { "foo", 1 }, { "bar", 2.0 }, { "kek", "three" } }; std::cout << tbl << "\n"; \ecpp

\out { foo = 1, bar = 2.0, kek = "three" } \eout

Parameters

kvps	A list of key-value pairs used to initialize the table.

Definition at line 245 of file table.hpp.

Member Function Documentation

as_array() [1/2]

TOML_CONST_INLINE_GETTER const array * table::as_array ( ) const

inlinefinalnoexcept

Returns nullptr.

Definition at line 382 of file table.hpp.

as_array() [2/2]

TOML_CONST_INLINE_GETTER array * table::as_array ( )

inlinefinalnoexcept

Returns nullptr.

Definition at line 346 of file table.hpp.

as_boolean() [1/2]

TOML_CONST_INLINE_GETTER const toml::value< bool > * table::as_boolean ( ) const

inlinefinalnoexcept

Returns nullptr.

Definition at line 398 of file table.hpp.

as_boolean() [2/2]

TOML_CONST_INLINE_GETTER toml::value< bool > * table::as_boolean ( )

inlinefinalnoexcept

Returns nullptr.

Definition at line 362 of file table.hpp.

as_date() [1/2]

TOML_CONST_INLINE_GETTER const toml::value< date > * table::as_date ( ) const

inlinefinalnoexcept

Returns nullptr.

Definition at line 402 of file table.hpp.

as_date() [2/2]

TOML_CONST_INLINE_GETTER toml::value< date > * table::as_date ( )

inlinefinalnoexcept

Returns nullptr.

Definition at line 366 of file table.hpp.

as_date_time() [1/2]

TOML_CONST_INLINE_GETTER const toml::value< date_time > * table::as_date_time ( ) const

inlinefinalnoexcept

Returns nullptr.

Definition at line 410 of file table.hpp.

as_date_time() [2/2]

TOML_CONST_INLINE_GETTER toml::value< date_time > * table::as_date_time ( )

inlinefinalnoexcept

Returns nullptr.

Definition at line 374 of file table.hpp.

as_floating_point() [1/2]

TOML_CONST_INLINE_GETTER const toml::value< double > * table::as_floating_point ( ) const

inlinefinalnoexcept

Returns nullptr.

Definition at line 394 of file table.hpp.

as_floating_point() [2/2]

TOML_CONST_INLINE_GETTER toml::value< double > * table::as_floating_point ( )

inlinefinalnoexcept

Returns nullptr.

Definition at line 358 of file table.hpp.

as_integer() [1/2]

TOML_CONST_INLINE_GETTER const toml::value< int64_t > * table::as_integer ( ) const

inlinefinalnoexcept

Returns nullptr.

Definition at line 390 of file table.hpp.

as_integer() [2/2]

TOML_CONST_INLINE_GETTER toml::value< int64_t > * table::as_integer ( )

inlinefinalnoexcept

Returns nullptr.

Definition at line 354 of file table.hpp.

as_string() [1/2]

TOML_CONST_INLINE_GETTER const toml::value< std::string > * table::as_string ( ) const

inlinefinalnoexcept

Returns nullptr.

Definition at line 386 of file table.hpp.

as_string() [2/2]

TOML_CONST_INLINE_GETTER toml::value< std::string > * table::as_string ( )

inlinefinalnoexcept

Returns nullptr.

Definition at line 350 of file table.hpp.

as_table() [1/2]

TOML_CONST_INLINE_GETTER const table * table::as_table ( ) const

inlinefinalnoexcept

Returns a const-qualified pointer to the table.

Definition at line 378 of file table.hpp.

as_table() [2/2]

TOML_CONST_INLINE_GETTER table * table::as_table ( )

inlinefinalnoexcept

Returns a pointer to the table.

Definition at line 342 of file table.hpp.

as_time() [1/2]

TOML_CONST_INLINE_GETTER const toml::value< time > * table::as_time ( ) const

inlinefinalnoexcept

Returns nullptr.

Definition at line 406 of file table.hpp.

as_time() [2/2]

TOML_CONST_INLINE_GETTER toml::value< time > * table::as_time ( )

inlinefinalnoexcept

Returns nullptr.

Definition at line 370 of file table.hpp.

at() [1/4]

TOML_NODISCARD TOML_EXPORTED_MEMBER_FUNCTION node & table::at

(

std::string_view

key

)

Gets a reference to the element at a specific key, throwing std::out_of_range if none existed.

at() [2/4]

TOML_NODISCARD const node & table::at ( std::string_view  key ) const

inline

Gets a reference to the element at a specific key, throwing std::out_of_range if none existed.

Definition at line 616 of file table.hpp.

at() [3/4]

TOML_NODISCARD node & table::at ( std::wstring_view  key )

inline

Gets a reference to the element at a specific key, throwing std::out_of_range if none existed.

\availability This overload is only available when TOML_ENABLE_WINDOWS_COMPAT is enabled.

Definition at line 625 of file table.hpp.

at() [4/4]

TOML_NODISCARD const node & table::at ( std::wstring_view  key ) const

inline

Gets a reference to the element at a specific key, throwing std::out_of_range if none existed.

\availability This overload is only available when TOML_ENABLE_WINDOWS_COMPAT is enabled.

Definition at line 632 of file table.hpp.

begin() [1/2]

TOML_PURE_INLINE_GETTER const_iterator table::begin ( ) const

inlinenoexcept

Returns an iterator to the first key-value pair.

Definition at line 653 of file table.hpp.

begin() [2/2]

TOML_PURE_INLINE_GETTER iterator table::begin ( )

inlinenoexcept

Returns an iterator to the first key-value pair.

Definition at line 649 of file table.hpp.

cbegin()

TOML_PURE_INLINE_GETTER const_iterator table::cbegin ( ) const

inlinenoexcept

Returns an iterator to the first key-value pair.

Definition at line 657 of file table.hpp.

cend()

TOML_PURE_INLINE_GETTER const_iterator table::cend ( ) const

inlinenoexcept

Returns an iterator to one-past-the-last key-value pair.

Definition at line 669 of file table.hpp.

clear()

TOML_EXPORTED_MEMBER_FUNCTION void table::clear ( )

noexcept

Removes all key-value pairs from the table.

constexpr()

if table::constexpr ( impl::is_wide_string< KeyType >  )

inlineconstexpr

Definition at line 1262 of file table.hpp.

contains() [1/2]

TOML_PURE_GETTER bool table::contains ( std::string_view  key ) const

inlinenoexcept

Returns true if the table contains a node at the given key.

Definition at line 1011 of file table.hpp.

contains() [2/2]

TOML_NODISCARD bool table::contains ( std::wstring_view  key ) const

inline

Returns true if the table contains a node at the given key.

\availability This overload is only available when TOML_ENABLE_WINDOWS_COMPAT is enabled.

Definition at line 1043 of file table.hpp.

empty()

TOML_PURE_INLINE_GETTER bool table::empty ( ) const

inlinenoexcept

Returns true if the table is empty.

Definition at line 924 of file table.hpp.

end() [1/2]

TOML_PURE_INLINE_GETTER const_iterator table::end ( ) const

inlinenoexcept

Returns an iterator to one-past-the-last key-value pair.

Definition at line 665 of file table.hpp.

end() [2/2]

TOML_PURE_INLINE_GETTER iterator table::end ( )

inlinenoexcept

Returns an iterator to one-past-the-last key-value pair.

Definition at line 661 of file table.hpp.

erase() [1/5]

iterator table::erase ( const_iterator  begin, const_iterator  end  )

inlinenoexcept

Removes the key-value pairs in the range [first, last) from the table.

\detail \cpp auto tbl = toml::table{ { "a", 1 }, { "b", "bad" }, { "c", "karma" }, { "d", 2 } }; std::cout << tbl << "\n";

tbl.erase(tbl.cbegin() + 1, tbl.cbegin() + 3); std::cout << tbl << "\n"; \ecpp

\out { a = 1, b = "bad", c = "karma", d = 2 } { a = 1, d = 2 } \eout

Parameters

begin	Iterator to the first key-value pair being erased.
end	Iterator to the one-past-the-last key-value pair being erased.

Returns

Iterator to the first key-value pair immediately following the last removed key-value pair.

Definition at line 1139 of file table.hpp.

erase() [2/5]

iterator table::erase ( const_iterator  pos )

inlinenoexcept

Removes the specified key-value pair from the table (const iterator overload).

\detail \cpp auto tbl = toml::table{ { "a", 1 }, { "b", 2 }, { "c", 3 } }; std::cout << tbl << "\n";

tbl.erase(tbl.cbegin() + 1); std::cout << tbl << "\n"; \ecpp

\out { a = 1, b = 2, c = 3 } { a = 1, c = 3 } \eout

Parameters

pos	Iterator to the key-value pair being erased.

Returns

Iterator to the first key-value pair immediately following the removed key-value pair.

Definition at line 1112 of file table.hpp.

erase() [3/5]

iterator table::erase ( iterator  pos )

inlinenoexcept

Removes the specified key-value pair from the table.

\detail \cpp auto tbl = toml::table{ { "a", 1 }, { "b", 2 }, { "c", 3 } }; std::cout << tbl << "\n";

tbl.erase(tbl.begin() + 1); std::cout << tbl << "\n"; \ecpp

\out { a = 1, b = 2, c = 3 } { a = 1, c = 3 } \eout

Parameters

pos	Iterator to the key-value pair being erased.

Returns

Iterator to the first key-value pair immediately following the removed key-value pair.

Definition at line 1087 of file table.hpp.

erase() [4/5]

TOML_EXPORTED_MEMBER_FUNCTION size_t table::erase ( std::string_view  key )

noexcept

Removes the value with the given key from the table.

\detail \cpp auto tbl = toml::table{ { "a", 1 }, { "b", 2 }, { "c", 3 } }; std::cout << tbl << "\n";

std::cout << tbl.erase("b") << "\n"; std::cout << tbl.erase("not an existing key") << "\n"; std::cout << tbl << "\n"; \ecpp

\out { a = 1, b = 2, c = 3 } true false { a = 1, c = 3 } \eout

Parameters

key	Key to erase.

Returns

Number of elements removed (0 or 1).

erase() [5/5]

size_t table::erase ( std::wstring_view  key )

inline

Removes the value with the given key from the table.

\availability This overload is only available when TOML_ENABLE_WINDOWS_COMPAT is enabled.

Parameters

key	Key to erase.

Returns

Number of elements removed (0 or 1).

Definition at line 1180 of file table.hpp.

find() [1/4]

TOML_PURE_GETTER TOML_EXPORTED_MEMBER_FUNCTION const_iterator table::find ( std::string_view  key ) const

noexcept

Gets an iterator to the node at a specific key (const overload)

Parameters

key	The node's key.

Returns

A const iterator to the node at the specified key, or cend().

find() [2/4]

TOML_PURE_GETTER TOML_EXPORTED_MEMBER_FUNCTION iterator table::find ( std::string_view  key )

noexcept

Gets an iterator to the node at a specific key.

Parameters

key	The node's key.

Returns

An iterator to the node at the specified key, or end().

find() [3/4]

TOML_NODISCARD iterator table::find ( std::wstring_view  key )

inline

Gets an iterator to the node at a specific key.

\availability This overload is only available when TOML_ENABLE_WINDOWS_COMPAT is enabled.

Parameters

key	The node's key.

Returns

An iterator to the node at the specified key, or end().

Definition at line 1023 of file table.hpp.

find() [4/4]

TOML_NODISCARD const_iterator table::find ( std::wstring_view  key ) const

inline

Gets an iterator to the node at a specific key (const overload).

\availability This overload is only available when TOML_ENABLE_WINDOWS_COMPAT is enabled.

Parameters

key	The node's key.

Returns

A const iterator to the node at the specified key, or cend().

Definition at line 1037 of file table.hpp.

for_each() [1/4]

template<typename Func >

table && table::for_each ( Func &&  visitor ) &&

inlinenoexcept

Invokes a visitor on each key-value pair in the table (rvalue overload).

Definition at line 895 of file table.hpp.

for_each() [2/4]

template<typename Func >

table & table::for_each ( Func &&  visitor ) &

inlinenoexcept

Invokes a visitor on each key-value pair in the table.

Template Parameters

Func

A callable type invocable with one of the following signatures: func(key, val) func(val) Where: key will recieve a const reference to a toml::key val will recieve the value as it's concrete type with cvref-qualifications matching the table Visitors returning bool (or something convertible to bool) will cause iteration to stop if they return false.

Parameters

visitor

The visitor object.

Returns

A reference to the table.

\cpp toml::table tbl{ { "0", 0 }, { "1", 1 }, { "2", 2 }, { "3", 3.0 }, { "4", "four" }, { "5", "five" }, { "6", 6 } };

// select only the integers using a strongly-typed visitor tbl.for_each([](toml::value<int64_t>& val) { std::cout << val << ", "; }); std::cout << "\n";

// select all the numeric values using a generic visitor + is_number<> metafunction tbl.for_each([](auto&& val) { if constexpr (toml::is_number<decltype(val)>) std::cout << val << ", "; }); std::cout << "\n";

// select all the numeric values until we encounter something non-numeric tbl.for_each([](auto&& val) { if constexpr (toml::is_number<decltype(val)>) { std::cout << val << ", "; return true; // "keep going" } else return false; // "stop!"

}); std::cout << "\n\n";

// visitors may also recieve the key tbl.for_each([](const toml::key& key, auto&& val) { std::cout << key << ": " << val << "\n"; });

\ecpp \out 0, 1, 2, 6, 0, 1, 2, 3.0, 6, 0, 1, 2, 3.0,

0: 0 1: 1 2: 2 3: 3.0 4: 'four' 5: 'five' 6: 6 \eout

See also

node::visit()

Definition at line 887 of file table.hpp.

for_each() [3/4]

template<typename Func >

const table && table::for_each ( Func &&  visitor ) const &&

inlinenoexcept

Invokes a visitor on each key-value pair in the table (const rvalue overload).

Definition at line 911 of file table.hpp.

for_each() [4/4]

template<typename Func >

const table & table::for_each ( Func &&  visitor ) const &

inlinenoexcept

Invokes a visitor on each key-value pair in the table (const lvalue overload).

Definition at line 903 of file table.hpp.

get() [1/4]

TOML_PURE_INLINE_GETTER const node * table::get ( std::string_view  key ) const

inlinenoexcept

Gets the node at a specific key (const overload).

Parameters

key	The node's key.

Returns

A pointer to the node at the specified key, or nullptr.

Definition at line 503 of file table.hpp.

get() [2/4]

TOML_PURE_GETTER TOML_EXPORTED_MEMBER_FUNCTION node * table::get ( std::string_view  key )

noexcept

Gets the node at a specific key.

\detail \cpp auto tbl = toml::table{ { "a", 42, }, { "b", "is the meaning of life, apparently." } }; std::cout << R"(node ["a"] exists: )"sv << !!arr.get("a") << "\n"; std::cout << R"(node ["b"] exists: )"sv << !!arr.get("b") << "\n"; std::cout << R"(node ["c"] exists: )"sv << !!arr.get("c") << "\n"; if (auto val = arr.get("a")) std::cout << R"(node ["a"] was an )"sv << val->type() << "\n"; \ecpp

\out node ["a"] exists: true node ["b"] exists: true node ["c"] exists: false node ["a"] was an integer \eout

Parameters

key	The node's key.

Returns

A pointer to the node at the specified key, or nullptr.

get() [3/4]

TOML_NODISCARD node * table::get ( std::wstring_view  key )

inline

Gets the node at a specific key.

\availability This overload is only available when TOML_ENABLE_WINDOWS_COMPAT is enabled.

Parameters

key	The node's key.

Returns

A pointer to the node at the specified key, or nullptr.

Definition at line 517 of file table.hpp.

get() [4/4]

TOML_NODISCARD const node * table::get ( std::wstring_view  key ) const

inline

Gets the node at a specific key (const overload).

\availability This overload is only available when TOML_ENABLE_WINDOWS_COMPAT is enabled.

Parameters

key	The node's key.

Returns

A pointer to the node at the specified key, or nullptr.

Definition at line 531 of file table.hpp.

get_as() [1/4]

template<typename T >

TOML_PURE_GETTER const impl::wrap_node< T > * table::get_as ( std::string_view  key ) const

inlinenoexcept

Gets the node at a specific key if it is a particular type (const overload).

Template Parameters

T	One of the TOML node or value types.

Parameters

key	The node's key.

Returns

A pointer to the node at the specified key if it was of the given type, or nullptr.

Definition at line 569 of file table.hpp.

get_as() [2/4]

template<typename T >

TOML_PURE_GETTER impl::wrap_node< T > * table::get_as ( std::string_view  key )

inlinenoexcept

Gets the node at a specific key if it is a particular type.

\detail \cpp auto tbl = toml::table{ { "a", 42, }, { "b", "is the meaning of life, apparently." } }; if (auto val = arr.get_as<int64_t>("a")) std::cout << R"(node ["a"] was an integer with value )"sv << **val << "\n"; \ecpp

\out node ["a"] was an integer with value 42 \eout

Template Parameters

T	One of the TOML node or value types.

Parameters

key	The node's key.

Returns

A pointer to the node at the specified key if it was of the given type, or nullptr.

Definition at line 556 of file table.hpp.

get_as() [3/4]

template<typename T >

TOML_NODISCARD impl::wrap_node< T > * table::get_as ( std::wstring_view  key )

inline

Gets the node at a specific key if it is a particular type.

\availability This overload is only available when TOML_ENABLE_WINDOWS_COMPAT is enabled.

Template Parameters

T	One of the TOML node or value types.

Parameters

key	The node's key.

Returns

A pointer to the node at the specified key if it was of the given type, or nullptr.

Definition at line 585 of file table.hpp.

get_as() [4/4]

template<typename T >

TOML_NODISCARD const impl::wrap_node< T > * table::get_as ( std::wstring_view  key ) const

inline

Gets the node at a specific key if it is a particular type (const overload).

\availability This overload is only available when TOML_ENABLE_WINDOWS_COMPAT is enabled.

Template Parameters

T	One of the TOML node or value types.

Parameters

key	The node's key.

Returns

A pointer to the node at the specified key if it was of the given type, or nullptr.

Definition at line 601 of file table.hpp.

if()

table::if ( !ipos->  second )

inline

Definition at line 1286 of file table.hpp.

insert_or_assign()

Iter value_flags bool table::insert_or_assign ( KeyType &&  key, ValueType &&  val, value_flags  flags = preserve_source_value_flags  )

inline

Definition at line 1494 of file table.hpp.

is_array()

TOML_CONST_INLINE_GETTER bool table::is_array ( ) const

inlinefinalnoexcept

Returns false.

Definition at line 293 of file table.hpp.

is_array_of_tables()

TOML_PURE_GETTER bool table::is_array_of_tables ( ) const

inlinefinalnoexcept

Returns false.

Definition at line 297 of file table.hpp.

is_boolean()

TOML_CONST_INLINE_GETTER bool table::is_boolean ( ) const

inlinefinalnoexcept

Returns false.

Definition at line 321 of file table.hpp.

is_date()

TOML_CONST_INLINE_GETTER bool table::is_date ( ) const

inlinefinalnoexcept

Returns false.

Definition at line 325 of file table.hpp.

is_date_time()

TOML_CONST_INLINE_GETTER bool table::is_date_time ( ) const

inlinefinalnoexcept

Returns false.

Definition at line 333 of file table.hpp.

is_floating_point()

TOML_CONST_INLINE_GETTER bool table::is_floating_point ( ) const

inlinefinalnoexcept

Returns false.

Definition at line 313 of file table.hpp.

is_homogeneous() [1/3]

TOML_PURE_GETTER TOML_EXPORTED_MEMBER_FUNCTION bool table::is_homogeneous ( node_type  ntype ) const

finalnoexcept

is_homogeneous() [2/3]

TOML_PURE_GETTER TOML_EXPORTED_MEMBER_FUNCTION bool table::is_homogeneous ( node_type  ntype, const node *&  first_nonmatch  ) const

finalnoexcept

is_homogeneous() [3/3]

TOML_PURE_GETTER TOML_EXPORTED_MEMBER_FUNCTION bool table::is_homogeneous ( node_type  ntype, node *&  first_nonmatch  )

finalnoexcept

is_inline() [1/2]

TOML_PURE_INLINE_GETTER bool table::is_inline ( ) const

inlinenoexcept

Returns true if this table is an inline table.

Remarks

Runtime-constructed tables (i.e. those not created during parsing) are not inline by default.

Definition at line 422 of file table.hpp.

is_inline() [2/2]

void table::is_inline ( bool  val )

inlinenoexcept

Sets whether this table is a TOML inline table.

\detail \godbolt{an9xdj}

\cpp auto tbl = toml::table{ { "a", 1 }, { "b", 2 }, { "c", 3 }, { "d", toml::table{ { "e", 4 } } } }; std::cout << "is inline? "sv << tbl.is_inline() << "\n"; std::cout << tbl << "\n\n";

tbl.is_inline(!tbl.is_inline()); std::cout << "is inline? "sv << tbl.is_inline() << "\n"; std::cout << tbl << "\n"; \ecpp

\out is inline? false a = 1 b = 2 c = 3

[d] e = 4

is inline? true { a = 1, b = 2, c = 3, d = { e = 4 } } \eout

Remarks

A table being 'inline' is only relevent during printing; it has no effect on the general functionality of the table object.

Parameters

val	The new value for 'inline'.

Definition at line 462 of file table.hpp.

is_integer()

TOML_CONST_INLINE_GETTER bool table::is_integer ( ) const

inlinefinalnoexcept

Returns false.

Definition at line 309 of file table.hpp.

is_number()

TOML_CONST_INLINE_GETTER bool table::is_number ( ) const

inlinefinalnoexcept

Returns false.

Definition at line 317 of file table.hpp.

is_string()

TOML_CONST_INLINE_GETTER bool table::is_string ( ) const

inlinefinalnoexcept

Returns false.

Definition at line 305 of file table.hpp.

is_table()

TOML_CONST_INLINE_GETTER bool table::is_table ( ) const

inlinefinalnoexcept

Returns true.

Definition at line 289 of file table.hpp.

is_time()

TOML_CONST_INLINE_GETTER bool table::is_time ( ) const

inlinefinalnoexcept

Returns false.

Definition at line 329 of file table.hpp.

is_value()

TOML_CONST_INLINE_GETTER bool table::is_value ( ) const

inlinefinalnoexcept

Returns false.

Definition at line 301 of file table.hpp.

lower_bound() [1/4]

TOML_PURE_GETTER const_iterator table::lower_bound ( std::string_view  key ) const

inlinenoexcept

Returns a const iterator to the first key-value pair with key that is not less than the given key.

Returns

An iterator to the first matching key-value pair, or end().

Definition at line 957 of file table.hpp.

lower_bound() [2/4]

TOML_PURE_GETTER iterator table::lower_bound ( std::string_view  key )

inlinenoexcept

Returns an iterator to the first key-value pair with key that is not less than the given key.

Returns

An iterator to the first matching key-value pair, or end().

Definition at line 950 of file table.hpp.

lower_bound() [3/4]

TOML_NODISCARD iterator table::lower_bound ( std::wstring_view  key )

inline

Returns an iterator to the first key-value pair with key that is not less than the given key.

\availability This overload is only available when TOML_ENABLE_WINDOWS_COMPAT is enabled.

Returns

An iterator to the first matching key-value pair, or end().

Definition at line 970 of file table.hpp.

lower_bound() [4/4]

TOML_NODISCARD const_iterator table::lower_bound ( std::wstring_view  key ) const

inline

Returns a const iterator to the first key-value pair with key that is not less than the given key.

\availability This overload is only available when TOML_ENABLE_WINDOWS_COMPAT is enabled.

Returns

An iterator to the first matching key-value pair, or end().

Definition at line 983 of file table.hpp.

operator=() [1/2]

TOML_EXPORTED_MEMBER_FUNCTION table & table::operator=

(

const table &

)

Copy-assignment operator.

operator=() [2/2]

TOML_EXPORTED_MEMBER_FUNCTION table & table::operator= ( table &&  rhs )

noexcept

Move-assignment operator.

operator[]() [1/4]

TOML_NODISCARD node_view< const node > table::operator[] ( std::string_view  key ) const

inlinenoexcept

Gets a node_view for the selected value (const overload).

Parameters

key	The key used for the lookup.

Returns

A view of the value at the given key if one existed, or an empty node view.

Remarks

std::map::operator[]'s behaviour of default-constructing a value at a key if it didn't exist is a crazy bug factory so I've deliberately chosen not to emulate it. This is not an error.

See also

toml::node_view

Definition at line 1636 of file table.hpp.

operator[]() [2/4]

TOML_NODISCARD node_view< node > table::operator[] ( std::string_view  key )

inlinenoexcept

Gets a node_view for the selected value.

Parameters

key	The key used for the lookup.

Returns

A view of the value at the given key if one existed, or an empty node view.

Remarks

std::map::operator[]'s behaviour of default-constructing a value at a key if it didn't exist is a crazy bug factory so I've deliberately chosen not to emulate it. This is not an error.

See also

toml::node_view

Definition at line 1622 of file table.hpp.

operator[]() [3/4]

TOML_NODISCARD node_view< node > table::operator[] ( std::wstring_view  key )

inline

Gets a node_view for the selected value.

\availability This overload is only available when TOML_ENABLE_WINDOWS_COMPAT is enabled.

Parameters

key	The key used for the lookup.

Returns

A view of the value at the given key if one existed, or an empty node view.

Remarks

std::map::operator[]'s behaviour of default-constructing a value at a key if it didn't exist is a crazy bug factory so I've deliberately chosen not to emulate it. This is not an error.

See also

toml::node_view

Definition at line 1656 of file table.hpp.

operator[]() [4/4]

TOML_NODISCARD node_view< const node > table::operator[] ( std::wstring_view  key ) const

inline

Gets a node_view for the selected value (const overload).

\availability This overload is only available when TOML_ENABLE_WINDOWS_COMPAT is enabled.

Parameters

key	The key used for the lookup.

Returns

A view of the value at the given key if one existed, or an empty node view.

Remarks

std::map::operator[]'s behaviour of default-constructing a value at a key if it didn't exist is a crazy bug factory so I've deliberately chosen not to emulate it. This is not an error.

See also

toml::node_view

Definition at line 1672 of file table.hpp.

prune() [1/2]

table && table::prune ( bool  recursive = true ) &&

inlinenoexcept

Removes empty child arrays and tables (rvalue overload).

Parameters

recursive

Should child arrays and tables themselves be pruned?

Returns

An rvalue reference to the table.

Definition at line 1215 of file table.hpp.

prune() [2/2]

TOML_EXPORTED_MEMBER_FUNCTION table & table::prune ( bool  recursive = true ) &

noexcept

Removes empty child arrays and tables.

\detail \cpp

auto tbl = toml::table{ { "a", 1 }, { "b", toml::array{ } }, { "c", toml::array{ toml::table{}, toml::array{} } } }; std::cout << arr << "\n";

arr.prune(); std::cout << arr << "\n"; \ecpp

\out { a = 1, b = [], c = [ {}, [] ] } { a = 1 } \eout

Parameters

recursive

Should child arrays and tables themselves be pruned?

Returns

A reference to the table.

size()

TOML_PURE_INLINE_GETTER size_t table::size ( ) const

inlinenoexcept

Returns the number of key-value pairs in the table.

Definition at line 928 of file table.hpp.

TOML_CONSTRAINED_TEMPLATE() [1/4]

table::TOML_CONSTRAINED_TEMPLATE	(	(!is_key_or_convertible< Iter > &&!impl::is_wide_string< Iter >)	,
		typename Iter
	)

Inserts a series of key-value pairs into the table.

\detail \godbolt{bzYcce}

\cpp auto tbl = toml::table{ { "a", 1 }, { "b", 2 }, { "c", 3 } }; std::cout << tbl << "\n";

auto kvps = std::array<std::pair<std::string, int>, 2>{{ { "d", 42 }, { "a", 43 } // won't be inserted, 'a' already exists }}; tbl.insert(kvps.begin(), kvps.end()); std::cout << tbl << "\n"; \ecpp

\out a = 1 b = 2 c = 3

a = 1 b = 2 c = 3 d = 42 \eout

Template Parameters

Iter	An InputIterator to a collection of key-value pairs.

Parameters

begin	An iterator to the first value in the input collection.
end	An iterator to one-past-the-last value in the input collection.
flags	Value flags to apply to new values.

Remarks

This function is morally equivalent to calling insert(key, value) for each key-value pair covered by the iterator range, so any values with keys already found in the table will not be replaced.

TOML_CONSTRAINED_TEMPLATE() [2/4]

table::TOML_CONSTRAINED_TEMPLATE ( (is_key_or_convertible< KeyType && >||impl::is_wide_string< KeyType >)  , typename KeyType  , typename ValueType    )

inline

Inserts a new value at a specific key if one did not already exist.

\detail \godbolt{bMnW5r}

\cpp auto tbl = toml::table{ { "a", 1 }, { "b", 2 }, { "c", 3 } }; std::cout << tbl << "\n";

for (auto k : { "a", "d" }) { auto result = tbl.insert(k, 42); std::cout << "inserted with key '"sv << k << "': "sv << result.second << "\n"; } std::cout << tbl << "\n"; \ecpp

\out a = 1 b = 2 c = 3

inserted with key 'a': false inserted with key 'd': true a = 1 b = 2 c = 3 d = 42 \eout

Template Parameters

KeyType	A toml::key or any compatible string type.
ValueType	toml::node, toml::node_view, toml::table, toml::array, or a native TOML value type (or a type promotable to one).

Parameters

key	The key at which to insert the new value.
val	The new value to insert.
flags	Value flags to apply to new values.

Returns

\conditional_return{Valid input}

• An iterator to the insertion position (or the position of the value that prevented insertion)
• A boolean indicating if the insertion was successful.

\conditional_return{Input is a null toml::node_view} { end(), false }

Attention

The return value will always be { end(), false } if the input value was an null toml::node_view, because no insertion can take place. This is the only circumstance in which this can occur.

Definition at line 1358 of file table.hpp.

TOML_CONSTRAINED_TEMPLATE() [3/4]

table::TOML_CONSTRAINED_TEMPLATE	(	(is_key_or_convertible< KeyType && >||impl::is_wide_string< KeyType >)	,
		typename ValueType	= void,
		typename KeyType	,
		typename...	ValueArgs
	)

Emplaces a new value at a specific key if one did not already exist.

Template Parameters

ValueType	toml::table, toml::array, or any native TOML value type.
KeyType	A toml::key or any compatible string type.
ValueArgs	Value constructor argument types.

Parameters

hint	Iterator to the position before which the new element will be emplaced.
key	The key at which to emplace the new value.
args	Arguments to forward to the value's constructor.

Returns

An iterator to the emplacement position (or the position of the value that prevented emplacement)

Note

This function has exactly the same semantics as std::map::emplace_hint().

TOML_CONSTRAINED_TEMPLATE() [4/4]

table::TOML_CONSTRAINED_TEMPLATE ( (is_key_or_convertible< KeyType && >||impl::is_wide_string< KeyType >)  , typename ValueType  = void, typename KeyType  , typename...  ValueArgs  )

inline

Emplaces a new value at a specific key if one did not already exist.

\detail \cpp auto tbl = toml::table{ { "a", 1 }, { "b", 2 }, { "c", 3 } }; std::cout << tbl << "\n";

for (auto k : { "a", "d" }) { // add a string using std::string's substring constructor auto result = tbl.emplace<std::string>(k, "this is not a drill"sv, 14, 5); std::cout << "emplaced with key '"sv << k << "': "sv << result.second << "\n"; } std::cout << tbl << "\n"; \ecpp

\out { a = 1, b = 2, c = 3 } emplaced with key 'a': false emplaced with key 'd': true { a = 1, b = 2, c = 3, d = "drill" } \eout

Template Parameters

ValueType	toml::table, toml::array, or any native TOML value type.
KeyType	A toml::key or any compatible string type.
ValueArgs	Value constructor argument types.

Parameters

key	The key at which to emplace the new value.
args	Arguments to forward to the value's constructor.

Returns

A std::pair containing:

• An iterator to the emplacement position (or the position of the value that prevented emplacement)
• A boolean indicating if the emplacement was successful.

Remarks

There is no difference between insert() and emplace() for trivial value types (floats, ints, bools).

Definition at line 1564 of file table.hpp.

type()

TOML_CONST_INLINE_GETTER node_type table::type ( ) const

inlinefinalnoexcept

Returns #toml::node_type::table.

Definition at line 261 of file table.hpp.

Friends And Related Symbol Documentation

operator!=

TOML_NODISCARD friend bool operator!= ( const table &  lhs, const table &  rhs  )

friend

Inequality operator.

Parameters

lhs	The LHS table.
rhs	The RHS table.

Returns

True if the tables did not contain the same keys and map.

Definition at line 1708 of file table.hpp.

operator<<

std::ostream & operator<< ( std::ostream &  lhs, const table &  rhs  )

friend

Prints the table out to a stream as formatted TOML.

\availability This operator is only available when TOML_ENABLE_FORMATTERS is enabled.

Definition at line 1717 of file table.hpp.

operator==

TOML_NODISCARD friend bool operator== ( const table &  lhs, const table &  rhs  )

friend

Equality operator.

Parameters

lhs	The LHS table.
rhs	The RHS table.

Returns

True if the tables contained the same keys and map.

Definition at line 1699 of file table.hpp.

Field Documentation

args

KeyType ValueArgs&& table::args

Initial value:

{
      static_assert(!impl::is_wide_string<KeyType> || TOML_ENABLE_WINDOWS_COMPAT,
                    "Emplacement using wide-character keys is only supported on Windows with "
                    "TOML_ENABLE_WINDOWS_COMPAT enabled.")

Definition at line 1253 of file table.hpp.

else

table::else

Initial value:

{
        static constexpr auto moving_node_ptr =
            std::is_same_v<value_type, impl::node_ptr>  
            && sizeof...(ValueArgs) == 1u               
            && impl::first_is_same<impl::node_ptr&&, ValueArgs&&...>

Definition at line 1269 of file table.hpp.

end

Iter table::end

Definition at line 1430 of file table.hpp.

flags

Iter value_flags table::flags

Initial value:

= preserve_source_value_flags) {
      if (begin == end) return;
      for (auto it = begin; it != end; it++) {
        if constexpr (std::is_rvalue_reference_v<decltype(*it)>)
          insert(std::move((*it).first), std::move((*it).second), flags);
        else
          insert((*it).first, (*it).second, flags);
      }
    }
 
    
    TOML_CONSTRAINED_TEMPLATE((is_key_or_convertible<KeyType&&> || impl::is_wide_string<KeyType>),
                              typename KeyType, typename ValueType)
    std::pair<iterator

Definition at line 1430 of file table.hpp.

ipos

map_iterator table::ipos = insert_with_hint(hint, toml::key{static_cast<KeyType&&>(key)}, nullptr)

Definition at line 1282 of file table.hpp.

iterator

return table::iterator {ipos}

Definition at line 1303 of file table.hpp.

key

KeyType&& table::key

Definition at line 1253 of file table.hpp.

---

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

• EXTERNAL_HEADERS/nebld/private/vendor/toml++/impl/table.hpp