Serializer Class Reference

#include <peak_icv/serialization/peak_icv_serializer.hpp>

Inheritance diagram for Serializer:

Public Member Functions
	Serializer (SerializationType type=SerializationType::Json)
	Constructs a Serializer with the specified serialization type.
void	Write (const peak::common::serialization::IArchive &archive, std::ostream &stream) override
	Serializes an archive and writes it to a stream.

Detailed Description

Serializer for writing IArchive objects to an output stream.

This class converts an IArchive object into a specific serialization format and writes the result to a stream.

Example

peak::icv::Archive archive{};
archive.SetInt("id", 42);
archive.SetString("name", "example");
 
std::ofstream file("archive.json");
peak::icv::Serializer serializer{ peak::icv::SerializationType::Json };
serializer.Write(archive, file);
file.close();

Since

ids_peak_icv 1.0

Constructor & Destructor Documentation

Serializer()

Serializer ( SerializationType type = SerializationType::Json )

inlineexplicit

Constructs a Serializer with the specified serialization type.

The chosen format determines how the archive is written when Write() is called. If no type is provided, JSON is used by default.

Parameters

type	The serialization format to use (defaults to SerializationType::Json).

Since

ids_peak_icv 1.0

Member Function Documentation

Write()

void Write ( const peak::common::serialization::IArchive & archive, std::ostream & stream )

inlineoverridevirtual

Serializes an archive and writes it to a stream.

Converts the given IArchive object into the configured format and writes the serialized data to the provided stream.

Parameters

archive	The archive to serialize.
stream	The stream that receives the serialized data.

Exceptions

NotSupportedException

The serialization type is not supported.

Since

ids_peak_icv 1.0

Implements ISerializer.