Bitcoin Core  22.99.0
P2P Digital Currency
Classes | Macros | Typedefs | Enumerations | Functions | Variables
serialize.h File Reference
#include <compat/endian.h>
#include <algorithm>
#include <cstdint>
#include <cstring>
#include <ios>
#include <limits>
#include <map>
#include <memory>
#include <set>
#include <string>
#include <string.h>
#include <utility>
#include <vector>
#include <prevector.h>
#include <span.h>
Include dependency graph for serialize.h:

Go to the source code of this file.

Classes

struct  deserialize_type
 Dummy data type to identify deserializing constructors. More...
 
struct  CheckVarIntMode< Mode, I >
 
class  Wrapper< Formatter, T >
 Simple wrapper class to serialize objects using a formatter; used by Using(). More...
 
struct  VarIntFormatter< Mode >
 Serialization wrapper class for integers in VarInt format. More...
 
struct  CustomUintFormatter< Bytes, BigEndian >
 Serialization wrapper class for custom integers and enums. More...
 
struct  CompactSizeFormatter< RangeCheck >
 Formatter for integers in CompactSize format. More...
 
struct  LimitedStringFormatter< Limit >
 
struct  VectorFormatter< Formatter >
 Formatter to serialize/deserialize vector elements using another formatter. More...
 
struct  DefaultFormatter
 Default formatter. More...
 
struct  CSerActionSerialize
 Support for SERIALIZE_METHODS and READWRITE macro. More...
 
struct  CSerActionUnserialize
 
class  CSizeComputer
 

Macros

#define READWRITE(...)   (::SerReadWriteMany(s, ser_action, __VA_ARGS__))
 
#define READWRITEAS(type, obj)   (::SerReadWriteMany(s, ser_action, ReadWriteAsHelper<type>(obj)))
 
#define SER_READ(obj, code)   ::SerRead(s, ser_action, obj, [&](Stream& s, typename std::remove_const<Type>::type& obj) { code; })
 
#define SER_WRITE(obj, code)   ::SerWrite(s, ser_action, obj, [&](Stream& s, const Type& obj) { code; })
 
#define FORMATTER_METHODS(cls, obj)
 Implement the Ser and Unser methods needed for implementing a formatter (see Using below). More...
 
#define SERIALIZE_METHODS(cls, obj)
 Implement the Serialize and Unserialize methods by delegating to a single templated static method that takes the to-be-(de)serialized object as a parameter. More...
 
#define VARINT_MODE(obj, mode)   Using<VarIntFormatter<mode>>(obj)
 
#define VARINT(obj)   Using<VarIntFormatter<VarIntMode::DEFAULT>>(obj)
 
#define COMPACTSIZE(obj)   Using<CompactSizeFormatter<true>>(obj)
 
#define LIMITED_STRING(obj, n)   Using<LimitedStringFormatter<n>>(obj)
 

Typedefs

template<int Bytes>
using BigEndianFormatter = CustomUintFormatter< Bytes, true >
 

Enumerations

enum  { SER_NETWORK = (1 << 0), SER_DISK = (1 << 1), SER_GETHASH = (1 << 2) }
 
enum  VarIntMode { VarIntMode::DEFAULT, VarIntMode::NONNEGATIVE_SIGNED }
 Variable-length integers: bytes are a MSB base-128 encoding of the number. More...
 

Functions

char * CharCast (char *c)
 Safely convert odd char pointer types to standard ones. More...
 
char * CharCast (unsigned char *c)
 
const char * CharCast (const char *c)
 
const char * CharCast (const unsigned char *c)
 
template<typename Stream >
void ser_writedata8 (Stream &s, uint8_t obj)
 
template<typename Stream >
void ser_writedata16 (Stream &s, uint16_t obj)
 
template<typename Stream >
void ser_writedata16be (Stream &s, uint16_t obj)
 
template<typename Stream >
void ser_writedata32 (Stream &s, uint32_t obj)
 
template<typename Stream >
void ser_writedata32be (Stream &s, uint32_t obj)
 
template<typename Stream >
void ser_writedata64 (Stream &s, uint64_t obj)
 
template<typename Stream >
uint8_t ser_readdata8 (Stream &s)
 
template<typename Stream >
uint16_t ser_readdata16 (Stream &s)
 
template<typename Stream >
uint16_t ser_readdata16be (Stream &s)
 
template<typename Stream >
uint32_t ser_readdata32 (Stream &s)
 
template<typename Stream >
uint32_t ser_readdata32be (Stream &s)
 
template<typename Stream >
uint64_t ser_readdata64 (Stream &s)
 
template<typename X >
XReadWriteAsHelper (X &x)
 Convert the reference base type to X, without changing constness or reference type. More...
 
template<typename X >
const XReadWriteAsHelper (const X &x)
 
template<typename Stream >
void Serialize (Stream &s, char a)
 
