#include <compat/assumptions.h>
#include <compat/endian.h>
#include <prevector.h>
#include <rcu.h>
#include <span.h>
#include <algorithm>
#include <array>
#include <concepts>
#include <cstdint>
#include <cstring>
#include <ios>
#include <limits>
#include <map>
#include <memory>
#include <set>
#include <string>
#include <utility>
#include <vector>

Include dependency graph for serialize.h:

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	ChronoFormatter< U, LOSSY >

struct	LimitedStringFormatter< Limit >

struct	VectorFormatter< Formatter >
	Formatter to serialize/deserialize vector elements using another formatter. More...

class	DifferenceFormatter
	Helper for differentially encoded Compact Size integers in lists. More...

struct	DifferentialIndexedItemFormatter
	Helper for a list of items containing a differentially encoded index as their first member. More...

struct	DefaultFormatter
	Default formatter. More...

struct	CSerActionSerialize
	Support for SERIALIZE_METHODS and READWRITE macro. More...

struct	CSerActionUnserialize

class	CSizeComputer
	GetSerializeSize implementations More...

Concepts
concept	CharNotInt8

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

concept	Unserializable

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)

#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 >

template<typename U >
using	LossyChronoFormatter = ChronoFormatter< U, true >

Enumerations
enum	{ SER_NETWORK = (1 << 0) , SER_DISK = (1 << 1) , SER_GETHASH = (1 << 2) }

enum class	VarIntMode { DEFAULT , NONNEGATIVE_SIGNED }
	Variable-length integers: bytes are a MSB base-128 encoding of the number. More...

Functions
template<typename Stream >
void	ser_writedata8 (Stream &s, uint8_t obj)
	Lowest-level serialization and conversion. More...

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)

uint64_t	ser_double_to_uint64 (double x)

uint32_t	ser_float_to_uint32 (float x)

double	ser_uint64_to_double (uint64_t y)

float	ser_uint32_to_float (uint32_t y)

template<typename X >
X &	ReadWriteAsHelper (X &x)
	Convert the reference base type to X, without changing constness or reference type. More...

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

template<typename Stream , CharNotInt8 V>
void	Serialize (Stream &, V)=delete

template<typename Stream >
void	Serialize (Stream &s, std::byte 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 >
void	Serialize (Stream &s, float a)

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

template<typename Stream , size_t N>
void	Serialize (Stream &s, const int8_t(&a)[N])

template<typename Stream , BasicByte B, size_t N>
void	Serialize (Stream &s, const B(&a)[N])

template<typename Stream , size_t N>
void	Serialize (Stream &s, const std::array< int8_t, N > &a)

template<typename Stream , size_t N>
void	Serialize (Stream &s, const std::array< uint8_t, N > &a)

template<typename Stream , BasicByte B, std::size_t N>
void	Serialize (Stream &s, const std::array< B, N > &a)

template<typename Stream , BasicByte B>
void	Serialize (Stream &s, Span< B > span)

template<typename Stream , CharNotInt8 V>
void	Unserialize (Stream &, V)=delete

template<typename Stream >
void	Unserialize (Stream &s, std::byte &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 >
void	Unserialize (Stream &s, float &a)

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

template<typename Stream , size_t N>
void	Unserialize (Stream &s, int8_t(&a)[N])

template<typename Stream , BasicByte B, size_t N>
void	Unserialize (Stream &s, B(&a)[N])

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

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

template<typename Stream , BasicByte B, std::size_t N>
void	Unserialize (Stream &s, std::array< B, N > &a)

template<typename Stream , BasicByte B>
void	Unserialize (Stream &s, Span< B > span)

uint32_t	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 >
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 (Stream &os, const prevector< N, T > &v)
	prevector More...

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 (Stream &os, const std::vector< T, A > &v)
	vector More...

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 RCUPtr< const T > &p)
	RCUPtr. More...

template<typename Stream , typename T >
void	Unserialize (Stream &os, RCUPtr< const T > &p)

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

template<typename Stream , typename T > requires Unserializable<T, Stream>
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 570 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 196 of file serialize.h.

◆ LIMITED_STRING

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

Definition at line 571 of file serialize.h.

◆ READWRITE

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

Definition at line 168 of file serialize.h.

◆ READWRITEAS

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

Definition at line 169 of file serialize.h.

◆ SER_READ

#define SER_READ	(	obj,
		code
	)

Value:

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

Definition at line 171 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 175 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 215 of file serialize.h.

◆ VARINT

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

Definition at line 569 of file serialize.h.

◆ VARINT_MODE

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

Definition at line 568 of file serialize.h.

Typedef Documentation

◆ BigEndianFormatter

template<int Bytes>

