ecstasy::serialization::RawSerializer Class Reference

RawSerializer class. More...

#include <RawSerializer.hpp>

Inheritance diagram for ecstasy::serialization::RawSerializer:

Collaboration diagram for ecstasy::serialization::RawSerializer:

Public Member Functions
	RawSerializer ()=default
	Construct a new Raw Serializer instance.
	RawSerializer (const std::string &content)
	Construct a new Raw Serializer and import the content from a string.
	RawSerializer (const std::filesystem::path &filename)
	Construct a new Raw Serializer and import the content from a file.
	RawSerializer (std::istream &stream)
	Construct a new Raw Serializer and import the content from a stream.
	~RawSerializer () override=default
	Destroy the RawSerializer.
void	clear () override final
	Clear the serializer content.
void	resetCursors (bool read=true, bool write=true)
	Reset the read and write cursor to the begining of the stream.
void	resetReadCursor ()
	Reset the read cursor to the begining of the stream.
void	resetWriteCursor ()
	Reset the write cursor to the begining of the stream.
size_t	size () const override final
	Get the size of the serializer content (in bytes).
void	importStream (std::istream &stream) override final
	Import data from a stream into the serializer.
void	exportStream (std::ostream &stream) const override final
	Export the serializer content to a stream.
template<typename T , typename = typename std::enable_if< (std::is_same_v<T, std::string> || std::is_same_v<T, std::string_view>) || std::is_bounded_array_v<T> || util::meta::is_std_vector<T>::value || std::is_same_v<T, std::type_info> , int>::type> requires (!std::is_fundamental_v<T>)
RawSerializer &	saveImpl (const T &object)
	Save an object to the serializer.
template<typename U > requires std::is_fundamental_v<U>
RawSerializer &	saveImpl (U object)
	Save an object to the serializer.
template<typename U , typename = typename std::enable_if<( std::is_same_v<U, std::string> || std::is_bounded_array_v<U> || util::meta::is_std_vector<U>::value) , int>::type>
RawSerializer &	updateImpl (U &object)
	Update an existing object from the serializer.
template<typename U > requires std::is_fundamental_v<U> || std::is_same_v<U, std::string>
U	loadImpl ()
	Load an object from the serializer.
template<typename U >
RawSerializer &	appendRaw (const U &object)
	Append a type to the serializer as it is in the memory.
void	write (const char *bytes, size_t size)
	Append a string to the serializer.
template<typename U >
U	loadRaw ()
	Load a raw type from the serializer.
std::stringstream &	getStream () noexcept
	Get the string stream of the serializer.
Public Member Functions inherited from ecstasy::serialization::Serializer< RawSerializer >
	Serializer ()=default
	Construct a new Serializer.
	~Serializer () override=default
	Destroy the Serializer.
constexpr RawSerializer &	inner ()
	Get a reference to the inner serializer.
void	importFile (const std::filesystem::path &filename) override
	Import data from a file into the serializer.
void	importBytes (const std::string &content) override
	Import data from a string into the serializer.
void	exportFile (const std::filesystem::path &filename) const override
	Export the serializer content to a file.
std::string	exportBytes () const override
	Export the serializer content to a string.
RawSerializer &	save (const U &object)
	Save an object to the serializer.
RawSerializer &	saveEntityComponent (const C &component)
	Save an entity component to the serializer.
RawSerializer &	saveEntity (const RegistryEntity &entity)
	Save an entity to the serializer with explicit components.
RawSerializer &	saveEntity (RegistryEntity &entity)
	Save all registered components of an entity to the serializer.
U	load ()
	Load an object from the serializer.
RegistryEntity	loadEntity (Registry &registry)
	Load an entity component from the serializer.
RawSerializer &	update (U &object)
	Update an existing object from the serializer.
RawSerializer &	updateEntity (RegistryEntity &entity)
	Update all registered components of an entity from the serializer.
RawSerializer &	operator<< (const U &object)
	Operator overload to simplify the save method.
RawSerializer &	operator>> (U &object)
	Operator overload to simplify the update method.
Public Member Functions inherited from ecstasy::serialization::ISerializer
virtual	~ISerializer ()=default
	Destroy the ISerializer.
virtual void	clear ()=0
	Clear the serializer content.
virtual size_t	size () const =0
	Get the size of the serializer content (in bytes).
virtual void	importFile (const std::filesystem::path &filename)=0
	Import data from a file into the serializer.
virtual void	importBytes (const std::string &content)=0
	Import data from a string into the serializer.
virtual void	importStream (std::istream &stream)=0
	Import data from a stream into the serializer.
virtual void	exportFile (const std::filesystem::path &filename) const =0
	Export the serializer content to a file.
