Serializer.h

Go to the documentation of this file.

/*
 * MIT License
 *
 * Copyright (c) 2025 nfx
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

 
#pragma once
 
#include "Document.h"
#include "SerializationTraits.h"
 
namespace nfx::serialization::json
{
    //=====================================================================
    // Serializer class
    //=====================================================================

    template <typename T>
    class Serializer final
    {
    public:
        //----------------------------------------------
        // Serialization options and context
        //----------------------------------------------

        struct Options
        {
            bool includeNullFields = false;    
            bool prettyPrint = false;          
            bool validateOnDeserialize = true; 

            Options() = default;

            template <typename U>
            inline void copyFrom( const typename Serializer<U>::Options& other );

            template <typename U>
            inline static Options createFrom( const typename Serializer<U>::Options& other );
        };
 
        //----------------------------------------------
        // Type aliases
        //----------------------------------------------

        using value_type = T;
 
        //----------------------------------------------
        // Construction
        //----------------------------------------------

        Serializer() = default;

        inline explicit Serializer( const Options& options ) noexcept;
 
        //----------------------------------------------
        // Options management
        //----------------------------------------------

        inline const Options& options() const noexcept;

        inline void setOptions( const Options& options ) noexcept;
 
        //----------------------------------------------
        // Static convenience serialization methods
        //----------------------------------------------

        inline static std::string toString( const T& obj, const Options& options = {} );

        inline static T fromString( std::string_view jsonStr, const Options& options = {} );
 
        //----------------------------------------------
        // Instance serialization methods
        //----------------------------------------------

        inline Document serialize( const T& obj ) const;

        inline T deserialize( const Document& doc ) const;
 
    private:
        //----------------------------------------------
        // Private methods
        //----------------------------------------------

        template <typename U>
        inline void serializeValue( const U& obj, Document& doc ) const;

        template <typename U>
        inline void deserializeValue( const Document& doc, U& obj ) const;
 
        //----------------------------------------------
        // Member variables
        //----------------------------------------------
 
        Options m_options{}; 
    };
} // namespace nfx::serialization::json
 
#include "nfx/detail/serialization/json/Serializer.inl"