A C++11 library for serialization
Go to file
Randolph Voorhies 4420489a21 Merge branch 'master' of github.com:USCiLab/cereal
Conflicts:
	Makefile
2013-07-10 11:50:14 -07:00
doc Fixed doxygen when gh-pages crud is left about 2013-07-10 11:11:04 -07:00
include/cereal Fixed GCC compile error 2013-07-10 11:28:15 -07:00
.gitignore adding doxygen generation 2013-07-04 23:43:46 -07:00
LICENSE Took comments out of LICENSE 2013-06-17 15:51:19 -07:00
Makefile Merge branch 'master' of github.com:USCiLab/cereal 2013-07-10 11:50:14 -07:00
performance.cpp Added make_nvp<Archive> to elide unnecessary names 2013-07-03 18:57:42 -07:00
README.md Update README.md 2013-07-09 16:57:15 -07:00
renameincludes.sh Added renameincludes script 2013-07-01 15:25:29 -07:00
sandbox_json.cpp documentation and fixed a typo 2013-07-09 16:08:25 -07:00
sandbox_rtti.cpp Smart pointers to abstract types no longer require serialization functions. 2013-07-08 11:56:51 -07:00
sandbox.cpp fixed minor gcc comparison error in sandbox.cpp 2013-07-10 11:37:53 -07:00
unittests.cpp modified unit tests to not use floats for map keys, complex now uses boost_check_close for double types 2013-07-09 10:24:20 -07:00
updatedoc.sh Adding updatedoc.sh script 2013-07-10 11:17:08 -07:00

cereal - A C++11 library for serialization

cereal is a header-only C++11 serialization library. cereal takes arbitrary data types and reversibly turns them into different representations, such as compact binary encodings, XML, or JSON. cereal was designed to be fast, light-weight, and easy to extend - it has no external dependencies and can be easily bundled with other code or used standalone.

cereal has great documentation

Looking for more information on how cereal works and its documentation? Visit cereal's web page to get the latest information.

cereal is easy to use

Installation and use of of cereal is fully documented on the main web page, but this is a quick and dirty version:

  • Download cereal and place the headers somewhere your code can see them
  • Write serialization functions for your custom types or use the built in support for the standard library cereal provides
  • Use the serialization archives to load and save data
#include <cereal/types/map.hpp>
#include <cereal/types/memory.hpp>
#include <cereal/archives/binary.hpp>
#include <fstream>
    
struct MyRecord
{
  uint8_t x, y;
  float z;
  
  template <class Archive>
  void serialize( Archive & ar )
  {
    ar( x, y, z );
  }
};
    
struct SomeData
{
  int32_t id;
  std::shared_ptr<std::unordered_map<uint32_t, MyRecord>> data;
  
  template <class Archive>
  void save( Archive & ar ) const
  {
    ar( data );
  }
      
  template <class Archive>
  void load( Archive & ar )
  {
    static int32_t idGen = 0;
    id = idGen++;
    ar( data );
  }
};

int main()
{
  std::ofstream os("out.cereal");
  cereal::BinaryOutputArchive archive( os );

  SomeData myData;
  os( myData );

  return 0;
}

cereal has a permissive license

cereal is licensed under the BSD license.