virtual std::string	exportBytes () const =0
	Export the serializer content to a string.
virtual void	exportStream (std::ostream &stream) const =0
	Export the serializer content to a stream.

Private Member Functions
void	afterSaveEntity (RegistryEntity &entity) override final
	Optional method triggered at the end of saveEntity.
OptionalEntityComponentSerializer	loadComponentSerializer () override final
	Load the next component serializer from the stream.

Private Attributes
std::stringstream	_stream
	Internal string stream used as a buffer.

Additional Inherited Members
Static Public Member Functions inherited from ecstasy::serialization::Serializer< RawSerializer >
static IEntityComponentSerializer &	registerComponent (std::string_view name)
	Register a component to this serializer type.
static bool	hasEntityComponentSerializer ()
	Get the registered components of the serializer.
Static Public Attributes inherited from ecstasy::serialization::Serializer< RawSerializer >
static constexpr bool	is_constructible
	Check if a type is constructible from the serializer.
Protected Types inherited from ecstasy::serialization::Serializer< RawSerializer >
using	Parent = Serializer< RawSerializer >
	Parent serializer type, used for inheriting classes.
using	OptionalEntityComponentSerializer = std::optional< std::reference_wrapper< IEntityComponentSerializer > >
Protected Member Functions inherited from ecstasy::serialization::Serializer< RawSerializer >
virtual OptionalEntityComponentSerializer	loadComponentSerializer ()=0
	Load the next component serializer from the stream.
virtual void	beforeSaveEntity (RegistryEntity &entity)
	Optional method triggered at the start of saveEntity.
virtual void	afterSaveEntity (RegistryEntity &entity)
	Optional method triggered at the end of saveEntity.
virtual void	beforeUpdateEntity (RegistryEntity &entity)
	Optional method triggered at the start of updateEntity.
virtual void	afterUpdateEntity (RegistryEntity &entity)
	Optional method triggered at the end of updateEntity.

Detailed Description

RawSerializer class.

This class is used to serialize and deserialize raw data in a string stream used as a bytes buffer. Fundamental types are serialized as is, and other types are serialized by calling the custom save/update methods.

Note

Some fundamental types are handled by the serializer:

• fundamental types are saved as is.
• std::string and std::string_view are saved as a uint32_t size followed by the string bytes.
• Bounded arrays are saved by iterating over each element and saving them.
• std::vector are saved as a uint32_t size followed by each element.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-04-30)

Definition at line 39 of file RawSerializer.hpp.

Constructor & Destructor Documentation

RawSerializer() [1/4]

ecstasy::serialization::RawSerializer::RawSerializer ( )

default

Construct a new Raw Serializer instance.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-04-30)

RawSerializer() [2/4]

ecstasy::serialization::RawSerializer::RawSerializer ( const std::string &  content )

inline

Construct a new Raw Serializer and import the content from a string.

Parameters

[in]

content

String to import.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-09-12)

Definition at line 57 of file RawSerializer.hpp.

        {
            importBytes(content);
        }

RawSerializer() [3/4]

ecstasy::serialization::RawSerializer::RawSerializer ( const std::filesystem::path &  filename )

inlineexplicit

Construct a new Raw Serializer and import the content from a file.

Parameters

[in]

filename

Path to the file to import.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-09-12)

Definition at line 70 of file RawSerializer.hpp.

        {
            importFile(filename);
        }

RawSerializer() [4/4]

ecstasy::serialization::RawSerializer::RawSerializer ( std::istream &  stream )

inline

Construct a new Raw Serializer and import the content from a stream.

Parameters

[in]

stream

Input stream.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-09-12)

Definition at line 82 of file RawSerializer.hpp.

        {
            importStream(stream);
        }

~RawSerializer()

ecstasy::serialization::RawSerializer::~RawSerializer ( )

overridedefault

Destroy the RawSerializer.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-06-11)

Member Function Documentation

afterSaveEntity()

void ecstasy::serialization::RawSerializer::afterSaveEntity ( RegistryEntity &  entity )

inlinefinaloverrideprivatevirtual

Optional method triggered at the end of saveEntity.

Parameters

[in]

entity

Entity being saved.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-10-11)

Reimplemented from ecstasy::serialization::Serializer< RawSerializer >.

Definition at line 329 of file RawSerializer.hpp.

        {
            // Notify the end of the entity
            save<std::size_t>(0);
        }

appendRaw()

template<typename U >

RawSerializer & ecstasy::serialization::RawSerializer::appendRaw ( const U &  object )

inline

Append a type to the serializer as it is in the memory.

Warning

You must not use this for pointers or references.

Template Parameters

U	Type of the object to append.

Parameters

