IDS peak IPL v1.17.2
Loading...
Searching...
No Matches
peak::common::serialization::IDeserializer Class Referenceabstract

Interface for deserializing structured data from an input stream into an archive. More...

#include <peak_common/serialization/peak_common_ideserializer.hpp>

Public Member Functions

virtual ~IDeserializer ()=default
virtual PEAK_COMMON_NO_DISCARD std::shared_ptr< IArchive > Read (std::istream &stream)=0
 Deserializes data from the specified input stream into an archive.

Detailed Description

Interface for deserializing structured data from an input stream into an archive.

Since
ids_peak_common 1.0

Constructor & Destructor Documentation

◆ ~IDeserializer()

virtual peak::common::serialization::IDeserializer::~IDeserializer ( )
virtualdefault

Member Function Documentation

◆ Read()

virtual PEAK_COMMON_NO_DISCARD std::shared_ptr< IArchive > peak::common::serialization::IDeserializer::Read ( std::istream & stream)
pure virtual

Deserializes data from the specified input stream into an archive.

This function reads raw data from the provided std::istream and converts it into a structured IArchive object. The stream must be open, valid, and ready for reading before this function is called.

Parameters
streamThe input stream to read from. It should point to the beginning of a valid archive format.
Returns
A shared pointer to the deserialized IArchive.

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