Serializes an inspectable object to a json_value. More...

#include <json_builder.hpp>

Inheritance diagram for caf::json_builder:

Public Types
using	super = serializer

using	type = json_writer::type

Public Types inherited from caf::serializer
using	super = save_inspector_base<serializer>

Public Member Functions
	json_builder (actor_system &sys)

	json_builder (const json_builder &)=delete

json_builder &	operator= (const json_builder &)=delete

bool	skip_empty_fields () const noexcept
	Returns whether the writer omits empty fields entirely (true) or renders empty fields as `$field: null` (false).

void	skip_empty_fields (bool value) noexcept
	Configures whether the writer omits empty fields.

bool	skip_object_type_annotation () const noexcept
	Returns whether the writer omits '@type' annotations for JSON objects.

void	skip_object_type_annotation (bool value) noexcept
	Configures whether the writer omits '@type' annotations for JSON objects.

std::string_view	field_type_suffix () const noexcept
	Returns the suffix for generating type annotation fields for variant fields.

void	field_type_suffix (std::string_view suffix) noexcept
	Configures whether the writer omits empty fields.

void	reset ()
	Restores the writer to its initial state.

json_value	seal ()
	Seals the JSON value, i.e., rendering it immutable, and returns it.

bool	begin_object (type_id_t type, std::string_view name) override
	Begins processing of an object.

bool	end_object () override
	Ends processing of an object.

bool	begin_field (std::string_view) override

bool	begin_field (std::string_view name, bool is_present) override

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

