#include <JsonWriter.h>

Inheritance diagram for zserio::BasicJsonWriter< ALLOC >:

[legend]

Collaboration diagram for zserio::BasicJsonWriter< ALLOC >:

[legend]

Public Types
enum class	EnumerableFormat { NUMBER , STRING }

Public Types inherited from zserio::AllocatorHolder< ALLOC, EMPTY >
using	allocator_type = ALLOC

Public Member Functions
	BasicJsonWriter (std::ostream &out, const ALLOC &allocator=ALLOC())

	BasicJsonWriter (std::ostream &out, uint8_t indent, const ALLOC &allocator=ALLOC())

	BasicJsonWriter (std::ostream &out, const BasicString< RebindAlloc< ALLOC, char > > &indent, const ALLOC &allocator=ALLOC())

	~BasicJsonWriter () override=default

void	setItemSeparator (const BasicString< RebindAlloc< ALLOC, char > > &itemSeparator)

void	setKeySeparator (const BasicString< RebindAlloc< ALLOC, char > > &keySeparator)

void	setEnumerableFormat (EnumerableFormat enumerableFormat)

void	beginRoot (const IBasicReflectableDataConstPtr< ALLOC > &compound) override

void	endRoot (const IBasicReflectableDataConstPtr< ALLOC > &compound) override

void	beginArray (const IBasicReflectableDataConstPtr< ALLOC > &array, const BasicFieldInfo< ALLOC > &fieldInfo) override

void	endArray (const IBasicReflectableDataConstPtr< ALLOC > &array, const BasicFieldInfo< ALLOC > &fieldInfo) override

void	beginCompound (const IBasicReflectableDataConstPtr< ALLOC > &compound, const BasicFieldInfo< ALLOC > &fieldInfo, size_t elementIndex) override

void	endCompound (const IBasicReflectableDataConstPtr< ALLOC > &compound, const BasicFieldInfo< ALLOC > &fieldInfo, size_t elementIndex) override

void	visitValue (const IBasicReflectableDataConstPtr< ALLOC > &value, const BasicFieldInfo< ALLOC > &fieldInfo, size_t elementIndex) override


	BasicJsonWriter (const BasicJsonWriter &other)=delete

BasicJsonWriter &	operator= (const BasicJsonWriter &other)=delete

	BasicJsonWriter (BasicJsonWriter &&other)=delete

BasicJsonWriter &	operator= (BasicJsonWriter &&other)=delete

Public Member Functions inherited from zserio::IBasicWalkObserver< ALLOC >
virtual	~IBasicWalkObserver ()=default

Public Member Functions inherited from zserio::AllocatorHolder< ALLOC, EMPTY >
	AllocatorHolder ()

	AllocatorHolder (const allocator_type &allocator)

	AllocatorHolder (allocator_type &&allocator)

allocator_type	get_allocator () const

	AllocatorHolder (const AllocatorHolder &other)=default

AllocatorHolder &	operator= (const AllocatorHolder &other)=default

	AllocatorHolder (AllocatorHolder &&other)=default

AllocatorHolder &	operator= (AllocatorHolder &&other)=default

Static Public Attributes
static constexpr const char *	DEFAULT_ITEM_SEPARATOR = ", "

static constexpr const char *	DEFAULT_ITEM_SEPARATOR_WITH_INDENT = ","

static constexpr const char *	DEFAULT_KEY_SEPARATOR = ": "

static constexpr EnumerableFormat	DEFAULT_ENUMERABLE_FORMAT = EnumerableFormat::STRING

Additional Inherited Members
Protected Member Functions inherited from zserio::AllocatorHolder< ALLOC, EMPTY >
void	set_allocator (const allocator_type &allocator)

void	set_allocator (allocator_type &&allocator)

allocator_type &	get_allocator_ref ()

const allocator_type &	get_allocator_ref () const

Detailed Description

template<typename ALLOC = std::allocator<uint8_t>>
class zserio::BasicJsonWriter< ALLOC >

Walker observer which dumps zserio objects to JSON format.

Definition at line 22 of file JsonWriter.h.

Member Enumeration Documentation

◆ EnumerableFormat

template<typename ALLOC = std::allocator<uint8_t>>

enum class zserio::BasicJsonWriter::EnumerableFormat

strong

Configuration for writing of enumerable types.

Enumerator

NUMBER

Print as JSON integral value.

STRING

Print as JSON string according to the following rules:

Enums
- when an exact match with an enumerable item is found, the item name is used - e.g. "FIRST",
- when no exact match is found, it's an invalid value, the integral value is converted to string and an appropriate comment is included - e.g. "10 /* no match */".
Bitmasks
- when an exact mach with or-ed bitmask values is found, it's used - e.g. "READ | WRITE",
- when no exact match is found, but some or-ed values match, the integral value is converted to string and the or-ed values are included in a comment - e.g. "127 /* READ | CREATE */",
- when no match is found at all, the integral value is converted to string and an appropriate comment is included - e.g. "13 /* no match */".

Definition at line 45 of file JsonWriter.h.

Constructor & Destructor Documentation

◆ BasicJsonWriter() [1/5]

template<typename ALLOC >