using BigEndianFormatter = CustomUintFormatter<Bytes, true>

Definition at line 634 of file serialize.h.

◆ LossyChronoFormatter

template<typename U >

using LossyChronoFormatter = ChronoFormatter<U, true>

Definition at line 673 of file serialize.h.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Enumerator
SER_NETWORK
SER_DISK
SER_GETHASH

Definition at line 152 of file serialize.h.

◆ VarIntMode

enum class 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 464 of file serialize.h.

Function Documentation

◆ GetSerializeSize()

template<typename T >

size_t GetSerializeSize	(	const T &	t,
		int	nVersion = `0`
	)

Definition at line 1207 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 1212 of file serialize.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSizeOfCompactSize()

uint32_t 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 363 of file serialize.h.

Here is the caller graph for this function:

◆ GetSizeOfVarInt()

template<VarIntMode Mode, typename I >

unsigned int GetSizeOfVarInt ( I n )

inline

Definition at line 477 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 403 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 510 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 164 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 161 of file serialize.h.

◆ ser_double_to_uint64()

uint64_t ser_double_to_uint64 ( double x )

inline

Definition at line 115 of file serialize.h.

Here is the caller graph for this function:

◆ ser_float_to_uint32()

uint32_t ser_float_to_uint32 ( float x )

inline

Definition at line 122 of file serialize.h.

Here is the caller graph for this function:

◆ ser_readdata16()

template<typename Stream >

uint16_t ser_readdata16 ( Stream & s )

inline

Definition at line 90 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 95 of file serialize.h.

Here is the call graph for this function:

◆ ser_readdata32()

template<typename Stream >

uint32_t ser_readdata32 ( Stream & s )

inline

Definition at line 100 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 105 of file serialize.h.

Here is the call graph for this function:

◆ ser_readdata64()

template<typename Stream >

uint64_t ser_readdata64 ( Stream & s )

inline

Definition at line 110 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 85 of file serialize.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ser_uint32_to_float()

float ser_uint32_to_float ( uint32_t y )

inline

Definition at line 136 of file serialize.h.

Here is the caller graph for this function:

◆ ser_uint64_to_double()

double ser_uint64_to_double ( uint64_t y )

inline

Definition at line 129 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 61 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 66 of file serialize.h.

Here is the call graph for this function:

◆ ser_writedata32()

template<typename Stream >

void ser_writedata32	(	Stream &	s,
		uint32_t	obj
	)

inline

Definition at line 71 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 76 of file serialize.h.

Here is the call graph for this function:

◆ ser_writedata64()

template<typename Stream >

void ser_writedata64	(	Stream &	s,
		uint64_t	obj
	)

inline

Definition at line 81 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

Lowest-level serialization and conversion.

Definition at line 57 of file serialize.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Serialize() [1/29]

template<typename Stream , CharNotInt8 V>

void Serialize	(	Stream &	,
		V
	)

delete

Here is the caller graph for this function:

◆ Serialize() [2/29]

template<typename Stream , unsigned int N, typename T >

void Serialize	(	Stream &	os,
		const prevector< N, T > &	v
	)

inline

prevector

Definition at line 933 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [3/29]

template<typename Stream , typename T >

void Serialize	(	Stream &	os,
		const RCUPtr< const T > &	p
	)

RCUPtr.

Definition at line 1096 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [4/29]

template<typename Stream , typename C >

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

Forward declarations.

string

Definition at line 913 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [5/29]

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 1024 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [6/29]

template<typename Stream , typename K , typename T >

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

pair

Definition at line 1009 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [7/29]

template<typename Stream , typename K , typename Pred , typename A >

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

set

Definition at line 1047 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [8/29]

template<typename Stream , typename T >

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

shared_ptr

Definition at line 1083 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [9/29]

template<typename Stream , typename T >

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

unique_ptr

Definition at line 1070 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [10/29]

template<typename Stream , typename T , typename A >

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

inline

vector

Definition at line 966 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [11/29]

template<typename Stream , typename T >
requires Serializable<T, Stream>

void Serialize	(	Stream &	os,
		const T &	a
	)

Definition at line 880 of file serialize.h.

◆ Serialize() [12/29]

template<typename Stream >

void Serialize	(	Stream &	s,
		bool	a
	)

inline

Definition at line 339 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [13/29]

template<typename Stream , BasicByte B, size_t N>

void Serialize	(	Stream &	s,
		const B(&)	a[N]
	)

Definition at line 274 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [14/29]

template<typename Stream , size_t N>

void Serialize	(	Stream &	s,
		const int8_t(&)	a[N]
	)

inline

Definition at line 270 of file serialize.h.

◆ Serialize() [15/29]