template<typename Stream >
void Serialize (Stream &s, int8_t a)
 
template<typename Stream >
void Serialize (Stream &s, uint8_t a)
 
template<typename Stream >
void Serialize (Stream &s, int16_t a)
 
template<typename Stream >
void Serialize (Stream &s, uint16_t a)
 
template<typename Stream >
void Serialize (Stream &s, int32_t a)
 
template<typename Stream >
void Serialize (Stream &s, uint32_t a)
 
template<typename Stream >
void Serialize (Stream &s, int64_t a)
 
template<typename Stream >
void Serialize (Stream &s, uint64_t a)
 
template<typename Stream , int N>
void Serialize (Stream &s, const char(&a)[N])
 
template<typename Stream , int N>
void Serialize (Stream &s, const unsigned char(&a)[N])
 
template<typename Stream >
void Serialize (Stream &s, const Span< const unsigned char > &span)
 
template<typename Stream >
void Serialize (Stream &s, const Span< unsigned char > &span)
 
template<typename Stream >
void Unserialize (Stream &s, char &a)
 
template<typename Stream >
void Unserialize (Stream &s, int8_t &a)
 
template<typename Stream >
void Unserialize (Stream &s, uint8_t &a)
 
template<typename Stream >
void Unserialize (Stream &s, int16_t &a)
 
template<typename Stream >
void Unserialize (Stream &s, uint16_t &a)
 
template<typename Stream >
void Unserialize (Stream &s, int32_t &a)
 
template<typename Stream >
void Unserialize (Stream &s, uint32_t &a)
 
template<typename Stream >
void Unserialize (Stream &s, int64_t &a)
 
template<typename Stream >
void Unserialize (Stream &s, uint64_t &a)
 
template<typename Stream , int N>
void Unserialize (Stream &s, char(&a)[N])
 
template<typename Stream , int N>
void Unserialize (Stream &s, unsigned char(&a)[N])
 
template<typename Stream >
void Unserialize (Stream &s, Span< unsigned char > &span)
 
template<typename Stream >
void Serialize (Stream &s, bool a)
 
template<typename Stream >
void Unserialize (Stream &s, bool &a)
 
unsigned int GetSizeOfCompactSize (uint64_t nSize)
 Compact Size size < 253 – 1 byte size <= USHRT_MAX – 3 bytes (253 + 2 bytes) size <= UINT_MAX – 5 bytes (254 + 4 bytes) size > UINT_MAX – 9 bytes (255 + 8 bytes) More...
 
void WriteCompactSize (CSizeComputer &os, uint64_t nSize)
 
template<typename Stream >
void WriteCompactSize (Stream &os, uint64_t nSize)
 
template<typename Stream >
uint64_t ReadCompactSize (Stream &is, bool range_check=true)
 Decode a CompactSize-encoded variable-length integer. More...
 
template<VarIntMode Mode, typename I >
unsigned int GetSizeOfVarInt (I n)
 
template<typename I >
void WriteVarInt (CSizeComputer &os, I n)
 
template<typename Stream , VarIntMode Mode, typename I >
void WriteVarInt (Stream &os, I n)
 
template<typename Stream , VarIntMode Mode, typename I >
ReadVarInt (Stream &is)
 
template<typename Formatter , typename T >
static Wrapper< Formatter, T & > Using (T &&t)
 Cause serialization/deserialization of an object to be done using a specified formatter class. More...
 
template<typename Stream , typename C >
void Serialize (Stream &os, const std::basic_string< C > &str)
 Forward declarations. More...
 
template<typename Stream , typename C >
void Unserialize (Stream &is, std::basic_string< C > &str)
 
template<typename Stream , unsigned int N, typename T >
void Serialize_impl (Stream &os, const prevector< N, T > &v, const unsigned char &)
 prevector prevectors of unsigned char are a special case and are intended to be serialized as a single opaque blob. More...
 
template<typename Stream , unsigned int N, typename T , typename V >
void Serialize_impl (Stream &os, const prevector< N, T > &v, const V &)
 
template<typename Stream , unsigned int N, typename T >
void Serialize (Stream &os, const prevector< N, T > &v)
 
template<typename Stream , unsigned int N, typename T >
void Unserialize_impl (Stream &is, prevector< N, T > &v, const unsigned char &)
 
template<typename Stream , unsigned int N, typename T , typename V >
void Unserialize_impl (Stream &is, prevector< N, T > &v, const V &)
 
template<typename Stream , unsigned int N, typename T >
void Unserialize (Stream &is, prevector< N, T > &v)
 
template<typename Stream , typename T , typename A >
void Serialize_impl (Stream &os, const std::vector< T, A > &v, const unsigned char &)
 vector vectors of unsigned char are a special case and are intended to be serialized as a single opaque blob. More...
 
template<typename Stream , typename T , typename A >
void Serialize_impl (Stream &os, const std::vector< T, A > &v, const bool &)
 