zserio::BasicJsonWriter< ALLOC >::BasicJsonWriter	(	std::ostream &	out,
		const ALLOC &	allocator = `ALLOC()`
	)

explicit

Constructor.

Parameters

out	Stream to use for writing.
allocator	Allocator to use.

Definition at line 193 of file JsonWriter.h.

◆ BasicJsonWriter() [2/5]

template<typename ALLOC >

zserio::BasicJsonWriter< ALLOC >::BasicJsonWriter	(	std::ostream &	out,
		uint8_t	indent,
		const ALLOC &	allocator = `ALLOC()`
	)

Constructor.

Parameters

out	Stream to use for writing.
indent	Indent as a number of ' ' to be used for indentation.
allocator	Allocator to use.

Definition at line 198 of file JsonWriter.h.

◆ BasicJsonWriter() [3/5]

template<typename ALLOC >

zserio::BasicJsonWriter< ALLOC >::BasicJsonWriter	(	std::ostream &	out,
		const BasicString< RebindAlloc< ALLOC, char > > &	indent,
		const ALLOC &	allocator = `ALLOC()`
	)

Constructor.

Parameters

out	Stream to use for writing.
indent	Indent as a string to be used for indentation.
allocator	Allocator to use.

Definition at line 203 of file JsonWriter.h.

◆ ~BasicJsonWriter()

template<typename ALLOC = std::allocator<uint8_t>>

zserio::BasicJsonWriter< ALLOC >::~BasicJsonWriter ( )

overridedefault

Method generated by default.

◆ BasicJsonWriter() [4/5]

template<typename ALLOC = std::allocator<uint8_t>>

zserio::BasicJsonWriter< ALLOC >::BasicJsonWriter ( const BasicJsonWriter< ALLOC > & other )

delete

Copying and moving is disallowed!

◆ BasicJsonWriter() [5/5]

template<typename ALLOC = std::allocator<uint8_t>>

zserio::BasicJsonWriter< ALLOC >::BasicJsonWriter ( BasicJsonWriter< ALLOC > && other )

delete

Copying and moving is disallowed!

Member Function Documentation

◆ beginArray()

template<typename ALLOC >

void zserio::BasicJsonWriter< ALLOC >::beginArray	(	const IBasicReflectableDataConstPtr< ALLOC > &	array,
		const BasicFieldInfo< ALLOC > &	fieldInfo
	)

overridevirtual

Called at the beginning of an array.

Note that for unset arrays (i.e. non-present optionals) the visitValue method with nullptr is called instead!

Parameters

array	Reflectable zserio array.
fieldInfo	Array field info.

Implements zserio::IBasicWalkObserver< ALLOC >.

Definition at line 251 of file JsonWriter.h.

◆ beginCompound()

template<typename ALLOC >

void zserio::BasicJsonWriter< ALLOC >::beginCompound	(	const IBasicReflectableDataConstPtr< ALLOC > &	compound,
		const BasicFieldInfo< ALLOC > &	fieldInfo,
		size_t	elementIndex
	)

overridevirtual

Called at the beginning of an compound field object.

Note that for unset compounds (i.e. non-present optionals) the visitValue method with nullptr is called instead!

Parameters

compound	Reflectable compound zserio object.
fieldInfo	Compound field info.
elementIndex	Element index in array or WALKER_NOT_ELEMENT if the compound is not in array.

Implements zserio::IBasicWalkObserver< ALLOC >.

Definition at line 270 of file JsonWriter.h.

◆ beginRoot()

template<typename ALLOC >

void zserio::BasicJsonWriter< ALLOC >::beginRoot ( const IBasicReflectableDataConstPtr< ALLOC > & compound )

overridevirtual

Called for the root compound zserio object which is to be walked-through.

Parameters

compound Reflectable root compound zserio object.

Implements zserio::IBasicWalkObserver< ALLOC >.

Definition at line 238 of file JsonWriter.h.

◆ endArray()

template<typename ALLOC >

void zserio::BasicJsonWriter< ALLOC >::endArray	(	const IBasicReflectableDataConstPtr< ALLOC > &	array,
		const BasicFieldInfo< ALLOC > &	fieldInfo
	)

overridevirtual

Called at the end of an array.

Parameters

array	Reflectable zserio array.
fieldInfo	Array field info.

Implements zserio::IBasicWalkObserver< ALLOC >.

Definition at line 262 of file JsonWriter.h.

◆ endCompound()

template<typename ALLOC >

void zserio::BasicJsonWriter< ALLOC >::endCompound	(	const IBasicReflectableDataConstPtr< ALLOC > &	compound,
		const BasicFieldInfo< ALLOC > &	fieldInfo,
		size_t	elementIndex
	)

overridevirtual

Called at the end of just walked compound object.

Parameters

compound	Reflectable compound zserio object.
fieldInfo	Compound field info.
elementIndex	Element index in array or WALKER_NOT_ELEMENT if the compound is not in array.

Implements zserio::IBasicWalkObserver< ALLOC >.

Definition at line 284 of file JsonWriter.h.

◆ endRoot()

template<typename ALLOC >

