ecstasy::serialization::Serializer< S > Class Template Reference

Serializer class. More...

#include <Serializer.hpp>

Inheritance diagram for ecstasy::serialization::Serializer< S >:

Collaboration diagram for ecstasy::serialization::Serializer< S >:

Public Member Functions
	Serializer ()=default
	Construct a new Serializer.
	~Serializer () override=default
	Destroy the Serializer.
constexpr S &	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.
template<typename U > requires concepts::has_extraction_operator<S, U> || traits::has_save_impl_for_type_v<S, U>
S &	save (const U &object)
	Save an object to the serializer.
template<typename C >
S &	saveEntityComponent (const C &component)
	Save an entity component to the serializer.
template<typename... Cs>
S &	saveEntity (const RegistryEntity &entity)
	Save an entity to the serializer with explicit components.
S &	saveEntity (RegistryEntity &entity)
	Save all registered components of an entity to the serializer.
template<typename U > requires is_constructible<U> || (std::is_default_constructible_v<U> && traits::can_update_type_v<S, U>) || traits::has_load_impl_for_type_v<S, U>
U	load ()
	Load an object from the serializer.
RegistryEntity	loadEntity (Registry &registry)
	Load an entity component from the serializer.
template<typename U > requires traits::has_update_impl_for_type_v<S, U> || std::is_fundamental_v<U> || concepts::has_insertion_operator<S, U>
S &	update (U &object)
	Update an existing object from the serializer.
S &	updateEntity (RegistryEntity &entity)
	Update all registered components of an entity from the serializer.
template<typename U >
S &	operator<< (const U &object)
	Operator overload to simplify the save method.
template<typename U >
S &	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.

Static Public Member Functions
template<typename C >
static IEntityComponentSerializer &	registerComponent (std::string_view name)
	Register a component to this serializer type.
template<typename T >
static bool	hasEntityComponentSerializer ()
	Get the registered components of the serializer.

Static Public Attributes
template<typename U >
static constexpr bool	is_constructible = std::is_constructible_v<U, std::add_lvalue_reference_t<S>>
	Check if a type is constructible from the serializer.

Protected Types
using	Parent = Serializer< S >
	Parent serializer type, used for inheriting classes.
using	OptionalEntityComponentSerializer = std::optional< std::reference_wrapper< IEntityComponentSerializer > >

Protected Member Functions
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

template<typename S>
class ecstasy::serialization::Serializer< S >

Serializer class.

Template Parameters

S	Child serializer type. This is required to call the sub serializer class methods because template and virtual methods cannot be mixed.

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 69 of file Serializer.hpp.

Member Typedef Documentation

OptionalEntityComponentSerializer

template<typename S >

using ecstasy::serialization::Serializer< S >::OptionalEntityComponentSerializer = std::optional<std::reference_wrapper<IEntityComponentSerializer> >

protected

Definition at line 431 of file Serializer.hpp.

Parent

template<typename S >

using ecstasy::serialization::Serializer< S >::Parent = Serializer<S>

protected

Parent serializer type, used for inheriting classes.

Definition at line 72 of file Serializer.hpp.

Constructor & Destructor Documentation

Serializer()

template<typename S >

ecstasy::serialization::Serializer< S >::Serializer ( )

default

Construct a new 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-04-30)

~Serializer()

template<typename S >

ecstasy::serialization::Serializer< S >::~Serializer ( )

overridedefault

Destroy 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)

Member Function Documentation

afterSaveEntity()

template<typename S >

virtual void ecstasy::serialization::Serializer< S >::afterSaveEntity ( RegistryEntity &  entity )

inlineprotectedvirtual

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 in ecstasy::serialization::JsonSerializer, and ecstasy::serialization::RawSerializer.

Definition at line 465 of file Serializer.hpp.

        {
        }

afterUpdateEntity()

template<typename S >

virtual void ecstasy::serialization::Serializer< S >::afterUpdateEntity ( RegistryEntity &  entity )

inlineprotectedvirtual

Optional method triggered at the end of updateEntity.

Parameters

[in]

entity

Entity being updated.

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 in ecstasy::serialization::JsonSerializer.

Definition at line 489 of file Serializer.hpp.

        {
        }

beforeSaveEntity()

template<typename S >

virtual void ecstasy::serialization::Serializer< S >::beforeSaveEntity ( RegistryEntity &  entity )

inlineprotectedvirtual

Optional method triggered at the start 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 in ecstasy::serialization::JsonSerializer.

Definition at line 453 of file Serializer.hpp.

        {
        }

beforeUpdateEntity()

template<typename S >

virtual void ecstasy::serialization::Serializer< S >::beforeUpdateEntity ( RegistryEntity &  entity )

inlineprotectedvirtual

Optional method triggered at the start of updateEntity.

Parameters

[in]

entity

