Technology-independent serialization interface. More...

#include <serializer.hpp>

Inheritance diagram for caf::serializer:

Public Types
using	super = save_inspector_base<serializer>

Public Member Functions
	serializer (actor_system &sys) noexcept

actor_system *	context () const noexcept

bool	has_human_readable_format () const noexcept

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

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

virtual bool	begin_field (std::string_view)=0

virtual bool	begin_field (std::string_view name, bool is_present)=0

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

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

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

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

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

virtual bool	value (bool x)=0
	Adds `x` to the output.

virtual bool	value (int8_t x)=0
	Adds `x` to the output.

virtual bool	value (uint8_t x)=0
	Adds `x` to the output.

virtual bool	value (int16_t x)=0
	Adds `x` to the output.

virtual bool	value (uint16_t x)=0
	Adds `x` to the output.

virtual bool	value (int32_t x)=0
	Adds `x` to the output.

virtual bool	value (uint32_t x)=0
	Adds `x` to the output.

virtual bool	value (int64_t x)=0
	Adds `x` to the output.

virtual bool	value (uint64_t x)=0
	Adds `x` to the output.

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

virtual bool	value (float x)=0
	Adds `x` to the output.

virtual bool	value (double x)=0
	Adds `x` to the output.

virtual bool	value (long double x)=0
	Adds `x` to the output.

virtual bool	value (std::string_view x)=0
	Adds `x` to the output.

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

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

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

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

Protected Attributes
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

Technology-independent serialization interface.

Member Function Documentation

◆ begin_associative_array()

bool caf::serializer::begin_associative_array ( size_t size )

virtual

Begins processing of an associative array (map).

Note: the default implementation calls begin_sequence(size).

Reimplemented in caf::config_value_writer, caf::json_builder, and caf::json_writer.

◆ begin_key_value_pair()

bool caf::serializer::begin_key_value_pair ( )

virtual

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 in caf::config_value_writer, caf::json_builder, and caf::json_writer.

◆ begin_object()

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

pure virtual

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.

Implemented in caf::config_value_writer, caf::json_builder, and caf::json_writer.

◆ begin_sequence()

virtual bool caf::serializer::begin_sequence ( size_t size )

pure virtual

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

Implemented in caf::config_value_writer, caf::json_builder, and caf::json_writer.

◆ begin_tuple()

virtual bool caf::serializer::begin_tuple ( size_t size )

pure virtual

Begins processing of a tuple.

Implemented in caf::config_value_writer, caf::json_builder, and caf::json_writer.

◆ end_associative_array()

bool caf::serializer::end_associative_array ( )

virtual

Ends processing of an associative array (map).

Note: the default implementation calls end_sequence().

Reimplemented in caf::config_value_writer, caf::json_builder, and caf::json_writer.

◆ end_key_value_pair()

bool caf::serializer::end_key_value_pair ( )

virtual

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

Note: the default implementation calls end_tuple().

Reimplemented in caf::config_value_writer, caf::json_builder, and caf::json_writer.

◆ end_object()

virtual bool caf::serializer::end_object ( )

pure virtual

Ends processing of an object.

Implemented in caf::config_value_writer, caf::json_builder, and caf::json_writer.

◆ end_sequence()

virtual bool caf::serializer::end_sequence ( )

pure virtual

Ends processing of a sequence.

Implemented in caf::config_value_writer, caf::json_builder, and caf::json_writer.

◆ end_tuple()

virtual bool caf::serializer::end_tuple ( )

pure virtual

Ends processing of a tuple.

Implemented in caf::config_value_writer, caf::json_builder, and caf::json_writer.

◆ list()

bool caf::serializer::list ( const std::vector< bool > & xs )

virtual

Adds each boolean in xs to the output.

Derived classes can override this member function to pack the booleans, for example to avoid using one byte for each value in a binary output format.

◆ value() [1/18]

virtual bool caf::serializer::value ( bool x )

pure virtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implemented in caf::config_value_writer, caf::json_builder, and caf::json_writer.