template<typename Stream , typename T , typename A , typename V >
void Serialize_impl (Stream &os, const std::vector< T, A > &v, const V &)
 
template<typename Stream , typename T , typename A >
void Serialize (Stream &os, const std::vector< T, A > &v)
 
template<typename Stream , typename T , typename A >
void Unserialize_impl (Stream &is, std::vector< T, A > &v, const unsigned char &)
 
template<typename Stream , typename T , typename A , typename V >
void Unserialize_impl (Stream &is, std::vector< T, A > &v, const V &)
 
template<typename Stream , typename T , typename A >
void Unserialize (Stream &is, std::vector< T, A > &v)
 
template<typename Stream , typename K , typename T >
void Serialize (Stream &os, const std::pair< K, T > &item)
 pair More...
 
template<typename Stream , typename K , typename T >
void Unserialize (Stream &is, std::pair< K, T > &item)
 
template<typename Stream , typename K , typename T , typename Pred , typename A >
void Serialize (Stream &os, const std::map< K, T, Pred, A > &m)
 map More...
 
template<typename Stream , typename K , typename T , typename Pred , typename A >
void Unserialize (Stream &is, std::map< K, T, Pred, A > &m)
 
template<typename Stream , typename K , typename Pred , typename A >
void Serialize (Stream &os, const std::set< K, Pred, A > &m)
 set More...
 
template<typename Stream , typename K , typename Pred , typename A >
void Unserialize (Stream &is, std::set< K, Pred, A > &m)
 
template<typename Stream , typename T >
void Serialize (Stream &os, const std::shared_ptr< const T > &p)
 shared_ptr More...
 
template<typename Stream , typename T >
void Unserialize (Stream &os, std::shared_ptr< const T > &p)
 
template<typename Stream , typename T >
void Serialize (Stream &os, const std::unique_ptr< const T > &p)
 unique_ptr More...
 
template<typename Stream , typename T >
void Unserialize (Stream &os, std::unique_ptr< const T > &p)
 
template<typename Stream , typename T >
void Serialize (Stream &os, const T &a)
 If none of the specialized versions above matched, default to calling member function. More...
 
template<typename Stream , typename T >
void Unserialize (Stream &is, T &&a)
 
template<typename Stream >
void SerializeMany (Stream &s)
 
template<typename Stream , typename Arg , typename... Args>
void SerializeMany (Stream &s, const Arg &arg, const Args &... args)
 
template<typename Stream >
void UnserializeMany (Stream &s)
 
template<typename Stream , typename Arg , typename... Args>
void UnserializeMany (Stream &s, Arg &&arg, Args &&... args)
 
template<typename Stream , typename... Args>
void SerReadWriteMany (Stream &s, CSerActionSerialize ser_action, const Args &... args)
 
template<typename Stream , typename... Args>
void SerReadWriteMany (Stream &s, CSerActionUnserialize ser_action, Args &&... args)
 
template<typename Stream , typename Type , typename Fn >
void SerRead (Stream &s, CSerActionSerialize ser_action, Type &&, Fn &&)
 
template<typename Stream , typename Type , typename Fn >
void SerRead (Stream &s, CSerActionUnserialize ser_action, Type &&obj, Fn &&fn)
 
template<typename Stream , typename Type , typename Fn >
void SerWrite (Stream &s, CSerActionSerialize ser_action, Type &&obj, Fn &&fn)
 
template<typename Stream , typename Type , typename Fn >
void SerWrite (Stream &s, CSerActionUnserialize ser_action, Type &&, Fn &&)
 
template<typename T >
size_t GetSerializeSize (const T &t, int nVersion=0)
 
template<typename... T>
size_t GetSerializeSizeMany (int nVersion, const T &... t)
 

Variables

static constexpr uint64_t MAX_SIZE = 0x02000000
 The maximum size of a serialized object in bytes or number of elements (for eg vectors) when the size is encoded as CompactSize. More...
 
static const unsigned int MAX_VECTOR_ALLOCATE = 5000000
 Maximum amount of memory (in bytes) to allocate at once when deserializing vectors. More...
 
constexpr deserialize_type deserialize {}
 

Macro Definition Documentation

◆ COMPACTSIZE

#define COMPACTSIZE (   obj)    Using<CompactSizeFormatter<true>>(obj)

Definition at line 444 of file serialize.h.

◆ FORMATTER_METHODS

#define FORMATTER_METHODS (   cls,
  obj 
)
Value:
template<typename Stream> \
static void Ser(Stream& s, const cls& obj) { SerializationOps(obj, s, CSerActionSerialize()); } \
template<typename Stream> \
static void Unser(Stream& s, cls& obj) { SerializationOps(obj, s, CSerActionUnserialize()); } \
template<typename Stream, typename Type, typename Operation> \
static inline void SerializationOps(Type& obj, Stream& s, Operation ser_action) \