Entity being updated.

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 in ecstasy::serialization::JsonSerializer.

Definition at line 477 of file Serializer.hpp.

        {
        }

exportBytes()

template<typename S >

std::string ecstasy::serialization::Serializer< S >::exportBytes ( ) const

inlineoverridevirtual

Export the serializer content to a string.

Note

Calls the exportStream method with a stringstream.

Returns

std::string String representation of 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 142 of file Serializer.hpp.

        {
            std::stringstream stream;
 
            exportStream(stream);
            return stream.str();
        }

exportFile()

template<typename S >

void ecstasy::serialization::Serializer< S >::exportFile ( const std::filesystem::path &  filename ) const

inlineoverridevirtual

Export the serializer content to a file.

Note

Calls the exportStream method with a file stream.

Parameters

[in]

filename

Path to the file 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 134 of file Serializer.hpp.

        {
            std::ofstream fstream(filename);
 
            exportStream(fstream);
        }

hasEntityComponentSerializer()

template<typename S >

template<typename T >

static bool ecstasy::serialization::Serializer< S >::hasEntityComponentSerializer ( )

inlinestatic

Get the registered components of the serializer.

Template Parameters

T	Type of the component to get.

Returns

bool True if the component is registered, false otherwise.

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-25)

Definition at line 421 of file Serializer.hpp.

        {
            auto atype = rtti::TypeRegistry::getInstance().find<T>();
 
            if (atype.has_value())
                return atype->get().template hasSerializer<S>();
            return false;
        }

importBytes()

template<typename S >

void ecstasy::serialization::Serializer< S >::importBytes ( const std::string &  content )

inlineoverridevirtual

Import data from a string into the serializer.

Note

Calls the importStream method with a stringstream.

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)

Implements ecstasy::serialization::ISerializer.

Definition at line 126 of file Serializer.hpp.

        {
            std::stringstream stream(content);
 
            importStream(stream);
        }

importFile()

template<typename S >

void ecstasy::serialization::Serializer< S >::importFile ( const std::filesystem::path &  filename )

inlineoverridevirtual

Import data from a file into the serializer.

Note

Calls the importStream method with a file stream.

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)

Implements ecstasy::serialization::ISerializer.

Definition at line 118 of file Serializer.hpp.

        {
            std::ifstream fstream(filename);
 
            importStream(fstream);
        }

inner()

template<typename S >

constexpr S & ecstasy::serialization::Serializer< S >::inner ( )

inlineconstexpr

Get a reference to the inner serializer.

Returns

constexpr S& Reference to the inner 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-04-30)

Definition at line 112 of file Serializer.hpp.

        {
            return reinterpret_cast<S &>(*this);
        }

load()

template<typename S >

template<typename U >
requires is_constructible<U> || (std::is_default_constructible_v<U> && traits::can_update_type_v<S, U>) || traits::has_load_impl_for_type_v<S, U>

U ecstasy::serialization::Serializer< S >::load ( )

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 259 of file Serializer.hpp.

        {
            if constexpr (traits::has_load_impl_for_type_v<S, U>)
                return inner().template loadImpl<U>();
            else if constexpr (is_constructible<U>) {
                return U(inner());
            } else {
                U object;
                inner().update(object);
                return object;
            }
        }

loadComponentSerializer()

template<typename S >

virtual OptionalEntityComponentSerializer ecstasy::serialization::Serializer< S >::loadComponentSerializer ( )

protectedpure virtual

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)

Implemented in ecstasy::serialization::JsonSerializer, and ecstasy::serialization::RawSerializer.

loadEntity()

template<typename S >

RegistryEntity ecstasy::serialization::Serializer< S >::loadEntity ( Registry &  registry )

inline

Load an entity component from the serializer.

Parameters

[in]

registry

Registry to load the component to.

Returns

RegistryEntity Loaded entity.

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)

Definition at line 282 of file Serializer.hpp.

        {
            RegistryEntity entity(registry.entityBuilder().build(), registry);
 
            updateEntity(entity);
            return entity;
        }

operator<<()

template<typename S >

template<typename U >

S & ecstasy::serialization::Serializer< S >::operator<< ( const U &  object )

inline

Operator overload to simplify the save method.

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 365 of file Serializer.hpp.

        {
            return inner().save(object);
        }

operator>>()

template<typename S >

template<typename U >

S & ecstasy::serialization::Serializer< S >::operator>> ( U &  object )

inline

Operator overload to simplify the update method.

Template Parameters

U	Type of the object to update.

Parameters

[in]

object

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 383 of file Serializer.hpp.

        {
            return inner().update(object);
        }

registerComponent()

template<typename S >

template<typename C >

static IEntityComponentSerializer & ecstasy::serialization::Serializer< S >::registerComponent ( std::string_view  name )

inlinestatic

Register a component to this serializer type.

