Extracts objects from a config_value. More...

#include <config_value_reader.hpp>

Inheritance diagram for caf::config_value_reader:

Public Types
using	super = deserializer

using	key_ptr = const std::string *

using	value_type = variant< const settings , const config_value , key_ptr, absent_field, sequence, associative_array >

using	stack_type = std::stack< value_type, std::vector< value_type > >

Public Types inherited from caf::deserializer
using	super = load_inspector_base< deserializer >

Public Member Functions
	config_value_reader (const config_value *input, actor_system &sys)

	config_value_reader (const config_value input, execution_unit ctx)

	config_value_reader (const config_value *input)

	config_value_reader (const config_value_reader &)=delete

config_value_reader &	operator= (const config_value_reader &)=delete

value_type &	top ()

void	pop ()

bool	fetch_next_object_type (type_id_t &type) override
	Reads run-time-type information for the next object if available.

bool	begin_object (type_id_t type, string_view name) override
	Begins processing of an object, may perform a type check depending on the data format.

bool	end_object () override
	Ends processing of an object.

bool	begin_field (string_view) override

bool	begin_field (string_view name, bool &is_present) override

bool	begin_field (string_view name, span< const type_id_t > types, size_t &index) override

bool	begin_field (string_view name, bool &is_present, span< const type_id_t > types, size_t &index) override

bool	end_field () override

bool	begin_tuple (size_t size) override
	Begins processing of a fixed-size sequence.

bool	end_tuple () override
	Ends processing of a sequence.

bool	begin_key_value_pair () override
	Begins processing of a tuple with two elements, whereas the first element represents the key in an associative array.

bool	end_key_value_pair () override
	Ends processing of a key-value pair after both values were written.

bool	begin_sequence (size_t &size) override
	Begins processing of a sequence.

bool	end_sequence () override
	Ends processing of a sequence.

bool	begin_associative_array (size_t &size) override
	Begins processing of an associative array (map).

bool	end_associative_array () override
	Ends processing of an associative array (map).

bool	value (byte &x) override
	Reads `x` from the input.

bool	value (bool &x) override
	Reads `x` from the input.

bool	value (int8_t &x) override
	Reads `x` from the input.

bool	value (uint8_t &x) override
	Reads `x` from the input.

bool	value (int16_t &x) override
	Reads `x` from the input.

bool	value (uint16_t &x) override
	Reads `x` from the input.

bool	value (int32_t &x) override
	Reads `x` from the input.

bool	value (uint32_t &x) override
	Reads `x` from the input.

bool	value (int64_t &x) override
	Reads `x` from the input.

bool	value (uint64_t &x) override
	Reads `x` from the input.

bool	value (float &x) override
	Reads `x` from the input.

bool	value (double &x) override
	Reads `x` from the input.

bool	value (long double &x) override
	Reads `x` from the input.

bool	value (std::string &x) override
	Reads `x` from the input.

bool	value (std::u16string &x) override
	Reads `x` from the input.

bool	value (std::u32string &x) override
	Reads `x` from the input.

bool	value (span< byte > x) override
	Reads a byte sequence from the input.

Public Member Functions inherited from caf::deserializer
	deserializer (actor_system &sys) noexcept

	deserializer (execution_unit *ctx=nullptr) noexcept

auto	context () const noexcept

bool	has_human_readable_format () const noexcept

virtual bool	fetch_next_object_type (type_id_t &type)=0
	Reads run-time-type information for the next object if available.

virtual bool	fetch_next_object_name (string_view &type_name)
	Reads run-time-type information for the next object if available.

bool	next_object_name_matches (string_view type_name)
	Convenience function for querying `fetch_next_object_name` comparing the result to `type_name` in one shot.

bool	assert_next_object_name (string_view type_name)
	Like `next_object_name_matches`, but sets an error on the deserializer on a mismatch.

virtual bool	begin_object (type_id_t type, string_view pretty_class_name)=0
	Begins processing of an object, may perform a type check depending on the data format.

virtual bool	end_object ()=0
	Ends processing of an object.

virtual bool	begin_field (string_view name)=0

virtual bool	begin_field (string_view, bool &is_present)=0

virtual bool	begin_field (string_view name, span< const type_id_t > types, size_t &index)=0

virtual bool	begin_field (string_view name, bool &is_present, span< const type_id_t > types, size_t &index)=0

virtual bool	end_field ()=0

virtual bool	begin_tuple (size_t size)=0
	Begins processing of a fixed-size sequence.

virtual bool	end_tuple ()=0
	Ends processing of a sequence.

virtual bool	begin_key_value_pair ()
	Begins processing of a tuple with two elements, whereas the first element represents the key in an associative array.

virtual bool	end_key_value_pair ()
	Ends processing of a key-value pair after both values were written.

virtual bool	begin_sequence (size_t &size)=0
	Begins processing of a sequence.

virtual bool	end_sequence ()=0
	Ends processing of a sequence.

virtual bool	begin_associative_array (size_t &size)
	Begins processing of an associative array (map).

virtual bool	end_associative_array ()
	Ends processing of an associative array (map).