template<typename Stream , BasicByte B, std::size_t N>

void Serialize	(	Stream &	s,
		const std::array< B, N > &	a
	)

Definition at line 286 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [16/29]

template<typename Stream , size_t N>

void Serialize	(	Stream &	s,
		const std::array< int8_t, N > &	a
	)

inline

Definition at line 278 of file serialize.h.

◆ Serialize() [17/29]

template<typename Stream , size_t N>

void Serialize	(	Stream &	s,
		const std::array< uint8_t, N > &	a
	)

inline

Definition at line 282 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [18/29]

template<typename Stream >

void Serialize	(	Stream &	s,
		double	a
	)

inline

Definition at line 266 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [19/29]

template<typename Stream >

void Serialize	(	Stream &	s,
		float	a
	)

inline

Definition at line 263 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [20/29]

template<typename Stream >

void Serialize	(	Stream &	s,
		int16_t	a
	)

inline

Definition at line 245 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [21/29]

template<typename Stream >

void Serialize	(	Stream &	s,
		int32_t	a
	)

inline

Definition at line 251 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [22/29]

template<typename Stream >

void Serialize	(	Stream &	s,
		int64_t	a
	)

inline

Definition at line 257 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [23/29]

template<typename Stream >

void Serialize	(	Stream &	s,
		int8_t	a
	)

inline

Definition at line 239 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [24/29]

template<typename Stream , BasicByte B>

void Serialize	(	Stream &	s,
		Span< B >	span
	)

Definition at line 290 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [25/29]

template<typename Stream >

void Serialize	(	Stream &	s,
		std::byte	a
	)

Definition at line 236 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [26/29]

template<typename Stream >

void Serialize	(	Stream &	s,
		uint16_t	a
	)

inline

Definition at line 248 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [27/29]

template<typename Stream >

void Serialize	(	Stream &	s,
		uint32_t	a
	)

inline

Definition at line 254 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [28/29]

template<typename Stream >

void Serialize	(	Stream &	s,
		uint64_t	a
	)

inline

Definition at line 260 of file serialize.h.

Here is the call graph for this function:

◆ Serialize() [29/29]

template<typename Stream >

void Serialize	(	Stream &	s,
		uint8_t	a
	)

inline

Definition at line 242 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 1151 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 1154 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 1180 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 1184 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 1168 of file serialize.h.

Here is the call graph for this function:

Here is the caller 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 1174 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 1190 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 1196 of file serialize.h.

◆ Unserialize() [1/27]

template<typename Stream , CharNotInt8 V>

void Unserialize	(	Stream &	,
		V
	)

delete

Here is the caller graph for this function:

◆ Unserialize() [2/27]

template<typename Stream , unsigned int N, typename T >

void Unserialize	(	Stream &	is,
		prevector< N, T > &	v
	)

inline

Definition at line 944 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [3/27]

template<typename Stream , typename C >

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

Definition at line 921 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [4/27]

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 1032 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [5/27]

template<typename Stream , typename K , typename T >

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

Definition at line 1015 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [6/27]

template<typename Stream , typename K , typename Pred , typename A >

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

Definition at line 1055 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [7/27]

template<typename Stream , typename T , typename A >

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

inline

Definition at line 987 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [8/27]

template<typename Stream , typename T >
requires Unserializable<T, Stream>

void Unserialize	(	Stream &	is,
		T &&	a
	)

Definition at line 888 of file serialize.h.

◆ Unserialize() [9/27]

template<typename Stream , typename T >

void Unserialize	(	Stream &	os,
		RCUPtr< const T > &	p
	)

Definition at line 1101 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [10/27]

template<typename Stream , typename T >

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

Definition at line 1088 of file serialize.h.

◆ Unserialize() [11/27]

template<typename Stream , typename T >

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

Definition at line 1075 of file serialize.h.

◆ Unserialize() [12/27]

template<typename Stream , BasicByte B, size_t N>

void Unserialize	(	Stream &	s,
		B(&)	a[N]
	)

Definition at line 335 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [13/27]

template<typename Stream >

void Unserialize	(	Stream &	s,
		bool &	a
	)

inline

Definition at line 343 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [14/27]

template<typename Stream >

void Unserialize	(	Stream &	s,
		double &	a
	)

inline

Definition at line 327 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [15/27]

template<typename Stream >

void Unserialize	(	Stream &	s,
		float &	a
	)

inline

Definition at line 324 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [16/27]

template<typename Stream >

void Unserialize	(	Stream &	s,
		int16_t &	a
	)

inline

Definition at line 306 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [17/27]

template<typename Stream >

void Unserialize	(	Stream &	s,
		int32_t &	a
	)