This is required for calls to saveEntity calls without explicit component types.

Template Parameters

C	Component type to register.

Parameters

[in]

name

Name of the component type.

Returns

IEntityComponentSerializer& Reference to the registered 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)

Definition at line 403 of file Serializer.hpp.

        {
            rtti::AType &type = rtti::TypeRegistry::getInstance().registerType<C>(name);
 
            return dynamic_cast<rtti::Type<C> &>(type).template registerSerializer<S>();
        }

save()

template<typename S >

template<typename U >
requires concepts::has_extraction_operator<S, U> || traits::has_save_impl_for_type_v<S, U>

S & ecstasy::serialization::Serializer< S >::save ( const 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 164 of file Serializer.hpp.

        {
            if constexpr (traits::has_save_impl_for_type_v<S, U>)
                return inner().saveImpl(object);
            else
                return object >> inner();
        }

saveEntity() [1/2]

template<typename S >

template<typename... Cs>

S & ecstasy::serialization::Serializer< S >::saveEntity ( const RegistryEntity &  entity )

inline

Save an entity to the serializer with explicit components.

Template Parameters

Cs	Components to save.

Parameters

[in]

entity

Entity to save.

Returns

S& Reference to this for chain calls.

Exceptions

std::out_of_range

If the entity does not have one of the components.

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 206 of file Serializer.hpp.

        {
            S &s = inner();
            (saveEntityComponent(entity.get<Cs>()), ...);
            return s;
        }

saveEntity() [2/2]

template<typename S >

S & ecstasy::serialization::Serializer< S >::saveEntity ( RegistryEntity &  entity )

inline

Save all registered components of an entity to the serializer.

Note

See registerComponent for registering components.

Parameters

[in]

entity

Entity 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-10-04)

Definition at line 225 of file Serializer.hpp.

        {
            beforeSaveEntity(entity);
            auto storages = entity.getRegistry().getEntityStorages(entity);
 
            for (IStorage &storage : storages) {
                auto optional_type = ecstasy::rtti::TypeRegistry::getInstance().find(storage.getComponentTypeInfos());
 
                if (optional_type.has_value()) {
                    auto serializer = optional_type->get().tryGetSerializer<S>();
 
                    if (serializer.has_value())
                        serializer->get().save(*this, storage, entity);
                }
            }
            afterSaveEntity(entity);
            return inner();
        }

saveEntityComponent()

template<typename S >

template<typename C >

S & ecstasy::serialization::Serializer< S >::saveEntityComponent ( const C &  component )

inline

Save an entity component to the serializer.

This includes the component type before the component data.

Template Parameters

C	Component type.

Parameters

[in]

component

Component 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-06-11)

Definition at line 186 of file Serializer.hpp.

        {
            return inner() << typeid(C) << component;
        }

update()

template<typename S >

template<typename U >
requires traits::has_update_impl_for_type_v<S, U> || std::is_fundamental_v<U> || concepts::has_insertion_operator<S, U>

S & ecstasy::serialization::Serializer< S >::update ( 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 308 of file Serializer.hpp.

        {
            if constexpr (traits::has_update_impl_for_type_v<S, U>)
                return inner().updateImpl(object);
            else {
                if constexpr (std::is_fundamental_v<U>)
                    object = inner().template load<U>();
                else
                    object << inner();
                return inner();
            }
        }

updateEntity()

template<typename S >

S & ecstasy::serialization::Serializer< S >::updateEntity ( RegistryEntity &  entity )

inline

Update all registered components of an entity from the serializer.

Note

Missing components are loaded, existing components are updated.

Parameters

[in]

entity

Entity to update.

Returns

S& Reference to this for chain calls.

Exceptions

std::out_of_range

If an entity component is not registered in 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-10-04)

Definition at line 335 of file Serializer.hpp.

        {
            beforeUpdateEntity(entity);
            OptionalEntityComponentSerializer component = loadComponentSerializer();
 
            while (component.has_value()) {
                rtti::AType &type = rtti::TypeRegistry::getInstance().get(component->get().getType());
                IStorage &storage = entity.getRegistry().getStorages().get(std::type_index(type.getStorageTypeInfo()));
 
                component->get().load(*this, storage, entity);
 
                component = loadComponentSerializer();
            }
            afterUpdateEntity(entity);
            return inner();
        }

Member Data Documentation

is_constructible

template<typename S >

template<typename U >

constexpr bool ecstasy::serialization::Serializer< S >::is_constructible = std::is_constructible_v<U, std::add_lvalue_reference_t<S>>

staticconstexpr

Check if a type is constructible from the serializer.

Note

The type must be constructible from a non const reference to the inner serializer.

Template Parameters

U	Type to check.

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 86 of file Serializer.hpp.

---

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

• src/ecstasy/serialization/Serializer.hpp