Implement the Ser and Unser methods needed for implementing a formatter (see Using below).

Both Ser and Unser are delegated to a single static method SerializationOps, which is polymorphic in the serialized/deserialized type (allowing it to be const when serializing, and non-const when deserializing).

Example use: struct FooFormatter { FORMATTER_METHODS(Class, obj) { READWRITE(obj.val1, VARINT(obj.val2)); } } would define a class FooFormatter that defines a serialization of Class objects consisting of serializing its val1 member using the default serialization, and its val2 member using VARINT serialization. That FooFormatter can then be used in statements like READWRITE(Using<FooFormatter>(obj.bla)).

Definition at line 168 of file serialize.h.

◆ LIMITED_STRING

#define LIMITED_STRING (   obj,
 
)    Using<LimitedStringFormatter<n>>(obj)

Definition at line 445 of file serialize.h.

◆ READWRITE

#define READWRITE (   ...)    (::SerReadWriteMany(s, ser_action, __VA_ARGS__))

Definition at line 147 of file serialize.h.

◆ READWRITEAS

#define READWRITEAS (   type,
  obj 
)    (::SerReadWriteMany(s, ser_action, ReadWriteAsHelper<type>(obj)))

Definition at line 148 of file serialize.h.

◆ SER_READ

#define SER_READ (   obj,
  code 
)    ::SerRead(s, ser_action, obj, [&](Stream& s, typename std::remove_const<Type>::type& obj) { code; })

Definition at line 149 of file serialize.h.

◆ SER_WRITE

#define SER_WRITE (   obj,
  code 
)    ::SerWrite(s, ser_action, obj, [&](Stream& s, const Type& obj) { code; })

Definition at line 150 of file serialize.h.

◆ SERIALIZE_METHODS

#define SERIALIZE_METHODS (   cls,
  obj 
)
Value:
template<typename Stream> \
void Serialize(Stream& s) const \
{ \
static_assert(std::is_same<const cls&, decltype(*this)>::value, "Serialize type mismatch"); \
Ser(s, *this); \
} \
template<typename Stream> \
void Unserialize(Stream& s) \
{ \
static_assert(std::is_same<cls&, decltype(*this)>::value, "Unserialize type mismatch"); \
Unser(s, *this); \
} \
FORMATTER_METHODS(cls, obj)

Implement the Serialize and Unserialize methods by delegating to a single templated static method that takes the to-be-(de)serialized object as a parameter.

This approach has the advantage that the constness of the object becomes a template parameter, and thus allows a single implementation that sees the object as const for serializing and non-const for deserializing, without casts.

Definition at line 183 of file serialize.h.

◆ VARINT

#define VARINT (   obj)    Using<VarIntFormatter<VarIntMode::DEFAULT>>(obj)

Definition at line 443 of file serialize.h.

◆ VARINT_MODE

#define VARINT_MODE (   obj,
  mode 
)    Using<VarIntFormatter<mode>>(obj)

Definition at line 442 of file serialize.h.

Typedef Documentation

◆ BigEndianFormatter

template<int Bytes>
using BigEndianFormatter = CustomUintFormatter<Bytes, true>

Definition at line 504 of file serialize.h.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
SER_NETWORK 
SER_DISK 
SER_GETHASH 

Definition at line 135 of file serialize.h.

◆ VarIntMode

enum VarIntMode
strong

Variable-length integers: bytes are a MSB base-128 encoding of the number.

The high bit in each byte signifies whether another digit follows. To make sure the encoding is one-to-one, one is subtracted from all but the last digit. Thus, the byte sequence a[] with length len, where all but the last byte has bit 128 set, encodes the number:

(a[len-1] & 0x7F) + sum(i=1..len-1, 128^i*((a[len-i-1] & 0x7F)+1))

Properties:

  • Very small (0-127: 1 byte, 128-16511: 2 bytes, 16512-2113663: 3 bytes)
  • Every integer has exactly one encoding
  • Encoding does not depend on size of original integer type
  • No redundancy: every (infinite) byte sequence corresponds to a list of encoded integers.

0: [0x00] 256: [0x81 0x00] 1: [0x01] 16383: [0xFE 0x7F] 127: [0x7F] 16384: [0xFF 0x00] 128: [0x80 0x00] 16511: [0xFF 0x7F] 255: [0x80 0x7F] 65535: [0x82 0xFE 0x7F] 2^32: [0x8E 0xFE 0xFE 0xFF 0x00] Mode for encoding VarInts.

Currently there is no support for signed encodings. The default mode will not compile with signed values, and the legacy "nonnegative signed" mode will accept signed values, but improperly encode and decode them if they are negative. In the future, the DEFAULT mode could be extended to support negative numbers in a backwards compatible way, and additional modes could be added to support different varint formats (e.g. zigzag encoding).

