json.hpp(3) Library Functions Manual json.hpp(3) # [NAME](#NAME) json.hpp - JSON input and output archives. # [SYNOPSIS](#SYNOPSIS) #include 'cereal/cereal.hpp' #include 'cereal/details/util.hpp' #include 'cereal/external/rapidjson/prettywriter.h' #include 'cereal/external/rapidjson/ostreamwrapper.h' #include 'cereal/external/rapidjson/istreamwrapper.h' #include 'cereal/external/rapidjson/document.h' #include 'cereal/external/base64.hpp' #include <limits> #include <sstream> #include <stack> #include <vector> #include <string> ## [Classes](#Classes) struct **cereal::RapidJSONException** An exception thrown when rapidjson fails an internal assertion. class **cereal::JSONOutputArchive** An output archive designed to save data to JSON. class **cereal::JSONOutputArchive::Options** A class containing various advanced options for the JSON archive. class **cereal::JSONInputArchive** An input archive designed to load data from JSON. ## [Macros](#Macros) #define **CEREAL\_RAPIDJSON\_ASSERT\_THROWS** #define **CEREAL\_RAPIDJSON\_ASSERT**(x) #define **CEREAL\_RAPIDJSON\_WRITE\_DEFAULT\_FLAGS** kWriteNanAndInfFlag #define **CEREAL\_RAPIDJSON\_PARSE\_DEFAULT\_FLAGS** kParseFullPrecisionFlag | kParseNanAndInfFlag ## [Functions](#Functions) template<class T> void **cereal::prologue** (**JSONOutputArchive** &, **NameValuePair**< T > const &) Prologue for NVPs for JSON archives. template<class T> void **cereal::prologue** (**JSONInputArchive** &, **NameValuePair**< T > const &) Prologue for NVPs for JSON archives. template<class T> void **cereal::epilogue** (**JSONOutputArchive** &, **NameValuePair**< T > const &) Epilogue for NVPs for JSON archives. template<class T> void **cereal::epilogue** (**JSONInputArchive** &, **NameValuePair**< T > const &) Epilogue for NVPs for JSON archives. template<class T> void **cereal::prologue** (**JSONOutputArchive** &, **DeferredData**< T > const &) Prologue for deferred data for JSON archives. template<class T> void **cereal::prologue** (**JSONInputArchive** &, **DeferredData**< T > const &) Prologue for deferred data for JSON archives. template<class T> void **cereal::epilogue** (**JSONOutputArchive** &, **DeferredData**< T > const &) Epilogue for deferred for JSON archives. template<class T> void **cereal::epilogue** (**JSONInputArchive** &, **DeferredData**< T > const &) Epilogue for deferred for JSON archives. template<class T> void **cereal::prologue** (**JSONOutputArchive** &ar, **SizeTag**< T > const &) Prologue for SizeTags for JSON archives. template<class T> void **cereal::prologue** (**JSONInputArchive** &, **SizeTag**< T > const &) Prologue for SizeTags for JSON archives. template<class T> void **cereal::epilogue** (**JSONOutputArchive** &, **SizeTag**< T > const &) Epilogue for SizeTags for JSON archives. template<class T> void **cereal::epilogue** (**JSONInputArchive** &, **SizeTag**< T > const &) Epilogue for SizeTags for JSON archives. template<class T, traits::EnableIf<!std::is\_arithmetic< T >::value, !**traits::has\_minimal\_base\_class\_serialization**< T, **traits::has\_minimal\_output\_serialization**, **JSONOutputArchive** >::value, !**traits::has\_minimal\_output\_serialization**< T, **JSONOutputArchive** >::value > = traits::sfinae> void **cereal::prologue** (**JSONOutputArchive** &ar, T const &) Prologue for all other types for JSON archives (except minimal types). template<class T, traits::EnableIf<!std::is\_arithmetic< T >::value, !**traits::has\_minimal\_base\_class\_serialization**< T, **traits::has\_minimal\_input\_serialization**, **JSONInputArchive** >::value, !**traits::has\_minimal\_input\_serialization**< T, **JSONInputArchive** >::value > = traits::sfinae> void **cereal::prologue** (**JSONInputArchive** &ar, T const &) Prologue for all other types for JSON archives. template<class T, traits::EnableIf<!std::is\_arithmetic< T >::value, !**traits::has\_minimal\_base\_class\_serialization**< T, **traits::has\_minimal\_output\_serialization**, **JSONOutputArchive** >::value, !**traits::has\_minimal\_output\_serialization**< T, **JSONOutputArchive** >::value > = traits::sfinae> void **cereal::epilogue** (**JSONOutputArchive** &ar, T const &) Epilogue for all other types other for JSON archives (except minimal types). template<class T, traits::EnableIf<!std::is\_arithmetic< T >::value, !**traits::has\_minimal\_base\_class\_serialization**< T, **traits::has\_minimal\_input\_serialization**, **JSONInputArchive** >::value, !**traits::has\_minimal\_input\_serialization**< T, **JSONInputArchive** >::value > = traits::sfinae> void **cereal::epilogue** (**JSONInputArchive** &ar, T const &) Epilogue for all other types other for JSON archives. void **cereal::prologue** (**JSONOutputArchive** &ar, std::nullptr\_t const &) Prologue for arithmetic types for JSON archives. void **cereal::prologue** (**JSONInputArchive** &, std::nullptr\_t const &) Prologue for arithmetic types for JSON archives. void **cereal::epilogue** (**JSONOutputArchive** &, std::nullptr\_t const &) Epilogue for arithmetic types for JSON archives. void **cereal::epilogue** (**JSONInputArchive** &, std::nullptr\_t const &) Epilogue for arithmetic types for JSON archives. template<class T, traits::EnableIf< std::is\_arithmetic< T >::value > = traits::sfinae> void **cereal::prologue** (**JSONOutputArchive** &ar, T const &) Prologue for arithmetic types for JSON archives. template<class T, traits::EnableIf< std::is\_arithmetic< T >::value > = traits::sfinae> void **cereal::prologue** (**JSONInputArchive** &, T const &) Prologue for arithmetic types for JSON archives. template<class T, traits::EnableIf< std::is\_arithmetic< T >::value > = traits::sfinae> void **cereal::epilogue** (**JSONOutputArchive** &, T const &) Epilogue for arithmetic types for JSON archives. template<class T, traits::EnableIf< std::is\_arithmetic< T >::value > = traits::sfinae> void **cereal::epilogue** (**JSONInputArchive** &, T const &) Epilogue for arithmetic types for JSON archives. template<class CharT, class Traits, class Alloc> void **cereal::prologue** (**JSONOutputArchive** &ar, std::basic\_string< CharT, Traits, Alloc > const &) Prologue for strings for JSON archives. template<class CharT, class Traits, class Alloc> void **cereal::prologue** (**JSONInputArchive** &, std::basic\_string< CharT, Traits, Alloc > const &) Prologue for strings for JSON archives. template<class CharT, class Traits, class Alloc> void **cereal::epilogue** (**JSONOutputArchive** &, std::basic\_string< CharT, Traits, Alloc > const &) Epilogue for strings for JSON archives. template<class CharT, class Traits, class Alloc> void **cereal::epilogue** (**JSONInputArchive** &, std::basic\_string< CharT, Traits, Alloc > const &) Epilogue for strings for JSON archives. template<class T> void **cereal::CEREAL\_SAVE\_FUNCTION\_NAME** (**JSONOutputArchive** &ar, **NameValuePair**< T > const &t) Serializing NVP types to JSON. template<class T> void **cereal::CEREAL\_LOAD\_FUNCTION\_NAME** (**JSONInputArchive** &ar, **NameValuePair**< T > &t) void **cereal::CEREAL\_SAVE\_FUNCTION\_NAME** (**JSONOutputArchive** &ar, std::nullptr\_t const &t) Saving for nullptr to JSON. void **cereal::CEREAL\_LOAD\_FUNCTION\_NAME** (**JSONInputArchive** &ar, std::nullptr\_t &t) Loading arithmetic from JSON. template<class T, traits::EnableIf< std::is\_arithmetic< T >::value > = traits::sfinae> void **cereal::CEREAL\_SAVE\_FUNCTION\_NAME** (**JSONOutputArchive** &ar, T const &t) Saving for arithmetic to JSON. template<class T, traits::EnableIf< std::is\_arithmetic< T >::value > = traits::sfinae> void **cereal::CEREAL\_LOAD\_FUNCTION\_NAME** (**JSONInputArchive** &ar, T &t) Loading arithmetic from JSON. template<class CharT, class Traits, class Alloc> void **cereal::CEREAL\_SAVE\_FUNCTION\_NAME** (**JSONOutputArchive** &ar, std::basic\_string< CharT, Traits, Alloc > const &str) saving string to JSON template<class CharT, class Traits, class Alloc> void **cereal::CEREAL\_LOAD\_FUNCTION\_NAME** (**JSONInputArchive** &ar, std::basic\_string< CharT, Traits, Alloc > &str) loading string from JSON template<class T> void **cereal::CEREAL\_SAVE\_FUNCTION\_NAME** (**JSONOutputArchive** &, **SizeTag**< T > const &) Saving SizeTags to JSON. template<class T> void **cereal::CEREAL\_LOAD\_FUNCTION\_NAME** (**JSONInputArchive** &ar, **SizeTag**< T > &st) Loading SizeTags from JSON. # [Detailed Description](#Detailed_Description) JSON input and output archives. # [Macro Definition Documentation](#Macro_Definition_Documentation) ## [#define CEREAL\_RAPIDJSON\_ASSERT( x)](#_define_CEREAL_RAPIDJSON_ASSERT%28_x%29) **Value:** ``` if(!(x)){ \ throw ::cereal::RapidJSONException("rapidjson internal assertion failure: " #x); } ``` ``` ``` # [Function Documentation](#Function_Documentation) ## template<class T> void cereal::epilogue (**JSONInputArchive** & , **DeferredData**< T > const & ) \[inline] Epilogue for deferred for JSON archives. Do nothing for the defer wrapper ## template<class T> void cereal::epilogue (**JSONInputArchive** & , **NameValuePair**< T > const & ) \[inline] Epilogue for NVPs for JSON archives. NVPs do not start or finish nodes - they just set up the names ## template<class T> void cereal::epilogue (**JSONOutputArchive** & , **DeferredData**< T > const & ) \[inline] Epilogue for deferred for JSON archives. NVPs do not start or finish nodes - they just set up the names ## template<class T> void cereal::epilogue (**JSONOutputArchive** & , **NameValuePair**< T > const & ) \[inline] Epilogue for NVPs for JSON archives. NVPs do not start or finish nodes - they just set up the names ## template<class T> void cereal::epilogue (**JSONOutputArchive** & , **SizeTag**< T > const & ) \[inline] Epilogue for SizeTags for JSON archives. SizeTags are strictly ignored for JSON ## template<class T, **traits::EnableIf**<!std::is\_arithmetic< T >::value, !traits::has\_minimal\_base\_class\_serialization< T, traits::has\_minimal\_output\_serialization, JSONOutputArchive >::value, !traits::has\_minimal\_output\_serialization< T, JSONOutputArchive >::value > = traits::sfinae> void cereal::epilogue (**JSONOutputArchive** & ar, T const & ) \[inline] Epilogue for all other types other for JSON archives (except minimal types). Finishes the node created in the prologue Minimal types do not start or finish nodes ## template<class T> void cereal::prologue (**JSONOutputArchive** & , **DeferredData**< T > const & ) \[inline] Prologue for deferred data for JSON archives. Do nothing for the defer wrapper ## template<class T> void cereal::prologue (**JSONOutputArchive** & , **NameValuePair**< T > const & ) \[inline] Prologue for NVPs for JSON archives. NVPs do not start or finish nodes - they just set up the names ## template<class T> void cereal::prologue (**JSONOutputArchive** & ar, **SizeTag**< T > const & ) \[inline] Prologue for SizeTags for JSON archives. SizeTags are strictly ignored for JSON, they just indicate that the current node should be made into an array ## template<class T, **traits::EnableIf**<!std::is\_arithmetic< T >::value, !traits::has\_minimal\_base\_class\_serialization< T, traits::has\_minimal\_output\_serialization, JSONOutputArchive >::value, !traits::has\_minimal\_output\_serialization< T, JSONOutputArchive >::value > = traits::sfinae> void cereal::prologue (**JSONOutputArchive** & ar, T const & ) \[inline] Prologue for all other types for JSON archives (except minimal types). Starts a new node, named either automatically or by some NVP, that may be given data by the type about to be archived Minimal types do not start or finish nodes # [Author](#Author) Generated automatically by Doxygen for cereal from the source code. Mon Oct 26 2026 02:55:37 cereal --- Document: json.hpp(3) from cereal 1.3.2-r7 (Chainguard OS) Source: https://github.com/USCiLab/cereal