#include <StringFieldSerializer.h>

Inheritance diagram for ne::StringFieldSerializer:

Public Member Functions
virtual bool	isFieldTypeSupported (const rfk::Field *pField) override

virtual std::optional< Error >	serializeField (toml::value pTomlData, Serializable pFieldOwner, const rfk::Field pField, const std::string &sSectionName, const std::string &sEntityId, size_t &iSubEntityId, Serializable pOriginalObject=nullptr) override

virtual std::optional< Error >	deserializeField (const toml::value pTomlDocument, const toml::value pTomlValue, Serializable pFieldOwner, const rfk::Field pField, const std::string &sOwnerSectionName, const std::string &sEntityId, std::unordered_map< std::string, std::string > &customAttributes) override

virtual std::optional< Error >	cloneField (Serializable pFromInstance, const rfk::Field pFromField, Serializable pToInstance, const rfk::Field pToField) override

virtual bool	isFieldValueEqual (Serializable pFieldAOwner, const rfk::Field pFieldA, Serializable pFieldBOwner, const rfk::Field pFieldB) override

virtual bool	isFieldTypeSupported (const rfk::Field *pField)=0

virtual std::optional< Error >	serializeField (toml::value pTomlData, Serializable pFieldOwner, const rfk::Field pField, const std::string &sSectionName, const std::string &sEntityId, size_t &iSubEntityId, Serializable pOriginalObject=nullptr)=0

virtual std::optional< Error >	deserializeField (const toml::value pTomlDocument, const toml::value pTomlValue, Serializable pFieldOwner, const rfk::Field pField, const std::string &sOwnerSectionName, const std::string &sEntityId, std::unordered_map< std::string, std::string > &customAttributes)=0

virtual std::optional< Error >	cloneField (Serializable pFromInstance, const rfk::Field pFromField, Serializable pToInstance, const rfk::Field pToField)=0

virtual bool	isFieldValueEqual (Serializable pFieldAOwner, const rfk::Field pFieldA, Serializable pFieldBOwner, const rfk::Field pFieldB)=0

Static Private Attributes
static const std::string	sStringCanonicalTypeName = "std::basic_string<char>"

Detailed Description

Serializer for the std::string field type.

Member Function Documentation

◆ cloneField()

std::optional< Error > ne::StringFieldSerializer::cloneField	(	Serializable *	pFromInstance,
		const rfk::Field *	pFromField,
		Serializable *	pToInstance,
		const rfk::Field *	pToField
	)

overridevirtual

Clones field's data from one object to another.

Parameters

pFromInstance	Instance to copy the field from.
pFromField	Field to copy.
pToInstance	Instance to copy to.
pToField	Field to copy to.

Returns: Error if something went wrong, empty otherwise.

Implements ne::IFieldSerializer.

◆ deserializeField()

std::optional< Error > ne::StringFieldSerializer::deserializeField	(	const toml::value *	pTomlDocument,
		const toml::value *	pTomlValue,
		Serializable *	pFieldOwner,
		const rfk::Field *	pField,
		const std::string &	sOwnerSectionName,
		const std::string &	sEntityId,
		std::unordered_map< std::string, std::string > &	customAttributes
	)

overridevirtual

Deserializes field from a TOML value.

Parameters

pTomlDocument	TOML document that contains a value to deserialize.
pTomlValue	TOML value to deserialize the field from.
pFieldOwner	Field's owner.
pField	Field to deserialize TOML value to.
sOwnerSectionName	Name of the TOML section where is field was found.
sEntityId	Current ID string of the entity (field owner) that we are deserializing.
customAttributes	Pairs of values that were found with this object in TOML data. Only found when deserializing a field of type that derives from Serializable.

Returns: Error if something went wrong, empty otherwise.

Implements ne::IFieldSerializer.

◆ isFieldTypeSupported()

bool ne::StringFieldSerializer::isFieldTypeSupported ( const rfk::Field * pField )

overridevirtual

Tests if this serializer supports serialization/deserialization of this field.

Parameters

pField Field to test for serialization/deserialization support.

Returns: true if this serializer can be used to serialize this field, false otherwise.

Implements ne::IFieldSerializer.

◆ isFieldValueEqual()

bool ne::StringFieldSerializer::isFieldValueEqual	(	Serializable *	pFieldAOwner,
		const rfk::Field *	pFieldA,
		Serializable *	pFieldBOwner,
		const rfk::Field *	pFieldB
	)

overridevirtual

Checks if the specified fields' values are equal or not.

Parameters

pFieldAOwner	Owner of the field A.
pFieldA	Field A to compare.
pFieldBOwner	Owner of the field B.
pFieldB	Field B to compare.

Returns: false if some field is unsupported by this serializer or if fields' values are not equal, true otherwise.

Implements ne::IFieldSerializer.

◆ serializeField()

std::optional< Error > ne::StringFieldSerializer::serializeField	(	toml::value *	pTomlData,
		Serializable *	pFieldOwner,
		const rfk::Field *	pField,
		const std::string &	sSectionName,
		const std::string &	sEntityId,
		size_t &	iSubEntityId,
		Serializable *	pOriginalObject = `nullptr`
	)

overridevirtual

Serializes field into a TOML value.

Parameters

pTomlData	TOML value to serialize the field to.
pFieldOwner	Field's owner.
pField	Field to serialize.
sSectionName	Name of the section (for TOML value) to use for this field.
sEntityId	Current ID string of the entity (field owner) that we are serializing. Only used when serializing a field of type that derives from Serializable.
iSubEntityId	Current ID of the sub entity (sub entity of the field owner). Only used when serializing a field of type that derives from Serializable.
pOriginalObject	Optional. Original object of the same type as the object being serialized, this object is a deserialized version of the object being serialized, used to compare serializable fields' values and only serialize changed values. Only used when serializing a field of type that derives from Serializable.

Returns: Error if something went wrong, empty otherwise.

Implements ne::IFieldSerializer.

Member Data Documentation

◆ sStringCanonicalTypeName

const std::string ne::StringFieldSerializer::sStringCanonicalTypeName = "std::basic_string<char>"

inlinestaticprivate

Canonical type name for std::string fields.

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

src/engine_lib/public/io/serializers/StringFieldSerializer.h
src/engine_lib/private/io/serializers/StringFieldSerializer.cpp

Public Member Functions

Static Private Attributes

Detailed Description

Member Function Documentation

◆ cloneField()

◆ deserializeField()

◆ isFieldTypeSupported()

◆ isFieldValueEqual()

◆ serializeField()

Member Data Documentation

◆ sStringCanonicalTypeName