virtual bool	value (byte &x)=0
	Reads `x` from the input.

virtual bool	value (bool &x)=0
	Reads `x` from the input.

virtual bool	value (int8_t &)=0
	Reads `x` from the input.

virtual bool	value (uint8_t &)=0
	Reads `x` from the input.

virtual bool	value (int16_t &)=0
	Reads `x` from the input.

virtual bool	value (uint16_t &)=0
	Reads `x` from the input.

virtual bool	value (int32_t &)=0
	Reads `x` from the input.

virtual bool	value (uint32_t &)=0
	Reads `x` from the input.

virtual bool	value (int64_t &)=0
	Reads `x` from the input.

virtual bool	value (uint64_t &)=0
	Reads `x` from the input.

template<class T >
std::enable_if_t< std::is_integral< T >::value, bool >	value (T &x) noexcept
	Reads `x` from the input.

virtual bool	value (float &)=0
	Reads `x` from the input.

virtual bool	value (double &)=0
	Reads `x` from the input.

virtual bool	value (long double &)=0
	Reads `x` from the input.

virtual bool	value (std::string &)=0
	Reads `x` from the input.

virtual bool	value (std::u16string &)=0
	Reads `x` from the input.

virtual bool	value (std::u32string &)=0
	Reads `x` from the input.

virtual bool	value (span< byte > x)=0
	Reads a byte sequence from the input.

virtual bool	list (std::vector< bool > &xs)
	Adds each boolean in `xs` to the output.

Additional Inherited Members
Protected Attributes inherited from caf::deserializer
execution_unit *	context_
	Provides access to the ::proxy_registry and to the ::actor_system.

bool	has_human_readable_format_ = false
	Configures whether client code should assume human-readable output.

Detailed Description

Extracts objects from a config_value.

Member Function Documentation

◆ begin_associative_array()

bool caf::config_value_reader::begin_associative_array ( size_t & size )

overridevirtual

Begins processing of an associative array (map).

Note: the default implementation calls begin_sequence(size).

Reimplemented from caf::deserializer.

◆ begin_field() [1/4]

bool caf::config_value_reader::begin_field	(	string_view	name,
		bool &	is_present
	)

overridevirtual

Implements caf::deserializer.

◆ begin_field() [2/4]

bool caf::config_value_reader::begin_field	(	string_view	name,
		bool &	is_present,
		span< const type_id_t >	types,
		size_t &	index
	)

overridevirtual

Implements caf::deserializer.

◆ begin_field() [3/4]

bool caf::config_value_reader::begin_field	(	string_view	name,
		span< const type_id_t >	types,
		size_t &	index
	)

overridevirtual

Implements caf::deserializer.

◆ begin_field() [4/4]

bool caf::config_value_reader::begin_field ( string_view )

overridevirtual

Implements caf::deserializer.

◆ begin_key_value_pair()

bool caf::config_value_reader::begin_key_value_pair ( )

overridevirtual

Begins processing of a tuple with two elements, whereas the first element represents the key in an associative array.

Note: the default implementation calls begin_tuple(2).

Reimplemented from caf::deserializer.

◆ begin_object()

bool caf::config_value_reader::begin_object	(	type_id_t	type,
		string_view	pretty_class_name
	)

overridevirtual

Begins processing of an object, may perform a type check depending on the data format.

Parameters

type	16-bit ID for known types, invalid_type_id otherwise.
pretty_class_name	Either the output of type_name_or_anonymous or the optionally defined pretty name.

Implements caf::deserializer.

◆ begin_sequence()

bool caf::config_value_reader::begin_sequence ( size_t & size )

overridevirtual

Begins processing of a sequence.

Implements caf::deserializer.

◆ begin_tuple()

bool caf::config_value_reader::begin_tuple ( size_t size )

overridevirtual

Begins processing of a fixed-size sequence.

Implements caf::deserializer.

◆ end_associative_array()

bool caf::config_value_reader::end_associative_array ( )

overridevirtual

Ends processing of an associative array (map).

Note: the default implementation calls end_sequence().

Reimplemented from caf::deserializer.

◆ end_field()

bool caf::config_value_reader::end_field ( )

overridevirtual

Implements caf::deserializer.

◆ end_key_value_pair()

bool caf::config_value_reader::end_key_value_pair ( )

overridevirtual

Ends processing of a key-value pair after both values were written.

Note: the default implementation calls end_tuple().

Reimplemented from caf::deserializer.

◆ end_object()

bool caf::config_value_reader::end_object ( )

overridevirtual

Ends processing of an object.

Implements caf::deserializer.

◆ end_sequence()

bool caf::config_value_reader::end_sequence ( )

overridevirtual

Ends processing of a sequence.

Implements caf::deserializer.

◆ end_tuple()

bool caf::config_value_reader::end_tuple ( )

overridevirtual

Ends processing of a sequence.

Implements caf::deserializer.

◆ fetch_next_object_type()

bool caf::config_value_reader::fetch_next_object_type ( type_id_t & type )

overridevirtual

Reads run-time-type information for the next object if available.

