.TH "helpers.hpp" 3 "Sat Aug 29 2026 00:42:30" "cereal" \" -*- nroff -*-
.ad l
.nh
.SH NAME
helpers.hpp \- Internal helper functionality\&.  

.SH SYNOPSIS
.br
.PP
\fR#include <type_traits>\fP
.br
\fR#include <cstdint>\fP
.br
\fR#include <utility>\fP
.br
\fR#include <memory>\fP
.br
\fR#include <unordered_map>\fP
.br
\fR#include <stdexcept>\fP
.br
\fR#include 'cereal/macros\&.hpp'\fP
.br
\fR#include 'cereal/details/static_object\&.hpp'\fP
.br

.SS "Classes"

.in +1c
.ti -1c
.RI "struct \fBcereal::Exception\fP"
.br
.RI "An exception class thrown when things go wrong at runtime\&. "
.ti -1c
.RI "struct \fBcereal::detail::NameValuePairCore\fP"
.br
.RI "Traits struct for NVPs\&. "
.ti -1c
.RI "struct \fBcereal::detail::DeferredDataCore\fP"
.br
.RI "Traits struct for \fBDeferredData\fP\&. "
.ti -1c
.RI "class \fBcereal::NameValuePair< T >\fP"
.br
.RI "For holding name value pairs\&. "
.ti -1c
.RI "struct \fBcereal::BinaryData< T >\fP"
.br
.RI "A wrapper around data that can be serialized in a binary fashion\&. "
.ti -1c
.RI "class \fBcereal::DeferredData< T >\fP"
.br
.RI "A wrapper around data that should be serialized after all non-deferred data\&. "
.ti -1c
.RI "class \fBcereal::detail::OutputArchiveBase\fP"
.br
.ti -1c
.RI "class \fBcereal::detail::InputArchiveBase\fP"
.br
.ti -1c
.RI "class \fBcereal::SizeTag< T >\fP"
.br
.RI "A wrapper around size metadata\&. "
.ti -1c
.RI "struct \fBcereal::MapItem< Key, Value >\fP"
.br
.RI "A wrapper around a key and value for serializing data into maps\&. "
.ti -1c
.RI "struct \fBcereal::detail::Version< T, BindingTag >\fP"
.br
.RI "\fBVersion\fP information class\&. "
.ti -1c
.RI "struct \fBcereal::detail::Versions\fP"
.br
.RI "Holds all registered version information\&. "
.in -1c
.SS "Macros"

.in +1c
.ti -1c
.RI "#define \fBCEREAL_NVP_\fP(name,  value)"
.br
.RI "Convenience for creating a templated NVP\&. "
.in -1c
.SS "Typedefs"

.in +1c
.ti -1c
.RI "using \fBcereal::size_type\fP = \fBCEREAL_SIZE_TYPE\fP"
.br
.RI "The size type used by cereal\&. "
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "template<class KeyType, class ValueType> \fBMapItem\fP< KeyType, ValueType > \fBcereal::make_map_item\fP (KeyType &&key, ValueType &&value)"
.br
.RI "Create a \fBMapItem\fP so that human readable archives will group keys and values together\&. "
.in -1c
.SH "Detailed Description"
.PP 
Internal helper functionality\&. 


.SH "Macro Definition Documentation"
.PP 
.SS "#define CEREAL_NVP_( name,  value)"
\fBValue:\fP
.nf
::cereal::make_nvp<Archive>(name, value)
.PP
.fi

.PP
Convenience for creating a templated NVP\&. For use in internal generic typing functions which have an Archive type declared 
.SH "Typedef Documentation"
.PP 
.SS "using \fBcereal::size_type\fP = \fBCEREAL_SIZE_TYPE\fP"

.PP
The size type used by cereal\&. To ensure compatability between 32, 64, etc bit machines, we need to use a fixed size type instead of size_t, which may vary from machine to machine\&.

.PP
The default value for CEREAL_SIZE_TYPE is specified in \fBcereal/macros\&.hpp\fP 
.SH "Author"
.PP 
Generated automatically by Doxygen for cereal from the source code\&.