Enumerator
DEFAULT 
NONNEGATIVE_SIGNED 

Definition at line 348 of file serialize.h.

Function Documentation

◆ CharCast() [1/4]

char* CharCast ( char *  c)
inline

Safely convert odd char pointer types to standard ones.

Definition at line 51 of file serialize.h.

Here is the caller graph for this function:

◆ CharCast() [2/4]

const char* CharCast ( const char *  c)
inline

Definition at line 53 of file serialize.h.

◆ CharCast() [3/4]

const char* CharCast ( const unsigned char *  c)
inline

Definition at line 54 of file serialize.h.

◆ CharCast() [4/4]

char* CharCast ( unsigned char *  c)
inline

Definition at line 52 of file serialize.h.

◆ GetSerializeSize()

template<typename T >
size_t GetSerializeSize ( const T t,
int  nVersion = 0 
)

Definition at line 1080 of file serialize.h.

Here is the caller graph for this function:

◆ GetSerializeSizeMany()

template<typename... T>
size_t GetSerializeSizeMany ( int  nVersion,
const T &...  t 
)

Definition at line 1086 of file serialize.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetSizeOfCompactSize()

unsigned int GetSizeOfCompactSize ( uint64_t  nSize)
inline

Compact Size size < 253 – 1 byte size <= USHRT_MAX – 3 bytes (253 + 2 bytes) size <= UINT_MAX – 5 bytes (254 + 4 bytes) size > UINT_MAX – 9 bytes (255 + 8 bytes)

Definition at line 240 of file serialize.h.

Here is the caller graph for this function:

◆ GetSizeOfVarInt()

template<VarIntMode Mode, typename I >
unsigned int GetSizeOfVarInt ( n)
inline

Definition at line 360 of file serialize.h.

◆ ReadCompactSize()

template<typename Stream >
uint64_t ReadCompactSize ( Stream &  is,
bool  range_check = true 
)

Decode a CompactSize-encoded variable-length integer.

As these are primarily used to encode the size of vector-like serializations, by default a range check is performed. When used as a generic number encoding, range_check should be set to false.

Definition at line 282 of file serialize.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ReadVarInt()

template<typename Stream , VarIntMode Mode, typename I >
I ReadVarInt ( Stream &  is)

Definition at line 395 of file serialize.h.

Here is the call graph for this function:

◆ ReadWriteAsHelper() [1/2]

template<typename X >
const X& ReadWriteAsHelper ( const X x)

Definition at line 145 of file serialize.h.

◆ ReadWriteAsHelper() [2/2]

template<typename X >
X& ReadWriteAsHelper ( X x)

Convert the reference base type to X, without changing constness or reference type.

Definition at line 144 of file serialize.h.

◆ ser_readdata16()

template<typename Stream >
uint16_t ser_readdata16 ( Stream &  s)
inline

Definition at line 95 of file serialize.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ser_readdata16be()

template<typename Stream >
uint16_t ser_readdata16be ( Stream &  s)
inline

Definition at line 101 of file serialize.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ser_readdata32()

template<typename Stream >
uint32_t ser_readdata32 ( Stream &  s)
inline

Definition at line 107 of file serialize.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ser_readdata32be()

template<typename Stream >
uint32_t ser_readdata32be ( Stream &  s)
inline

Definition at line 113 of file serialize.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ser_readdata64()

template<typename Stream >
uint64_t ser_readdata64 ( Stream &  s)
inline

Definition at line 119 of file serialize.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ser_readdata8()

template<typename Stream >
uint8_t ser_readdata8 ( Stream &  s)
inline

Definition at line 89 of file serialize.h.

Here is the caller graph for this function:

◆ ser_writedata16()

template<typename Stream >
void ser_writedata16 ( Stream &  s,
uint16_t  obj 
)
inline

Definition at line 64 of file serialize.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ser_writedata16be()

template<typename Stream >
void ser_writedata16be ( Stream &  s,
uint16_t  obj 
)
inline

Definition at line 69 of file serialize.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ser_writedata32()

template<typename Stream >
void ser_writedata32 ( Stream &  s,
uint32_t  obj 
)
inline

Definition at line 74 of file serialize.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ser_writedata32be()

template<typename Stream >
void ser_writedata32be ( Stream &  s,
uint32_t  obj 
)
inline

Definition at line 79 of file serialize.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ser_writedata64()

template<typename Stream >
void ser_writedata64 ( Stream &  s,
uint64_t  obj 
)
inline

Definition at line 84 of file serialize.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ser_writedata8()

template<typename Stream >
void ser_writedata8 ( Stream &  s,
uint8_t  obj 
)
inline

Definition at line 60 of file serialize.h.

Here is the caller graph for this function:

◆ Serialize() [1/23]

template<typename Stream , unsigned int N, typename T >
void Serialize ( Stream &  os,
const prevector< N, T > &  v 
)
inline