Implements caf::deserializer.

◆ value() [1/17]

bool caf::config_value_reader::value ( bool & x )

overridevirtual

Reads x from the input.

Parameters

x	A reference to a builtin type.

Returns: true on success, false otherwise.

Implements caf::deserializer.

◆ value() [2/17]

bool caf::config_value_reader::value ( byte & x )

overridevirtual

Reads x from the input.

Parameters

x	A reference to a builtin type.

Returns: true on success, false otherwise.

Implements caf::deserializer.

◆ value() [3/17]

bool caf::config_value_reader::value ( double & )

overridevirtual

Reads x from the input.

Parameters

x	A reference to a builtin type.

Returns: true on success, false otherwise.

Implements caf::deserializer.

◆ value() [4/17]

bool caf::config_value_reader::value ( float & )

overridevirtual

Reads x from the input.

Parameters

x	A reference to a builtin type.

Returns: true on success, false otherwise.

Implements caf::deserializer.

◆ value() [5/17]

bool caf::config_value_reader::value ( int16_t & )

overridevirtual

Reads x from the input.

Parameters

x	A reference to a builtin type.

Returns: true on success, false otherwise.

Implements caf::deserializer.

◆ value() [6/17]

bool caf::config_value_reader::value ( int32_t & )

overridevirtual

Reads x from the input.

Parameters

x	A reference to a builtin type.

Returns: true on success, false otherwise.

Implements caf::deserializer.

◆ value() [7/17]

bool caf::config_value_reader::value ( int64_t & )

overridevirtual

Reads x from the input.

Parameters

x	A reference to a builtin type.

Returns: true on success, false otherwise.

Implements caf::deserializer.

◆ value() [8/17]

bool caf::config_value_reader::value ( int8_t & )

overridevirtual

Reads x from the input.

Parameters

x	A reference to a builtin type.

Returns: true on success, false otherwise.

Implements caf::deserializer.

◆ value() [9/17]

bool caf::config_value_reader::value ( long double & )

overridevirtual

Reads x from the input.

Parameters

x	A reference to a builtin type.

Returns: true on success, false otherwise.

Implements caf::deserializer.

◆ value() [10/17]

bool caf::config_value_reader::value ( span< byte > x )

overridevirtual

Reads a byte sequence from the input.

Parameters

x	The byte sequence.

Returns: A non-zero error code on failure, sec::success otherwise.

Implements caf::deserializer.

◆ value() [11/17]

bool caf::config_value_reader::value ( std::string & )

overridevirtual

Reads x from the input.

Parameters

x	A reference to a builtin type.

Returns: true on success, false otherwise.

Implements caf::deserializer.

◆ value() [12/17]

bool caf::config_value_reader::value ( std::u16string & )

overridevirtual

Reads x from the input.

Parameters

x	A reference to a builtin type.

Returns: true on success, false otherwise.

Implements caf::deserializer.

◆ value() [13/17]

bool caf::config_value_reader::value ( std::u32string & )

overridevirtual

Reads x from the input.

Parameters

x	A reference to a builtin type.

Returns: true on success, false otherwise.

Implements caf::deserializer.

◆ value() [14/17]

bool caf::config_value_reader::value ( uint16_t & )

overridevirtual

Reads x from the input.

Parameters

x	A reference to a builtin type.

Returns: true on success, false otherwise.

Implements caf::deserializer.

◆ value() [15/17]

bool caf::config_value_reader::value ( uint32_t & )

overridevirtual

Reads x from the input.

Parameters

x	A reference to a builtin type.

Returns: true on success, false otherwise.

Implements caf::deserializer.

◆ value() [16/17]

bool caf::config_value_reader::value ( uint64_t & )

overridevirtual

Reads x from the input.

Parameters

x	A reference to a builtin type.

Returns: true on success, false otherwise.

Implements caf::deserializer.

◆ value() [17/17]

bool caf::config_value_reader::value ( uint8_t & )

overridevirtual

Reads x from the input.

Parameters

x	A reference to a builtin type.

Returns: true on success, false otherwise.

Implements caf::deserializer.

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

libcaf_core/caf/config_value_reader.hpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ begin_associative_array()

◆ begin_field() [1/4]

◆ begin_field() [2/4]

◆ begin_field() [3/4]

◆ begin_field() [4/4]

◆ begin_key_value_pair()

◆ begin_object()

◆ begin_sequence()

◆ begin_tuple()

◆ end_associative_array()

◆ end_field()

◆ end_key_value_pair()

◆ end_object()

◆ end_sequence()

◆ end_tuple()

◆ fetch_next_object_type()

◆ value() [1/17]

◆ value() [2/17]

◆ value() [3/17]

◆ value() [4/17]

◆ value() [5/17]

◆ value() [6/17]

◆ value() [7/17]

◆ value() [8/17]

◆ value() [9/17]

◆ value() [10/17]

◆ value() [11/17]

◆ value() [12/17]

◆ value() [13/17]

◆ value() [14/17]

◆ value() [15/17]

◆ value() [16/17]

◆ value() [17/17]