[in]

object

Object to append.

Returns

RawSerializer& Reference to this for chain calls.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-04-30)

Definition at line 270 of file RawSerializer.hpp.

        {
            write(reinterpret_cast<const char *>(&object), sizeof(object));
            return *this;
        }

clear()

void ecstasy::serialization::RawSerializer::clear ( )

inlinefinaloverridevirtual

Clear the serializer content.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-09-12)

Implements ecstasy::serialization::ISerializer.

Definition at line 96 of file RawSerializer.hpp.

        {
            _stream.str("");
        }

exportStream()

void ecstasy::serialization::RawSerializer::exportStream ( std::ostream &  stream ) const

inlinefinaloverridevirtual

Export the serializer content to a stream.

Parameters

[in]

stream

Stream to export the serializer content to.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-09-12)

Implements ecstasy::serialization::ISerializer.

Definition at line 155 of file RawSerializer.hpp.

        {
            std::stringstream &s = const_cast<std::stringstream &>(_stream);
            std::streampos pos = s.tellg();
 
            // Read from the begining of the stream
            s.seekg(0);
            stream << s.rdbuf();
            // Replace the read cursor at the original position
            s.seekg(pos);
        }

getStream()

std::stringstream & ecstasy::serialization::RawSerializer::getStream ( )

inlinenoexcept

Get the string stream of the serializer.

Returns

std::stringstream& Reference to the string stream of the serializer.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-06-11)

Definition at line 319 of file RawSerializer.hpp.

        {
            return _stream;
        }

importStream()

void ecstasy::serialization::RawSerializer::importStream ( std::istream &  stream )

inlinefinaloverridevirtual

Import data from a stream into the serializer.

Parameters

[in]

stream

Stream to import.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-09-12)

Implements ecstasy::serialization::ISerializer.

Definition at line 147 of file RawSerializer.hpp.

        {
            clear();
            _stream << stream.rdbuf();
            _stream.seekp(0);
        }

loadComponentSerializer()

OptionalEntityComponentSerializer ecstasy::serialization::RawSerializer::loadComponentSerializer ( )

inlinefinaloverrideprivatevirtual

Load the next component serializer from the stream.

Note

Return std::nullopt_t if no more components are available.

Returns

OptionalEntityComponentSerializer Optional reference to the next component serializer.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-10-04)

Implements ecstasy::serialization::Serializer< RawSerializer >.

Definition at line 336 of file RawSerializer.hpp.

        {
            size_t hash = loadRaw<std::size_t>();
 
            if (hash == 0)
                return std::nullopt;
 
            // Will raise an exception if the serializer is not registered
            return ecstasy::rtti::TypeRegistry::getInstance().get(hash).getSerializer<RawSerializer>();
        }

loadImpl()

template<typename U >
requires std::is_fundamental_v<U> || std::is_same_v<U, std::string>

U ecstasy::serialization::RawSerializer::loadImpl ( )

inline

Load an object from the serializer.

Note

This construct a new object and consume the associated data from the serializer.

Template Parameters

U	Type of the object to load.

Returns

U Loaded object.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-04-30)

Definition at line 242 of file RawSerializer.hpp.

        {
            if constexpr (std::is_fundamental_v<U>)
                return loadRaw<U>();
            else if constexpr (std::is_same<U, std::string>::value) {
                uint32_t size = loadRaw<uint32_t>();
                std::streampos pos = _stream.tellg();
                _stream.seekg(pos + std::streamoff(size));
 
                return std::string(_stream.view().data() + pos, size);
            }
        }

loadRaw()

template<typename U >

U ecstasy::serialization::RawSerializer::loadRaw ( )

inline

Load a raw type from the serializer.

Note

This is the opposite of appendRaw.

Template Parameters

U	Type of the object to load.

Returns

U Loaded object.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-04-30)

Definition at line 303 of file RawSerializer.hpp.

        {
            std::streampos pos = _stream.tellg();
            const U *result = reinterpret_cast<const U *>(_stream.view().data() + pos);
            _stream.seekg(pos + std::streamoff(sizeof(U)));
            return *result;
        }

resetCursors()

void ecstasy::serialization::RawSerializer::resetCursors ( bool  read = true, bool  write = true  )

inline

Reset the read and write cursor to the begining of the stream.

Parameters

[in]	read	Whether to reset the read cursor.
[in]	write	Whether to reset the write cursor.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-09-12)

Definition at line 110 of file RawSerializer.hpp.

        {
            if (read)
                resetReadCursor();
            if (write)
                resetWriteCursor();
        }

resetReadCursor()

void ecstasy::serialization::RawSerializer::resetReadCursor ( )

inline