bool	begin_field (std::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 tuple.

bool	end_tuple () override
	Ends processing of a tuple.

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. Saves the size to the underlying storage.

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 (std::byte x) override
	Adds `x` to the output.

bool	value (bool x) override
	Adds `x` to the output.

bool	value (int8_t x) override
	Adds `x` to the output.

bool	value (uint8_t x) override
	Adds `x` to the output.

bool	value (int16_t x) override
	Adds `x` to the output.

bool	value (uint16_t x) override
	Adds `x` to the output.

bool	value (int32_t x) override
	Adds `x` to the output.

bool	value (uint32_t x) override
	Adds `x` to the output.

bool	value (int64_t x) override
	Adds `x` to the output.

bool	value (uint64_t x) override
	Adds `x` to the output.

bool	value (float x) override
	Adds `x` to the output.

bool	value (double x) override
	Adds `x` to the output.

bool	value (long double x) override
	Adds `x` to the output.

bool	value (std::string_view x) override
	Adds `x` to the output.

bool	value (const std::u16string &x) override
	Adds `x` to the output.

bool	value (const std::u32string &x) override
	Adds `x` to the output.

bool	value (span< const std::byte > x) override
	Adds `x` as raw byte block to the output.

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

actor_system *	context () const noexcept

bool	has_human_readable_format () const noexcept

template<class T >
std::enable_if_t< std::is_integral_v< T >, bool >	value (T x)
	Adds `x` to the output.

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

Additional Inherited Members
Protected Attributes inherited from caf::serializer
actor_system *	context_ = nullptr
	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

Serializes an inspectable object to a json_value.

Member Function Documentation

◆ begin_associative_array()

bool caf::json_builder::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::serializer.

◆ begin_field() [1/4]

bool caf::json_builder::begin_field	(	std::string_view	name,
		bool	is_present )

overridevirtual

Implements caf::serializer.

◆ begin_field() [2/4]

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

overridevirtual

Implements caf::serializer.

◆ begin_field() [3/4]

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

overridevirtual

Implements caf::serializer.

◆ begin_field() [4/4]

bool caf::json_builder::begin_field ( std::string_view name )

overridevirtual

Implements caf::serializer.

◆ begin_key_value_pair()

bool caf::json_builder::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::serializer.

◆ begin_object()

bool caf::json_builder::begin_object	(	type_id_t	type,
		std::string_view	name )

overridevirtual

Begins processing of an object.

May save the type information to the underlying storage to allow a deserializer to retrieve and check the type information for data formats that provide deserialization.

Implements caf::serializer.

◆ begin_sequence()

bool caf::json_builder::begin_sequence ( size_t size )

overridevirtual

Begins processing of a sequence. Saves the size to the underlying storage.

Implements caf::serializer.

◆ begin_tuple()

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

overridevirtual

Begins processing of a tuple.

Implements caf::serializer.

◆ end_associative_array()

bool caf::json_builder::end_associative_array ( )

overridevirtual

Ends processing of an associative array (map).

Note: the default implementation calls end_sequence().

Reimplemented from caf::serializer.

◆ end_field()

bool caf::json_builder::end_field ( )

overridevirtual

Implements caf::serializer.

◆ end_key_value_pair()

bool caf::json_builder::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::serializer.

◆ end_object()

bool caf::json_builder::end_object ( )

overridevirtual

Ends processing of an object.

Implements caf::serializer.

◆ end_sequence()

bool caf::json_builder::end_sequence ( )

overridevirtual

Ends processing of a sequence.

Implements caf::serializer.

◆ end_tuple()

bool caf::json_builder::end_tuple ( )

overridevirtual

Ends processing of a tuple.

Implements caf::serializer.

◆ field_type_suffix()

std::string_view caf::json_builder::field_type_suffix ( ) const

nodiscardnoexcept

Returns the suffix for generating type annotation fields for variant fields.

For example, CAF inserts field called "@foo${field_type_suffix}" for a variant field called "foo".

◆ seal()

json_value caf::json_builder::seal ( )

Seals the JSON value, i.e., rendering it immutable, and returns it.

After calling this member function, the json_builder is in a moved-from state and users may only call reset to start a new building process or destroy this instance.

◆ value() [1/17]

bool caf::json_builder::value ( bool x )

overridevirtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implements caf::serializer.

◆ value() [2/17]

bool caf::json_builder::value ( const std::u16string & x )

overridevirtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implements caf::serializer.

◆ value() [3/17]

bool caf::json_builder::value ( const std::u32string & x )

overridevirtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implements caf::serializer.

◆ value() [4/17]

bool caf::json_builder::value ( double x )

overridevirtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implements caf::serializer.

◆ value() [5/17]

bool caf::json_builder::value ( float x )

overridevirtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implements caf::serializer.

◆ value() [6/17]

bool caf::json_builder::value ( int16_t x )

overridevirtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implements caf::serializer.

◆ value() [7/17]

bool caf::json_builder::value ( int32_t x )

overridevirtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implements caf::serializer.

◆ value() [8/17]

bool caf::json_builder::value ( int64_t x )

overridevirtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implements caf::serializer.

◆ value() [9/17]

bool caf::json_builder::value ( int8_t x )

overridevirtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implements caf::serializer.

◆ value() [10/17]

bool caf::json_builder::value ( long double x )

overridevirtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implements caf::serializer.

◆ value() [11/17]

bool caf::json_builder::value ( span< const std::byte > x )

overridevirtual

Adds x as raw byte block to the output.

Parameters

x	The byte sequence.

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

Implements caf::serializer.

◆ value() [12/17]

bool caf::json_builder::value ( std::byte x )

overridevirtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implements caf::serializer.

◆ value() [13/17]

bool caf::json_builder::value ( std::string_view x )

overridevirtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implements caf::serializer.

◆ value() [14/17]

bool caf::json_builder::value ( uint16_t x )

overridevirtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implements caf::serializer.

◆ value() [15/17]

bool caf::json_builder::value ( uint32_t x )

overridevirtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implements caf::serializer.

◆ value() [16/17]

bool caf::json_builder::value ( uint64_t x )

overridevirtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implements caf::serializer.

◆ value() [17/17]

bool caf::json_builder::value ( uint8_t x )

overridevirtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implements caf::serializer.

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

libcaf_core/caf/json_builder.hpp
libcaf_core/caf/json_builder.cpp

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

◆ field_type_suffix()

◆ seal()

◆ 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]