Represents a JSON string data type and provides serialization and deserialization functionality. More...

#include <JsonSerializableString.h>

Inheritance diagram for Devel::Serializing::IJsonString:

[legend]

Collaboration diagram for Devel::Serializing::IJsonString:

[legend]

Public Member Functions
	IJsonString (const CJsonFieldName i_oFieldName)
	Constructs an `IJsonString` object with the specified field name. More...

template<typename String , std::enable_if_t< std::is_constructible_v< std::string, String >, bool > = true>
IJsonString &	operator= (const String &i_tValue)
	Assigns a value to the `IJsonString` object. More...

template<typename String , std::enable_if_t< std::is_constructible_v< std::string, String >, bool > = true>
IJsonString &	operator= (String &&i_tValue)
	Assigns an rvalue to the `IJsonString` object. More...

Public Member Functions inherited from Devel::Serializing::IJsonType< std::string, IData< std::string > >
bool	doDeserialize (IO::CJsonObject &i_oObject, const bool i_bIsStrict=false)
	Deserializes the object from a JSON object. More...

bool	doSerialize (IO::CJsonObject &i_oObject, const bool i_bIsStrict=false) const
	Serializes the object to a JSON object. More...

size_t	size () const override
	Retrieves the size of the object. More...

IJsonType &	operator= (const TJsonFieldName &i_tValue)
	Assigns a JSON field name to the object. More...

IJsonType &	operator= (TJsonFieldName &&i_tValue)
	Assigns a JSON field name to the object (move assignment). More...

Public Member Functions inherited from Devel::Serializing::IData< T, IsHidden >
virtual	~IData ()=default
	Default destructor.

bool	doSerialize (IO::CWriteStream &i_oStream) const
	Serializes the data to a write stream. More...

bool	doDeserialize (IO::CReadStream &i_oStream)
	Deserializes the data from a read stream. More...

bool	doDeserialize (const char *i_szString)
	Deserializes the data from a string. More...

bool	doDeserialize (std::vector< std::string >::const_iterator &i_oIt, const std::vector< std::string >::const_iterator &i_oItEnd)
	Deserializes the data from a range of strings. More...

virtual bool	isHidden () const
	Returns whether the field is hidden. More...

virtual SCompareData	compareData () const
	Returns the compare data for the data field. More...

auto	begin () const
	Returns an iterator pointing to the beginning of the value. More...

auto	end () const
	Returns an iterator pointing to the end of the value. More...

auto &	operator[] (const size_t i_nIndex)
	Returns a reference to the value at the specified index. More...

const auto &	operator[] (const size_t i_nIndex) const
	Returns a const reference to the value at the specified index. More...

	SerializerEnableIfNotArithmetic (IData< T > &) operator--()
	Pre-decrement operator. More...

	SerializerEnableIfNotArithmetic (IData< T > &) operator--(int)
	Post-decrement operator. More...

	SerializerEnableIfNotArithmetic (IData< T > &) operator++()
	Pre-increment operator. More...

	SerializerEnableIfNotArithmetic (IData< T > &) operator++(int)
	Post-increment operator. More...

Public Member Functions inherited from Devel::Serializing::IValue< int >
	IValue (TArgs... i_tArgs)
	Constructs an `IValue` object with the specified arguments. More...

const int &	value () const
	Returns the value. More...

int &	value ()
	Returns a reference to the value. More...

Additional Inherited Members
Protected Member Functions inherited from Devel::Serializing::IJsonType< std::string, IData< std::string > >
	IJsonType (const CJsonFieldName i_oFieldName)
	Constructs an `IJsonType` object with the specified JSON field name. More...

virtual	~IJsonType ()=default
	Destructor.

bool	serialize (IO::CJsonObject &i_oObject, const bool i_bIsStrict=false) const
	Serializes the data to a JSON object. More...

std::string_view	name () const
	Retrieves the name of the JSON field. More...

bool	isNull () const
	Checks if the JSON field is null. More...

void	setNull (bool i_bState)
	Sets the null state of the JSON field. More...

IO::CJsonObject *	getObject (IO::CJsonObject &i_oObject, const bool i_bIsStrict)
	Retrieves the JSON object for the specified JSON field. More...

bool	checkSerializeObject (IO::CJsonObject &i_oObject, const bool i_bIsStrict) const
	Checks if serialization of the object is allowed and handles null fields. More...

Protected Attributes inherited from Devel::Serializing::IValue< int >
int	m_tValue
	The value.

Detailed Description

Represents a JSON string data type and provides serialization and deserialization functionality.

Constructor & Destructor Documentation

◆ IJsonString()

Devel::Serializing::IJsonString::IJsonString ( const CJsonFieldName i_oFieldName )

inline

Constructs an IJsonString object with the specified field name.

Parameters

i_oFieldName The field name for the JSON string.

Member Function Documentation

◆ operator=() [1/2]

template<typename String , std::enable_if_t< std::is_constructible_v< std::string, String >, bool > = true>

IJsonString& Devel::Serializing::IJsonString::operator= ( const String & i_tValue )

inline

Assigns a value to the IJsonString object.

Template Parameters

String The type of the value to assign.

Parameters

i_tValue The value to assign.

Returns: A reference to the IJsonString object.

◆ operator=() [2/2]

template<typename String , std::enable_if_t< std::is_constructible_v< std::string, String >, bool > = true>

IJsonString& Devel::Serializing::IJsonString::operator= ( String && i_tValue )

inline

Assigns an rvalue to the IJsonString object.

Template Parameters

String The type of the rvalue to assign.

Parameters

i_tValue The rvalue to assign.

Returns: A reference to the IJsonString object.

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

/home/runner/work/devel-library/devel-library/Serializing/Json/Types/JsonSerializableString.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IJsonString()

Member Function Documentation

◆ operator=() [1/2]

◆ operator=() [2/2]