Definition at line 737 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [2/23]

template<typename Stream , typename C >
void Serialize ( Stream &  os,
const std::basic_string< C > &  str 
)

Forward declarations.

string

Definition at line 701 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [3/23]

template<typename Stream , typename K , typename T , typename Pred , typename A >
void Serialize ( Stream &  os,
const std::map< K, T, Pred, A > &  m 
)

map

Definition at line 862 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [4/23]

template<typename Stream , typename K , typename T >
void Serialize ( Stream &  os,
const std::pair< K, T > &  item 
)

pair

Definition at line 843 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [5/23]

template<typename Stream , typename K , typename Pred , typename A >
void Serialize ( Stream &  os,
const std::set< K, Pred, A > &  m 
)

set

Definition at line 889 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [6/23]

template<typename Stream , typename T >
void Serialize ( Stream &  os,
const std::shared_ptr< const T > &  p 
)

shared_ptr

Definition at line 933 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [7/23]

template<typename Stream , typename T >
void Serialize ( Stream &  os,
const std::unique_ptr< const T > &  p 
)

unique_ptr

Definition at line 916 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [8/23]

template<typename Stream , typename T , typename A >
void Serialize ( Stream &  os,
const std::vector< T, A > &  v 
)
inline

Definition at line 803 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [9/23]

template<typename Stream , typename T >
void Serialize ( Stream &  os,
const T a 
)
inline

If none of the specialized versions above matched, default to calling member function.

Definition at line 668 of file serialize.h.

◆ Serialize() [10/23]

template<typename Stream >
void Serialize ( Stream &  s,
bool  a 
)
inline

Definition at line 229 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [11/23]

template<typename Stream >
void Serialize ( Stream &  s,
char  a 
)
inline

Definition at line 199 of file serialize.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Serialize() [12/23]

template<typename Stream , int N>
void Serialize ( Stream &  s,
const char(&)  a[N] 
)
inline

Definition at line 209 of file serialize.h.

◆ Serialize() [13/23]

template<typename Stream >
void Serialize ( Stream &  s,
const Span< const unsigned char > &  span 
)
inline

Definition at line 211 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [14/23]

template<typename Stream >
void Serialize ( Stream &  s,
const Span< unsigned char > &  span 
)
inline

Definition at line 212 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [15/23]

template<typename Stream , int N>
void Serialize ( Stream &  s,
const unsigned char(&)  a[N] 
)
inline

Definition at line 210 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [16/23]

template<typename Stream >
void Serialize ( Stream &  s,
int16_t  a 
)
inline

Definition at line 203 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [17/23]

template<typename Stream >
void Serialize ( Stream &  s,
int32_t  a 
)
inline

Definition at line 205 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [18/23]

template<typename Stream >
void Serialize ( Stream &  s,
int64_t  a 
)
inline

Definition at line 207 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [19/23]

template<typename Stream >
void Serialize ( Stream &  s,
int8_t  a 
)
inline

Definition at line 201 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [20/23]

template<typename Stream >
void Serialize ( Stream &  s,
uint16_t  a 
)
inline

Definition at line 204 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [21/23]

template<typename Stream >
void Serialize ( Stream &  s,
uint32_t  a 
)
inline

Definition at line 206 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [22/23]

template<typename Stream >
void Serialize ( Stream &  s,
uint64_t  a 
)
inline

Definition at line 208 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [23/23]

template<typename Stream >
void Serialize ( Stream &  s,
uint8_t  a 
)
inline

Definition at line 202 of file serialize.h.

Here is the call graph for this function:

◆ Serialize_impl() [1/5]

template<typename Stream , unsigned int N, typename T >
void Serialize_impl ( Stream &  os,
const prevector< N, T > &  v,
const unsigned char &   
)

prevector prevectors of unsigned char are a special case and are intended to be serialized as a single opaque blob.

prevector

Definition at line 723 of file serialize.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Serialize_impl() [2/5]

template<typename Stream , unsigned int N, typename T , typename V >
void Serialize_impl ( Stream &  os,
const prevector< N, T > &  v,
const V &   
)

Definition at line 731 of file serialize.h.

Here is the call graph for this function:

◆ Serialize_impl() [3/5]

template<typename Stream , typename T , typename A >
void Serialize_impl ( Stream &  os,
const std::vector< T, A > &  v,
const bool &   
)

Definition at line 785 of file serialize.h.

Here is the call graph for this function:

◆ Serialize_impl() [4/5]

template<typename Stream , typename T , typename A >
void Serialize_impl ( Stream &  os,
const std::vector< T, A > &  v,
const unsigned char &   
)

vector vectors of unsigned char are a special case and are intended to be serialized as a single opaque blob.

vector

Definition at line 777 of file serialize.h.

Here is the call graph for this function:

◆ Serialize_impl() [5/5]