inline

Definition at line 312 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [18/27]

template<typename Stream >

void Unserialize	(	Stream &	s,
		int64_t &	a
	)

inline

Definition at line 318 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [19/27]

template<typename Stream >

void Unserialize	(	Stream &	s,
		int8_t &	a
	)

inline

Definition at line 300 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [20/27]

template<typename Stream , size_t N>

void Unserialize	(	Stream &	s,
		int8_t(&)	a[N]
	)

inline

Definition at line 331 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [21/27]

template<typename Stream , BasicByte B>

void Unserialize	(	Stream &	s,
		Span< B >	span
	)

Definition at line 352 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [22/27]

template<typename Stream , BasicByte B, std::size_t N>

void Unserialize	(	Stream &	s,
		std::array< B, N > &	a
	)

Definition at line 348 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [23/27]

template<typename Stream >

void Unserialize	(	Stream &	s,
		std::byte &	a
	)

Definition at line 297 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [24/27]

template<typename Stream >

void Unserialize	(	Stream &	s,
		uint16_t &	a
	)

inline

Definition at line 309 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [25/27]

template<typename Stream >

void Unserialize	(	Stream &	s,
		uint32_t &	a
	)

inline

Definition at line 315 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [26/27]

template<typename Stream >

void Unserialize	(	Stream &	s,
		uint64_t &	a
	)

inline

Definition at line 321 of file serialize.h.

Here is the call graph for this function:

◆ Unserialize() [27/27]

template<typename Stream >

void Unserialize	(	Stream &	s,
		uint8_t &	a
	)

inline

Definition at line 303 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 1159 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 1162 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 564 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 1203 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 379 of file serialize.h.

Here is the call graph for this function:

◆ WriteVarInt() [1/2]

template<typename I >

void WriteVarInt	(	CSizeComputer &	os,
		I	n
	)

inline

Definition at line 1199 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,
		I	n
	)

Definition at line 492 of file serialize.h.

Here is the call graph for this function:

Variable Documentation

◆ deserialize

constexpr deserialize_type deserialize {}

constexpr

Definition at line 52 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 33 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 39 of file serialize.h.

Classes

Concepts

Macros

Typedefs

Enumerations

Functions

Variables

Macro Definition Documentation

◆ COMPACTSIZE

◆ FORMATTER_METHODS

◆ LIMITED_STRING

◆ READWRITE

◆ READWRITEAS

◆ SER_READ

◆ SER_WRITE

◆ SERIALIZE_METHODS

◆ VARINT

◆ VARINT_MODE

Typedef Documentation

◆ BigEndianFormatter

◆ LossyChronoFormatter

Enumeration Type Documentation

◆ anonymous enum

◆ VarIntMode

Function Documentation

◆ GetSerializeSize()

◆ GetSerializeSizeMany()

◆ GetSizeOfCompactSize()

◆ GetSizeOfVarInt()

◆ ReadCompactSize()

◆ ReadVarInt()

◆ ReadWriteAsHelper() [1/2]

◆ ReadWriteAsHelper() [2/2]

◆ ser_double_to_uint64()

◆ ser_float_to_uint32()

◆ ser_readdata16()

◆ ser_readdata16be()

◆ ser_readdata32()

◆ ser_readdata32be()

◆ ser_readdata64()

◆ ser_readdata8()

◆ ser_uint32_to_float()

◆ ser_uint64_to_double()

◆ ser_writedata16()

◆ ser_writedata16be()

◆ ser_writedata32()

◆ ser_writedata32be()

◆ ser_writedata64()

◆ ser_writedata8()

◆ Serialize() [1/29]

◆ Serialize() [2/29]

◆ Serialize() [3/29]

◆ Serialize() [4/29]

◆ Serialize() [5/29]

◆ Serialize() [6/29]

◆ Serialize() [7/29]

◆ Serialize() [8/29]

◆ Serialize() [9/29]

◆ Serialize() [10/29]

◆ Serialize() [11/29]

◆ Serialize() [12/29]

◆ Serialize() [13/29]

◆ Serialize() [14/29]

◆ Serialize() [15/29]

◆ Serialize() [16/29]

◆ Serialize() [17/29]

◆ Serialize() [18/29]

◆ Serialize() [19/29]

◆ Serialize() [20/29]

◆ Serialize() [21/29]

◆ Serialize() [22/29]

◆ Serialize() [23/29]

◆ Serialize() [24/29]

◆ Serialize() [25/29]

◆ Serialize() [26/29]

◆ Serialize() [27/29]

◆ Serialize() [28/29]

◆ Serialize() [29/29]

◆ SerializeMany() [1/2]

◆ SerializeMany() [2/2]