A C++11 library for serialization
Go to file
Shane Grant fb7fd75954 Changes to support thread safety
-Make CEREAL_THREAD_SAFE be 0 or 1 instead of present or not present
-Move CEREAL_NOEXCEPT to macros.hpp
-instead of individual locks, can now use StaticObject::lock() to request a lock if CEREAL_THREAD_SAFE is enabled. If
not enabled, this call returns an empty object. The lock returned acts just like std::lock_guard, but uses
std::unique_lock internally
-Made a bunch of requests to StaticObject::getInstance const
-Added first stab at multithreaded tests with versioning and polymorphism
2016-07-29 13:40:49 -07:00
doc Comment level doc for #205 2015-07-17 10:46:33 -07:00
include/cereal Changes to support thread safety 2016-07-29 13:40:49 -07:00
sandbox Updates RapidJSON to 1.0.2, nests in namespace 2016-04-19 10:55:56 -07:00
scripts fix update scripts to apply to develop 2015-01-19 12:09:28 -08:00
unittests Changes to support thread safety 2016-07-29 13:40:49 -07:00
vs2013 Use /W4 in all but performance. 2016-06-12 13:45:48 -07:00
.gitignore Split lookup and exists check in PolymorphicCasters into two functions. 2016-06-29 12:32:02 -07:00
.travis.yml Update .travis.yml 2014-08-18 23:31:32 -07:00
CMakeLists.txt Changes to support thread safety 2016-07-29 13:40:49 -07:00
LICENSE Update copyright 2013 -> 2014 2014-03-20 20:36:04 -07:00
README.md Update README.md 2014-05-02 09:40:36 -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/unordered_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", std::ios::binary);
  cereal::BinaryOutputArchive archive( os );

  SomeData myData;
  archive( myData );

  return 0;
}

cereal has a mailing list

Either get in touch over email or on the web.

cereal has a permissive license

cereal is licensed under the BSD license.

cereal build status

  • develop : Build Status

Were you looking for the Haskell cereal? Go here.