template<typename Stream , typename T , typename A , typename V >
void Serialize_impl ( Stream &  os,
const std::vector< T, A > &  v,
const V &   
)

Definition at line 797 of file serialize.h.

Here is the call graph for this function:

◆ SerializeMany() [1/2]

template<typename Stream >
void SerializeMany ( Stream &  s)

Definition at line 1011 of file serialize.h.

Here is the caller graph for this function:

◆ SerializeMany() [2/2]

template<typename Stream , typename Arg , typename... Args>
void SerializeMany ( Stream &  s,
const Arg &  arg,
const Args &...  args 
)

Definition at line 1016 of file serialize.h.

Here is the call graph for this function:

◆ SerRead() [1/2]

template<typename Stream , typename Type , typename Fn >
void SerRead ( Stream &  s,
CSerActionSerialize  ser_action,
Type &&  ,
Fn &&   
)
inline

Definition at line 1047 of file serialize.h.

◆ SerRead() [2/2]

template<typename Stream , typename Type , typename Fn >
void SerRead ( Stream &  s,
CSerActionUnserialize  ser_action,
Type &&  obj,
Fn &&  fn 
)
inline

Definition at line 1052 of file serialize.h.

◆ SerReadWriteMany() [1/2]

template<typename Stream , typename... Args>
void SerReadWriteMany ( Stream &  s,
CSerActionSerialize  ser_action,
const Args &...  args 
)
inline

Definition at line 1035 of file serialize.h.

Here is the call graph for this function:

◆ SerReadWriteMany() [2/2]

template<typename Stream , typename... Args>
void SerReadWriteMany ( Stream &  s,
CSerActionUnserialize  ser_action,
Args &&...  args 
)
inline

Definition at line 1041 of file serialize.h.

Here is the call graph for this function:

◆ SerWrite() [1/2]

template<typename Stream , typename Type , typename Fn >
void SerWrite ( Stream &  s,
CSerActionSerialize  ser_action,
Type &&  obj,
Fn &&  fn 
)
inline

Definition at line 1058 of file serialize.h.

◆ SerWrite() [2/2]

template<typename Stream , typename Type , typename Fn >
void SerWrite ( Stream &  s,
CSerActionUnserialize  ser_action,
Type &&  ,
Fn &&   
)
inline

Definition at line 1064 of file serialize.h.

◆ Unserialize() [1/22]

template<typename Stream , unsigned int N, typename T >
void Unserialize ( Stream &  is,
prevector< N, T > &  v 
)
inline

Definition at line 766 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [2/22]

template<typename Stream , typename C >
void Unserialize ( Stream &  is,
std::basic_string< C > &  str 
)

Definition at line 709 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [3/22]

template<typename Stream , typename K , typename T , typename Pred , typename A >
void Unserialize ( Stream &  is,
std::map< K, T, Pred, A > &  m 
)

Definition at line 870 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [4/22]

template<typename Stream , typename K , typename T >
void Unserialize ( Stream &  is,
std::pair< K, T > &  item 
)

Definition at line 850 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [5/22]

template<typename Stream , typename K , typename Pred , typename A >
void Unserialize ( Stream &  is,
std::set< K, Pred, A > &  m 
)

Definition at line 897 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [6/22]

template<typename Stream , typename T , typename A >
void Unserialize ( Stream &  is,
std::vector< T, A > &  v 
)
inline

Definition at line 832 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [7/22]

template<typename Stream , typename T >
void Unserialize ( Stream &  is,
T &&  a 
)
inline

Definition at line 674 of file serialize.h.

◆ Unserialize() [8/22]

template<typename Stream , typename T >
void Unserialize ( Stream &  os,
std::shared_ptr< const T > &  p 
)

Definition at line 939 of file serialize.h.

◆ Unserialize() [9/22]

template<typename Stream , typename T >
void Unserialize ( Stream &  os,
std::unique_ptr< const T > &  p 
)

Definition at line 922 of file serialize.h.

◆ Unserialize() [10/22]

template<typename Stream >
void Unserialize ( Stream &  s,
bool &  a 
)
inline

Definition at line 230 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [11/22]

template<typename Stream >
void Unserialize ( Stream &  s,
char &  a 
)
inline

Definition at line 215 of file serialize.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Unserialize() [12/22]

template<typename Stream , int N>
void Unserialize ( Stream &  s,
char(&)  a[N] 
)
inline

Definition at line 225 of file serialize.h.

◆ Unserialize() [13/22]

template<typename Stream >
void Unserialize ( Stream &  s,
int16_t &  a 
)
inline

Definition at line 219 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [14/22]

template<typename Stream >
void Unserialize ( Stream &  s,
int32_t &  a 
)
inline

Definition at line 221 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [15/22]

template<typename Stream >
void Unserialize ( Stream &  s,
int64_t &  a 
)
inline

Definition at line 223 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [16/22]