Reset the read cursor to the begining of the stream.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-09-12)

Definition at line 124 of file RawSerializer.hpp.

        {
            _stream.seekg(0);
        }

resetWriteCursor()

void ecstasy::serialization::RawSerializer::resetWriteCursor ( )

inline

Reset the write cursor to the begining of the stream.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-09-12)

Definition at line 135 of file RawSerializer.hpp.

        {
            _stream.seekp(0);
        }

saveImpl() [1/2]

template<typename T , typename = typename std::enable_if< (std::is_same_v<T, std::string> || std::is_same_v<T, std::string_view>) || std::is_bounded_array_v<T> || util::meta::is_std_vector<T>::value || std::is_same_v<T, std::type_info> , int>::type>
requires (!std::is_fundamental_v<T>)

RawSerializer & ecstasy::serialization::RawSerializer::saveImpl ( const T &  object )

inline

Save an object to the serializer.

Template Parameters

U	Type of the object to save.

Parameters

[in]

object

Object to save.

Returns

S& Reference to this for chain calls.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-04-30)

Definition at line 178 of file RawSerializer.hpp.

        {
            if constexpr (std::is_same_v<T, std::string> || std::is_same_v<T, std::string_view>) {
                save(static_cast<uint32_t>(object.size()));
                _stream << object;
            } else if constexpr (std::is_bounded_array_v<T>) {
                for (size_t i = 0; i < std::extent_v<T>; i++)
                    save(object[i]);
            } else if constexpr (util::meta::is_std_vector<T>::value) {
                *this << object.size();
                for (const auto &elem : object)
                    *this << elem;
            } else if constexpr (std::is_same_v<T, std::type_info>) {
                save(rtti::TypeRegistry::getInstance().get(object).getHash());
            } else {
                return Parent::save(object);
            }
            return *this;
        }

saveImpl() [2/2]

template<typename U >
requires std::is_fundamental_v<U>

RawSerializer & ecstasy::serialization::RawSerializer::saveImpl ( U  object )

inline

Save an object to the serializer.

Template Parameters

U	Type of the object to save.

Parameters

[in]

object

Object to save.

Returns

S& Reference to this for chain calls.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-04-30)

Definition at line 201 of file RawSerializer.hpp.

        {
            write(reinterpret_cast<const char *>(&object), sizeof(object));
            return *this;
        }

size()

size_t ecstasy::serialization::RawSerializer::size ( ) const

inlinefinaloverridevirtual

Get the size of the serializer content (in bytes).

Returns

size_t Size of the serializer content in bytes.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-09-12)

Implements ecstasy::serialization::ISerializer.

Definition at line 141 of file RawSerializer.hpp.

        {
            return _stream.str().size();
        }

updateImpl()

template<typename U , typename = typename std::enable_if<( std::is_same_v<U, std::string> || std::is_bounded_array_v<U> || util::meta::is_std_vector<U>::value) , int>::type>

RawSerializer & ecstasy::serialization::RawSerializer::updateImpl ( U &  object )

inline

Update an existing object from the serializer.

Note

If the object is fundamental, it will use the assignment operator, otherwise the << operator is expected to be implemented in U.

Template Parameters

U	Type of the object to update.

Parameters

[in]

object

Existing object to update.

Returns

S& Reference to this for chain calls.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-04-30)

Definition at line 217 of file RawSerializer.hpp.

        {
            if constexpr (std::is_same_v<U, std::string>)
                object = load<U>();
            else if constexpr (std::is_bounded_array_v<U>)
                for (size_t i = 0; i < std::extent_v<U>; i++)
                    update(object[i]);
            else if constexpr (util::meta::is_std_vector<U>::value) {
                auto size = load<decltype(object.size())>();
                object.clear();
                object.reserve(size);
                for (size_t i = 0; i < size; i++) {
                    if constexpr (is_constructible<typename U::value_type>)
                        object.emplace_back(*this);
                    else
                        object.push_back(std::move(load<typename U::value_type>()));
                }
            } else
                return Parent::update(object);
            return *this;
        }

write()

void ecstasy::serialization::RawSerializer::write ( const char *  bytes, size_t  size  )

inline

Append a string to the serializer.

Parameters

[in]	bytes	Bytes to append.
[in]	size	Size of the bytes buffer to append.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-04-30)

Definition at line 285 of file RawSerializer.hpp.

        {
            _stream.write(bytes, static_cast<std::streamsize>(size));
        }

Member Data Documentation

_stream

std::stringstream ecstasy::serialization::RawSerializer::_stream

private

Internal string stream used as a buffer.

Definition at line 326 of file RawSerializer.hpp.

---

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

• src/ecstasy/serialization/RawSerializer.hpp