◆ value() [2/18]

virtual bool caf::serializer::value ( const std::u16string & x )

pure virtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implemented in caf::config_value_writer, caf::json_builder, and caf::json_writer.

◆ value() [3/18]

virtual bool caf::serializer::value ( const std::u32string & x )

pure virtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implemented in caf::config_value_writer, caf::json_builder, and caf::json_writer.

◆ value() [4/18]

virtual bool caf::serializer::value ( double x )

pure virtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implemented in caf::config_value_writer, caf::json_builder, and caf::json_writer.

◆ value() [5/18]

virtual bool caf::serializer::value ( float x )

pure virtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implemented in caf::config_value_writer, caf::json_builder, and caf::json_writer.

◆ value() [6/18]

virtual bool caf::serializer::value ( int16_t x )

pure virtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implemented in caf::config_value_writer, caf::json_builder, and caf::json_writer.

◆ value() [7/18]

virtual bool caf::serializer::value ( int32_t x )

pure virtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implemented in caf::config_value_writer, caf::json_builder, and caf::json_writer.

◆ value() [8/18]

virtual bool caf::serializer::value ( int64_t x )

pure virtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implemented in caf::config_value_writer, caf::json_builder, and caf::json_writer.

◆ value() [9/18]

virtual bool caf::serializer::value ( int8_t x )

pure virtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implemented in caf::config_value_writer, caf::json_builder, and caf::json_writer.

◆ value() [10/18]

virtual bool caf::serializer::value ( long double x )

pure virtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implemented in caf::config_value_writer, caf::json_builder, and caf::json_writer.

◆ value() [11/18]

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

pure virtual

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.

Implemented in caf::config_value_writer, caf::json_builder, and caf::json_writer.

◆ value() [12/18]

virtual bool caf::serializer::value ( std::byte x )

pure virtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implemented in caf::config_value_writer, caf::json_builder, and caf::json_writer.

◆ value() [13/18]

virtual bool caf::serializer::value ( std::string_view x )

pure virtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implemented in caf::config_value_writer, caf::json_builder, and caf::json_writer.

◆ value() [14/18]

template<class T >

std::enable_if_t< std::is_integral_v< T >, bool > caf::serializer::value ( T x )

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

◆ value() [15/18]

virtual bool caf::serializer::value ( uint16_t x )

pure virtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implemented in caf::config_value_writer, caf::json_builder, and caf::json_writer.

◆ value() [16/18]

virtual bool caf::serializer::value ( uint32_t x )

pure virtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implemented in caf::config_value_writer, caf::json_builder, and caf::json_writer.

◆ value() [17/18]

virtual bool caf::serializer::value ( uint64_t x )

pure virtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implemented in caf::config_value_writer, caf::json_builder, and caf::json_writer.

◆ value() [18/18]

virtual bool caf::serializer::value ( uint8_t x )

pure virtual

Adds x to the output.

Parameters

x	A value for a builtin type.

Returns: true on success, false otherwise.

Implemented in caf::config_value_writer, caf::json_builder, and caf::json_writer.

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

libcaf_core/caf/serializer.hpp
libcaf_core/caf/serializer.cpp

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ begin_associative_array()

◆ begin_key_value_pair()

◆ begin_object()

◆ begin_sequence()

◆ begin_tuple()

◆ end_associative_array()

◆ end_key_value_pair()

◆ end_object()

◆ end_sequence()

◆ end_tuple()

◆ list()

◆ value() [1/18]

◆ value() [2/18]

◆ value() [3/18]

◆ value() [4/18]

◆ value() [5/18]

◆ value() [6/18]

◆ value() [7/18]

◆ value() [8/18]

◆ value() [9/18]

◆ value() [10/18]

◆ value() [11/18]

◆ value() [12/18]

◆ value() [13/18]

◆ value() [14/18]

◆ value() [15/18]

◆ value() [16/18]

◆ value() [17/18]

◆ value() [18/18]