template<typename Stream >
void Unserialize ( Stream &  s,
int8_t &  a 
)
inline

Definition at line 217 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [17/22]

template<typename Stream >
void Unserialize ( Stream &  s,
Span< unsigned char > &  span 
)
inline

Definition at line 227 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [18/22]

template<typename Stream >
void Unserialize ( Stream &  s,
uint16_t &  a 
)
inline

Definition at line 220 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [19/22]

template<typename Stream >
void Unserialize ( Stream &  s,
uint32_t &  a 
)
inline

Definition at line 222 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [20/22]

template<typename Stream >
void Unserialize ( Stream &  s,
uint64_t &  a 
)
inline

Definition at line 224 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [21/22]

template<typename Stream >
void Unserialize ( Stream &  s,
uint8_t &  a 
)
inline

Definition at line 218 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [22/22]

template<typename Stream , int N>
void Unserialize ( Stream &  s,
unsigned char(&)  a[N] 
)
inline

Definition at line 226 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize_impl() [1/4]

template<typename Stream , unsigned int N, typename T >
void Unserialize_impl ( Stream &  is,
prevector< N, T > &  v,
const unsigned char &   
)

Definition at line 744 of file serialize.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Unserialize_impl() [2/4]

template<typename Stream , unsigned int N, typename T , typename V >
void Unserialize_impl ( Stream &  is,
prevector< N, T > &  v,
const V &   
)

Definition at line 760 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize_impl() [3/4]

template<typename Stream , typename T , typename A >
void Unserialize_impl ( Stream &  is,
std::vector< T, A > &  v,
const unsigned char &   
)

Definition at line 810 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize_impl() [4/4]

template<typename Stream , typename T , typename A , typename V >
void Unserialize_impl ( Stream &  is,
std::vector< T, A > &  v,
const V &   
)

Definition at line 826 of file serialize.h.

Here is the call graph for this function:

◆ UnserializeMany() [1/2]

template<typename Stream >
void UnserializeMany ( Stream &  s)
inline

Definition at line 1023 of file serialize.h.

Here is the caller graph for this function:

◆ UnserializeMany() [2/2]

template<typename Stream , typename Arg , typename... Args>
void UnserializeMany ( Stream &  s,
Arg &&  arg,
Args &&...  args 
)
inline

Definition at line 1028 of file serialize.h.

Here is the call graph for this function:

◆ Using()

template<typename Formatter , typename T >
static Wrapper<Formatter, T&> Using ( T &&  t)
inlinestatic

Cause serialization/deserialization of an object to be done using a specified formatter class.

To use this, you need a class Formatter that has public functions Ser(stream, const object&) for serialization, and Unser(stream, object&) for deserialization. Serialization routines (inside READWRITE, or directly with << and >> operators), can then use Using<Formatter>(object).

This works by constructing a Wrapper<Formatter, T>-wrapped version of object, where T is const during serialization, and non-const during deserialization, which maintains const correctness.

Definition at line 440 of file serialize.h.

Here is the caller graph for this function:

◆ WriteCompactSize() [1/2]

void WriteCompactSize ( CSizeComputer os,
uint64_t  nSize 
)
inline

Definition at line 1074 of file serialize.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WriteCompactSize() [2/2]

template<typename Stream >
void WriteCompactSize ( Stream &  os,
uint64_t  nSize 
)

Definition at line 251 of file serialize.h.

Here is the call graph for this function:

◆ WriteVarInt() [1/2]

template<typename I >
void WriteVarInt ( CSizeComputer os,
n 
)
inline

Definition at line 1069 of file serialize.h.

Here is the call graph for this function:

◆ WriteVarInt() [2/2]

template<typename Stream , VarIntMode Mode, typename I >
void WriteVarInt ( Stream &  os,
n 
)

Definition at line 377 of file serialize.h.

Here is the call graph for this function:

Variable Documentation

◆ deserialize

constexpr deserialize_type deserialize {}
constexpr

Definition at line 48 of file serialize.h.

◆ MAX_SIZE

constexpr uint64_t MAX_SIZE = 0x02000000
staticconstexpr

The maximum size of a serialized object in bytes or number of elements (for eg vectors) when the size is encoded as CompactSize.

Definition at line 31 of file serialize.h.

◆ MAX_VECTOR_ALLOCATE

const unsigned int MAX_VECTOR_ALLOCATE = 5000000
static

Maximum amount of memory (in bytes) to allocate at once when deserializing vectors.

Definition at line 34 of file serialize.h.

CSerActionSerialize
Support for SERIALIZE_METHODS and READWRITE macro.
Definition: serialize.h:949
CSerActionUnserialize
Definition: serialize.h:953
Unserialize
void Unserialize(Stream &s, char &a)
Definition: serialize.h:215
Serialize
void Serialize(Stream &s, char a)
Definition: serialize.h:199