void zserio::BasicJsonWriter< ALLOC >::endRoot ( const IBasicReflectableDataConstPtr< ALLOC > & compound )

overridevirtual

Called at the end of just walked root compound zserio object.

Parameters

compound Reflectable root compound zserio object.

Implements zserio::IBasicWalkObserver< ALLOC >.

Definition at line 244 of file JsonWriter.h.

◆ operator=() [1/2]

template<typename ALLOC = std::allocator<uint8_t>>

BasicJsonWriter & zserio::BasicJsonWriter< ALLOC >::operator= ( BasicJsonWriter< ALLOC > && other )

delete

Copying and moving is disallowed!

◆ operator=() [2/2]

template<typename ALLOC = std::allocator<uint8_t>>

BasicJsonWriter & zserio::BasicJsonWriter< ALLOC >::operator= ( const BasicJsonWriter< ALLOC > & other )

delete

Copying and moving is disallowed!

◆ setEnumerableFormat()

template<typename ALLOC >

void zserio::BasicJsonWriter< ALLOC >::setEnumerableFormat ( EnumerableFormat enumerableFormat )

Sets preferred formatting for enumerable types.

Parameters

enumerableFormat Enumerable format to use.

Definition at line 232 of file JsonWriter.h.

◆ setItemSeparator()

template<typename ALLOC >

void zserio::BasicJsonWriter< ALLOC >::setItemSeparator ( const BasicString< RebindAlloc< ALLOC, char > > & itemSeparator )

Sets custom item separator.

Use with caution since setting of a wrong separator can lead to invalid JSON output.

Parameters

itemSeparator Item separator to set.

Definition at line 220 of file JsonWriter.h.

◆ setKeySeparator()

template<typename ALLOC >

void zserio::BasicJsonWriter< ALLOC >::setKeySeparator ( const BasicString< RebindAlloc< ALLOC, char > > & keySeparator )

Sets custom key separator.

Use with caution since setting of a wrong separator can lead to invalid JSON output.

Parameters

keySeparator Key separator to set.

Definition at line 226 of file JsonWriter.h.

◆ visitValue()

template<typename ALLOC >

void zserio::BasicJsonWriter< ALLOC >::visitValue	(	const IBasicReflectableDataConstPtr< ALLOC > &	value,
		const BasicFieldInfo< ALLOC > &	fieldInfo,
		size_t	elementIndex
	)

overridevirtual

Called when a simple (or an unset compound or array - i.e. nullptr) value is reached.

Parameters

value	Reflectable simple value.
fieldInfo	Field info.
elementIndex	Element index in array or WALKER_NOT_ELEMENT if the value is not in array.

Implements zserio::IBasicWalkObserver< ALLOC >.

Definition at line 293 of file JsonWriter.h.

Member Data Documentation

◆ DEFAULT_ENUMERABLE_FORMAT

template<typename ALLOC = std::allocator<uint8_t>>

constexpr EnumerableFormat zserio::BasicJsonWriter< ALLOC >::DEFAULT_ENUMERABLE_FORMAT = EnumerableFormat::STRING

staticconstexpr

Default configuration for enumerable types.

Definition at line 70 of file JsonWriter.h.

◆ DEFAULT_ITEM_SEPARATOR

template<typename ALLOC = std::allocator<uint8_t>>

constexpr const char* zserio::BasicJsonWriter< ALLOC >::DEFAULT_ITEM_SEPARATOR = ", "

staticconstexpr

Default item separator used when indent is not set.

Definition at line 30 of file JsonWriter.h.

◆ DEFAULT_ITEM_SEPARATOR_WITH_INDENT

template<typename ALLOC = std::allocator<uint8_t>>

constexpr const char* zserio::BasicJsonWriter< ALLOC >::DEFAULT_ITEM_SEPARATOR_WITH_INDENT = ","

staticconstexpr

Default item separator used when indent is set.

Definition at line 35 of file JsonWriter.h.

◆ DEFAULT_KEY_SEPARATOR

template<typename ALLOC = std::allocator<uint8_t>>

constexpr const char* zserio::BasicJsonWriter< ALLOC >::DEFAULT_KEY_SEPARATOR = ": "

staticconstexpr

Default key separator.

Definition at line 40 of file JsonWriter.h.

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

zserio/JsonWriter.h

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ EnumerableFormat

Constructor & Destructor Documentation

◆ BasicJsonWriter() [1/5]

◆ BasicJsonWriter() [2/5]

◆ BasicJsonWriter() [3/5]

◆ ~BasicJsonWriter()

◆ BasicJsonWriter() [4/5]

◆ BasicJsonWriter() [5/5]

Member Function Documentation

◆ beginArray()

◆ beginCompound()

◆ beginRoot()

◆ endArray()

◆ endCompound()

◆ endRoot()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ setEnumerableFormat()

◆ setItemSeparator()

◆ setKeySeparator()

◆ visitValue()

Member Data Documentation

◆ DEFAULT_ENUMERABLE_FORMAT

◆ DEFAULT_ITEM_SEPARATOR

◆ DEFAULT_ITEM_SEPARATOR_WITH_INDENT

◆ DEFAULT_KEY_SEPARATOR