A helper class for serializing and deserialization of the RNTuple binary format.

All serialization and deserialization routines return the number of bytes processed (written or read).

The serialization routines can be called with a nullptr buffer, in which case only the size required to perform a serialization is returned. Deserialization routines must be called with a buffer that is sufficiently large.

Deserialization errors throw exceptions. Only when indicated or when passed as a parameter is the buffer size checked.

Definition at line 64 of file RNTupleSerialize.hxx.

Classes
struct	RClusterGroup

struct	RClusterSummary

class	RContext
	The serialization context is used for the piecewise serialization of a descriptor. More...

struct	REnvelopeLink

Public Types
enum class	EDescriptorDeserializeMode { kRaw , kForWriting , kForReading }

using	StreamerInfoMap_t = std::map<Int_t, TVirtualStreamerInfo *>

Static Public Member Functions
static RResult< std::uint32_t >	DeserializeAttributeSet (const void *buffer, std::uint64_t bufSize, Experimental::Internal::RNTupleAttrSetDescriptorBuilder &attrSetDescBld)

static RResult< std::uint32_t >	DeserializeClusterGroup (const void *buffer, std::uint64_t bufSize, RClusterGroup &clusterGroup)

static RResult< std::uint32_t >	DeserializeClusterSummary (const void *buffer, std::uint64_t bufSize, RClusterSummary &clusterSummary)

static RResult< std::uint32_t >	DeserializeColumnType (const void *buffer, ROOT::ENTupleColumnType &type)

static RResult< std::uint32_t >	DeserializeEnvelope (const void *buffer, std::uint64_t bufSize, std::uint16_t expectedType)

static RResult< std::uint32_t >	DeserializeEnvelope (const void *buffer, std::uint64_t bufSize, std::uint16_t expectedType, std::uint64_t &xxhash3)

static RResult< std::uint32_t >	DeserializeEnvelopeLink (const void *buffer, std::uint64_t bufSize, REnvelopeLink &envelopeLink)

static RResult< std::uint32_t >	DeserializeExtraTypeInfoId (const void *buffer, ROOT::EExtraTypeInfoIds &id)

static RResult< std::uint32_t >	DeserializeFeatureFlags (const void *buffer, std::uint64_t bufSize, std::vector< std::uint64_t > &flags)

static RResult< std::uint32_t >	DeserializeFieldStructure (const void *buffer, ROOT::ENTupleStructure &structure)

static RResult< void >	DeserializeFooter (const void *buffer, std::uint64_t bufSize, ROOT::Internal::RNTupleDescriptorBuilder &descBuilder)

static RResult< std::uint32_t >	DeserializeFrameHeader (const void *buffer, std::uint64_t bufSize, std::uint64_t &frameSize)

static RResult< std::uint32_t >	DeserializeFrameHeader (const void *buffer, std::uint64_t bufSize, std::uint64_t &frameSize, std::uint32_t &nitems)

static RResult< void >	DeserializeHeader (const void *buffer, std::uint64_t bufSize, ROOT::Internal::RNTupleDescriptorBuilder &descBuilder)

static std::uint32_t	DeserializeInt16 (const void *buffer, std::int16_t &val)

static std::uint32_t	DeserializeInt32 (const void *buffer, std::int32_t &val)

static std::uint32_t	DeserializeInt64 (const void *buffer, std::int64_t &val)

static RResult< std::uint32_t >	DeserializeLocator (const void *buffer, std::uint64_t bufSize, RNTupleLocator &locator)

static RResult< void >	DeserializePageList (const void *buffer, std::uint64_t bufSize, ROOT::DescriptorId_t clusterGroupId, RNTupleDescriptor &desc, EDescriptorDeserializeMode mode)

static RResult< std::uint32_t >	DeserializeSchemaDescription (const void *buffer, std::uint64_t bufSize, ROOT::Internal::RNTupleDescriptorBuilder &descBuilder)

static RResult< StreamerInfoMap_t >	DeserializeStreamerInfos (const std::string &extraTypeInfoContent)

static RResult< std::uint32_t >	DeserializeString (const void *buffer, std::uint64_t bufSize, std::string &val)

static std::uint32_t	DeserializeUInt16 (const void *buffer, std::uint16_t &val)

static std::uint32_t	DeserializeUInt32 (const void *buffer, std::uint32_t &val)

static std::uint32_t	DeserializeUInt64 (const void *buffer, std::uint64_t &val)

static RResult< std::uint32_t >	SerializeAttributeSet (const Experimental::RNTupleAttrSetDescriptor &attrSetDesc, void *buffer)

static RResult< std::uint32_t >	SerializeClusterGroup (const RClusterGroup &clusterGroup, void *buffer)

static RResult< std::uint32_t >	SerializeClusterSummary (const RClusterSummary &clusterSummary, void *buffer)

static RResult< std::uint32_t >	SerializeColumnType (ROOT::ENTupleColumnType type, void *buffer)

static RResult< std::uint32_t >	SerializeEnvelopeLink (const REnvelopeLink &envelopeLink, void *buffer)

static RResult< std::uint32_t >	SerializeEnvelopePostscript (unsigned char *envelope, std::uint64_t size)

static RResult< std::uint32_t >	SerializeEnvelopePostscript (unsigned char *envelope, std::uint64_t size, std::uint64_t &xxhash3)

static std::uint32_t	SerializeEnvelopePreamble (std::uint16_t envelopeType, void *buffer)

static RResult< std::uint32_t >	SerializeExtraTypeInfoId (ROOT::EExtraTypeInfoIds id, void *buffer)

static RResult< std::uint32_t >	SerializeFeatureFlags (const std::vector< std::uint64_t > &flags, void *buffer)

static RResult< std::uint32_t >	SerializeFieldStructure (ROOT::ENTupleStructure structure, void *buffer)
	While we could just interpret the enums as ints, we make the translation explicit in order to avoid accidentally changing the on-disk numbers when adjusting the enum classes.

static RResult< std::uint32_t >	SerializeFooter (void *buffer, const RNTupleDescriptor &desc, const RContext &context)

static RResult< std::uint32_t >	SerializeFramePostscript (void *frame, std::uint64_t size)

static RResult< RContext >	SerializeHeader (void *buffer, const RNTupleDescriptor &desc)

static std::uint32_t	SerializeInt16 (std::int16_t val, void *buffer)

static std::uint32_t	SerializeInt32 (std::int32_t val, void *buffer)

static std::uint32_t	SerializeInt64 (std::int64_t val, void *buffer)

static std::uint32_t	SerializeListFramePreamble (std::uint32_t nitems, void *buffer)

static RResult< std::uint32_t >	SerializeLocator (const RNTupleLocator &locator, void *buffer)

static RResult< std::uint32_t >	SerializePageList (void *buffer, const RNTupleDescriptor &desc, std::span< ROOT::DescriptorId_t > physClusterIDs, const RContext &context)

static std::uint32_t	SerializeRecordFramePreamble (void *buffer)

static RResult< std::uint32_t >	SerializeSchemaDescription (void *buffer, const RNTupleDescriptor &desc, const RContext &context, bool forHeaderExtension=false)
	Serialize the schema description in `desc` into `buffer`.

static std::string	SerializeStreamerInfos (const StreamerInfoMap_t &infos)

static std::uint32_t	SerializeString (const std::string &val, void *buffer)

static std::uint32_t	SerializeUInt16 (std::uint16_t val, void *buffer)

static std::uint32_t	SerializeUInt32 (std::uint32_t val, void *buffer)

static std::uint32_t	SerializeUInt64 (std::uint64_t val, void *buffer)

static std::uint32_t	SerializeXxHash3 (const unsigned char data, std::uint64_t length, std::uint64_t &xxhash3, void buffer)
	Writes a XxHash-3 64bit checksum of the byte range given by data and length.

static RResult< void >	VerifyXxHash3 (const unsigned char *data, std::uint64_t length)

static RResult< void >	VerifyXxHash3 (const unsigned char *data, std::uint64_t length, std::uint64_t &xxhash3)
	Expects an xxhash3 checksum in the 8 bytes following data + length and verifies it.

Static Public Attributes
static constexpr std::uint16_t	kEnvelopeTypeFooter = 0x02

static constexpr std::uint16_t	kEnvelopeTypeHeader = 0x01

static constexpr std::uint16_t	kEnvelopeTypePageList = 0x03

static constexpr std::uint16_t	kFlagDeferredColumn = 0x01

static constexpr std::uint16_t	kFlagHasTypeChecksum = 0x04

static constexpr std::uint16_t	kFlagHasValueRange = 0x02

static constexpr std::uint16_t	kFlagIsSoACollection = 0x08

static constexpr std::uint16_t	kFlagProjectedField = 0x02

static constexpr std::uint16_t	kFlagRepetitiveField = 0x01

static constexpr int64_t	kSuppressedColumnMarker = std::numeric_limits<std::int64_t>::min()

static constexpr ROOT::DescriptorId_t	kZeroFieldId = std::uint64_t(-2)

Static Private Member Functions
static RResult< std::vector< ROOT::Internal::RClusterDescriptorBuilder > >	DeserializePageListRaw (const void *buffer, std::uint64_t bufSize, ROOT::DescriptorId_t clusterGroupId, const RNTupleDescriptor &desc)

#include <ROOT/RNTupleSerialize.hxx>

Member Typedef Documentation

◆ StreamerInfoMap_t

using ROOT::Internal::RNTupleSerializer::StreamerInfoMap_t = std::map<Int_t, TVirtualStreamerInfo *>

Definition at line 88 of file RNTupleSerialize.hxx.

Member Enumeration Documentation

◆ EDescriptorDeserializeMode

enum class ROOT::Internal::RNTupleSerializer::EDescriptorDeserializeMode

strong

Enumerator

kRaw

Deserializes the descriptor as-is without performing any additional fixup.

The produced descriptor is unsuitable for reading or writing, but it's a faithful representation of the on-disk information.

kForWriting

Deserializes the descriptor and performs fixup on the suppressed column ranges.

This produces a descriptor that is suitable for writing, but not reading.

kForReading

Deserializes the descriptor and performs fixup on the suppressed column ranges and on clusters, taking into account the header extension.

This produces a descriptor that is suitable for reading.

Definition at line 298 of file RNTupleSerialize.hxx.

Member Function Documentation

◆ DeserializeAttributeSet()

ROOT::RResult< std::uint32_t > ROOT::Internal::RNTupleSerializer::DeserializeAttributeSet	(	const void *	buffer,
		std::uint64_t	bufSize,
		Experimental::Internal::RNTupleAttrSetDescriptorBuilder &	attrSetDescBld )

static

Definition at line 2099 of file RNTupleSerialize.cxx.

◆ DeserializeClusterGroup()

ROOT::RResult< std::uint32_t > ROOT::Internal::RNTupleSerializer::DeserializeClusterGroup	(	const void *	buffer,
		std::uint64_t	bufSize,
		RClusterGroup &	clusterGroup )

static

Definition at line 1331 of file RNTupleSerialize.cxx.

◆ DeserializeClusterSummary()

ROOT::RResult< std::uint32_t > ROOT::Internal::RNTupleSerializer::DeserializeClusterSummary	(	const void *	buffer,
		std::uint64_t	bufSize,
		RClusterSummary &	clusterSummary )

static

Definition at line 1273 of file RNTupleSerialize.cxx.

◆ DeserializeColumnType()

ROOT::RResult< std::uint32_t > ROOT::Internal::RNTupleSerializer::DeserializeColumnType	(	const void *	buffer,
		ROOT::ENTupleColumnType &	type )

static

Definition at line 814 of file RNTupleSerialize.cxx.

◆ DeserializeEnvelope() [1/2]

ROOT::RResult< std::uint32_t > ROOT::Internal::RNTupleSerializer::DeserializeEnvelope	(	const void *	buffer,
		std::uint64_t	bufSize,
		std::uint16_t	expectedType )

static

Definition at line 984 of file RNTupleSerialize.cxx.

◆ DeserializeEnvelope() [2/2]

ROOT::RResult< std::uint32_t > ROOT::Internal::RNTupleSerializer::DeserializeEnvelope	(	const void *	buffer,
		std::uint64_t	bufSize,
		std::uint16_t	expectedType,
		std::uint64_t &	xxhash3 )

static

Definition at line 952 of file RNTupleSerialize.cxx.

◆ DeserializeEnvelopeLink()

ROOT::RResult< std::uint32_t > ROOT::Internal::RNTupleSerializer::DeserializeEnvelopeLink	(	const void *	buffer,
		std::uint64_t	bufSize,
		REnvelopeLink &	envelopeLink )

static

Definition at line 1227 of file RNTupleSerialize.cxx.

◆ DeserializeExtraTypeInfoId()

ROOT::RResult< std::uint32_t > ROOT::Internal::RNTupleSerializer::DeserializeExtraTypeInfoId	(	const void *	buffer,
		ROOT::EExtraTypeInfoIds &	id )

static

Definition at line 903 of file RNTupleSerialize.cxx.

◆ DeserializeFeatureFlags()

ROOT::RResult< std::uint32_t > ROOT::Internal::RNTupleSerializer::DeserializeFeatureFlags	(	const void *	buffer,
		std::uint64_t	bufSize,
		std::vector< std::uint64_t > &	flags )

static

Definition at line 1092 of file RNTupleSerialize.cxx.

◆ DeserializeFieldStructure()

ROOT::RResult< std::uint32_t > ROOT::Internal::RNTupleSerializer::DeserializeFieldStructure	(	const void *	buffer,
		ROOT::ENTupleStructure &	structure )

static

Definition at line 876 of file RNTupleSerialize.cxx.

◆ DeserializeFooter()

ROOT::RResult< void > ROOT::Internal::RNTupleSerializer::DeserializeFooter	(	const void *	buffer,
		std::uint64_t	bufSize,
		ROOT::Internal::RNTupleDescriptorBuilder &	descBuilder )

static

Definition at line 1995 of file RNTupleSerialize.cxx.

◆ DeserializeFrameHeader() [1/2]

ROOT::RResult< std::uint32_t > ROOT::Internal::RNTupleSerializer::DeserializeFrameHeader	(	const void *	buffer,
		std::uint64_t	bufSize,
		std::uint64_t &	frameSize )

static

Definition at line 1060 of file RNTupleSerialize.cxx.

◆ DeserializeFrameHeader() [2/2]

ROOT::RResult< std::uint32_t > ROOT::Internal::RNTupleSerializer::DeserializeFrameHeader	(	const void *	buffer,
		std::uint64_t	bufSize,
		std::uint64_t &	frameSize,
		std::uint32_t &	nitems )

static

Definition at line 1027 of file RNTupleSerialize.cxx.

◆ DeserializeHeader()

ROOT::RResult< void > ROOT::Internal::RNTupleSerializer::DeserializeHeader	(	const void *	buffer,
		std::uint64_t	bufSize,
		ROOT::Internal::RNTupleDescriptorBuilder &	descBuilder )

static

Definition at line 1937 of file RNTupleSerialize.cxx.

◆ DeserializeInt16()

std::uint32_t ROOT::Internal::RNTupleSerializer::DeserializeInt16	(	const void *	buffer,
		std::int16_t &	val )

static

Definition at line 662 of file RNTupleSerialize.cxx.

◆ DeserializeInt32()

std::uint32_t ROOT::Internal::RNTupleSerializer::DeserializeInt32	(	const void *	buffer,
		std::int32_t &	val )

static

Definition at line 691 of file RNTupleSerialize.cxx.

◆ DeserializeInt64()

std::uint32_t ROOT::Internal::RNTupleSerializer::DeserializeInt64	(	const void *	buffer,
		std::int64_t &	val )

static

Definition at line 725 of file RNTupleSerialize.cxx.

◆ DeserializeLocator()

ROOT::RResult< std::uint32_t > ROOT::Internal::RNTupleSerializer::DeserializeLocator	(	const void *	buffer,
		std::uint64_t	bufSize,
		RNTupleLocator &	locator )

static

Definition at line 1159 of file RNTupleSerialize.cxx.

◆ DeserializePageList()

ROOT::RResult< void > ROOT::Internal::RNTupleSerializer::DeserializePageList	(	const void *	buffer,
		std::uint64_t	bufSize,
		ROOT::DescriptorId_t	clusterGroupId,
		ROOT::RNTupleDescriptor &	desc,
		EDescriptorDeserializeMode	mode )

static

Definition at line 2273 of file RNTupleSerialize.cxx.

◆ DeserializePageListRaw()

ROOT::RResult< std::vector< ROOT::Internal::RClusterDescriptorBuilder > > ROOT::Internal::RNTupleSerializer::DeserializePageListRaw	(	const void *	buffer,
		std::uint64_t	bufSize,
		ROOT::DescriptorId_t	clusterGroupId,
		const RNTupleDescriptor &	desc )

staticprivate

Definition at line 2138 of file RNTupleSerialize.cxx.

◆ DeserializeSchemaDescription()

ROOT::RResult< std::uint32_t > ROOT::Internal::RNTupleSerializer::DeserializeSchemaDescription	(	const void *	buffer,
		std::uint64_t	bufSize,
		ROOT::Internal::RNTupleDescriptorBuilder &	descBuilder )

static

Definition at line 1521 of file RNTupleSerialize.cxx.

◆ DeserializeStreamerInfos()

ROOT::RResult< ROOT::Internal::RNTupleSerializer::StreamerInfoMap_t > ROOT::Internal::RNTupleSerializer::DeserializeStreamerInfos ( const std::string & extraTypeInfoContent )

static

Definition at line 2329 of file RNTupleSerialize.cxx.

◆ DeserializeString()

ROOT::RResult< std::uint32_t > ROOT::Internal::RNTupleSerializer::DeserializeString	(	const void *	buffer,
		std::uint64_t	bufSize,
		std::string &	val )

static

Definition at line 755 of file RNTupleSerialize.cxx.

◆ DeserializeUInt16()

std::uint32_t ROOT::Internal::RNTupleSerializer::DeserializeUInt16	(	const void *	buffer,
		std::uint16_t &	val )

static

Definition at line 674 of file RNTupleSerialize.cxx.

◆ DeserializeUInt32()

std::uint32_t ROOT::Internal::RNTupleSerializer::DeserializeUInt32	(	const void *	buffer,
		std::uint32_t &	val )

static

Definition at line 704 of file RNTupleSerialize.cxx.

◆ DeserializeUInt64()

std::uint32_t ROOT::Internal::RNTupleSerializer::DeserializeUInt64	(	const void *	buffer,
		std::uint64_t &	val )

static

Definition at line 739 of file RNTupleSerialize.cxx.

◆ SerializeAttributeSet()

ROOT::RResult< std::uint32_t > ROOT::Internal::RNTupleSerializer::SerializeAttributeSet	(	const Experimental::RNTupleAttrSetDescriptor &	attrSetDesc,
		void *	buffer )

static

Definition at line 1898 of file RNTupleSerialize.cxx.

◆ SerializeClusterGroup()

ROOT::RResult< std::uint32_t > ROOT::Internal::RNTupleSerializer::SerializeClusterGroup	(	const RClusterGroup &	clusterGroup,
		void *	buffer )

static

Definition at line 1307 of file RNTupleSerialize.cxx.

◆ SerializeClusterSummary()

ROOT::RResult< std::uint32_t > ROOT::Internal::RNTupleSerializer::SerializeClusterSummary	(	const RClusterSummary &	clusterSummary,
		void *	buffer )

static

Definition at line 1246 of file RNTupleSerialize.cxx.

◆ SerializeColumnType()

ROOT::RResult< std::uint32_t > ROOT::Internal::RNTupleSerializer::SerializeColumnType	(	ROOT::ENTupleColumnType	type,
		void *	buffer )

static

Definition at line 774 of file RNTupleSerialize.cxx.

◆ SerializeEnvelopeLink()

ROOT::RResult< std::uint32_t > ROOT::Internal::RNTupleSerializer::SerializeEnvelopeLink	(	const REnvelopeLink &	envelopeLink,
		void *	buffer )

static

Definition at line 1215 of file RNTupleSerialize.cxx.

◆ SerializeEnvelopePostscript() [1/2]

ROOT::RResult< std::uint32_t > ROOT::Internal::RNTupleSerializer::SerializeEnvelopePostscript	(	unsigned char *	envelope,
		std::uint64_t	size )

static

Definition at line 945 of file RNTupleSerialize.cxx.

◆ SerializeEnvelopePostscript() [2/2]

ROOT::RResult< std::uint32_t > ROOT::Internal::RNTupleSerializer::SerializeEnvelopePostscript	(	unsigned char *	envelope,
		std::uint64_t	size,
		std::uint64_t &	xxhash3 )

static

Definition at line 927 of file RNTupleSerialize.cxx.

◆ SerializeEnvelopePreamble()

std::uint32_t ROOT::Internal::RNTupleSerializer::SerializeEnvelopePreamble	(	std::uint16_t	envelopeType,
		void *	buffer )

static

Definition at line 916 of file RNTupleSerialize.cxx.

◆ SerializeExtraTypeInfoId()

ROOT::RResult< std::uint32_t > ROOT::Internal::RNTupleSerializer::SerializeExtraTypeInfoId	(	ROOT::EExtraTypeInfoIds	id,
		void *	buffer )

static

Definition at line 894 of file RNTupleSerialize.cxx.

◆ SerializeFeatureFlags()

ROOT::RResult< std::uint32_t > ROOT::Internal::RNTupleSerializer::SerializeFeatureFlags	(	const std::vector< std::uint64_t > &	flags,
		void *	buffer )

static

Definition at line 1069 of file RNTupleSerialize.cxx.

◆ SerializeFieldStructure()

ROOT::RResult< std::uint32_t > ROOT::Internal::RNTupleSerializer::SerializeFieldStructure	(	ROOT::ENTupleStructure	structure,
		void *	buffer )

static

While we could just interpret the enums as ints, we make the translation explicit in order to avoid accidentally changing the on-disk numbers when adjusting the enum classes.

Definition at line 859 of file RNTupleSerialize.cxx.

◆ SerializeFooter()

ROOT::RResult< std::uint32_t > ROOT::Internal::RNTupleSerializer::SerializeFooter	(	void *	buffer,
		const RNTupleDescriptor &	desc,
		const RContext &	context )

static

Definition at line 1810 of file RNTupleSerialize.cxx.

◆ SerializeFramePostscript()

ROOT::RResult< std::uint32_t > ROOT::Internal::RNTupleSerializer::SerializeFramePostscript	(	void *	frame,
		std::uint64_t	size )

static

Definition at line 1011 of file RNTupleSerialize.cxx.

◆ SerializeHeader()

ROOT::RResult< ROOT::Internal::RNTupleSerializer::RContext > ROOT::Internal::RNTupleSerializer::SerializeHeader	(	void *	buffer,
		const RNTupleDescriptor &	desc )

static

Definition at line 1672 of file RNTupleSerialize.cxx.

◆ SerializeInt16()

std::uint32_t ROOT::Internal::RNTupleSerializer::SerializeInt16	(	std::int16_t	val,
		void *	buffer )

static

Definition at line 652 of file RNTupleSerialize.cxx.

◆ SerializeInt32()

std::uint32_t ROOT::Internal::RNTupleSerializer::SerializeInt32	(	std::int32_t	val,
		void *	buffer )

static

Definition at line 679 of file RNTupleSerialize.cxx.

◆ SerializeInt64()

std::uint32_t ROOT::Internal::RNTupleSerializer::SerializeInt64	(	std::int64_t	val,
		void *	buffer )

static

Definition at line 709 of file RNTupleSerialize.cxx.

◆ SerializeListFramePreamble()

std::uint32_t ROOT::Internal::RNTupleSerializer::SerializeListFramePreamble	(	std::uint32_t	nitems,
		void *	buffer )

static

Definition at line 998 of file RNTupleSerialize.cxx.

◆ SerializeLocator()

ROOT::RResult< std::uint32_t > ROOT::Internal::RNTupleSerializer::SerializeLocator	(	const RNTupleLocator &	locator,
		void *	buffer )

static

Definition at line 1111 of file RNTupleSerialize.cxx.

◆ SerializePageList()

ROOT::RResult< std::uint32_t > ROOT::Internal::RNTupleSerializer::SerializePageList	(	void *	buffer,
		const RNTupleDescriptor &	desc,
		std::span< ROOT::DescriptorId_t >	physClusterIDs,
		const RContext &	context )

static

Definition at line 1712 of file RNTupleSerialize.cxx.

◆ SerializeRecordFramePreamble()

std::uint32_t ROOT::Internal::RNTupleSerializer::SerializeRecordFramePreamble ( void * buffer )

static

Definition at line 992 of file RNTupleSerialize.cxx.

◆ SerializeSchemaDescription()

ROOT::RResult< std::uint32_t > ROOT::Internal::RNTupleSerializer::SerializeSchemaDescription	(	void *	buffer,
		const RNTupleDescriptor &	desc,
		const RContext &	context,
		bool	forHeaderExtension = false )

static

Serialize the schema description in desc into buffer.

If forHeaderExtension is true, serialize only the fields and columns tagged as part of the header extension (see RNTupleDescriptorBuilder::BeginHeaderExtension).

Definition at line 1409 of file RNTupleSerialize.cxx.

◆ SerializeStreamerInfos()

std::string ROOT::Internal::RNTupleSerializer::SerializeStreamerInfos ( const StreamerInfoMap_t & infos )

static

Definition at line 2315 of file RNTupleSerialize.cxx.

◆ SerializeString()

std::uint32_t ROOT::Internal::RNTupleSerializer::SerializeString	(	const std::string &	val,
		void *	buffer )

static

Definition at line 744 of file RNTupleSerialize.cxx.

◆ SerializeUInt16()

std::uint32_t ROOT::Internal::RNTupleSerializer::SerializeUInt16	(	std::uint16_t	val,
		void *	buffer )

static

Definition at line 669 of file RNTupleSerialize.cxx.

◆ SerializeUInt32()

std::uint32_t ROOT::Internal::RNTupleSerializer::SerializeUInt32	(	std::uint32_t	val,
		void *	buffer )

static

Definition at line 699 of file RNTupleSerialize.cxx.

◆ SerializeUInt64()

std::uint32_t ROOT::Internal::RNTupleSerializer::SerializeUInt64	(	std::uint64_t	val,
		void *	buffer )

static

Definition at line 734 of file RNTupleSerialize.cxx.

◆ SerializeXxHash3()

std::uint32_t ROOT::Internal::RNTupleSerializer::SerializeXxHash3	(	const unsigned char *	data,
		std::uint64_t	length,
		std::uint64_t &	xxhash3,
		void *	buffer )

static

Writes a XxHash-3 64bit checksum of the byte range given by data and length.

Definition at line 626 of file RNTupleSerialize.cxx.

◆ VerifyXxHash3() [1/2]

ROOT::RResult< void > ROOT::Internal::RNTupleSerializer::VerifyXxHash3	(	const unsigned char *	data,
		std::uint64_t	length )

static

Definition at line 646 of file RNTupleSerialize.cxx.

◆ VerifyXxHash3() [2/2]

ROOT::RResult< void > ROOT::Internal::RNTupleSerializer::VerifyXxHash3	(	const unsigned char *	data,
		std::uint64_t	length,
		std::uint64_t &	xxhash3 )

static

Expects an xxhash3 checksum in the 8 bytes following data + length and verifies it.

Definition at line 636 of file RNTupleSerialize.cxx.

Member Data Documentation

◆ kEnvelopeTypeFooter

constexpr std::uint16_t ROOT::Internal::RNTupleSerializer::kEnvelopeTypeFooter = 0x02

staticconstexpr

Definition at line 71 of file RNTupleSerialize.hxx.

◆ kEnvelopeTypeHeader

constexpr std::uint16_t ROOT::Internal::RNTupleSerializer::kEnvelopeTypeHeader = 0x01

staticconstexpr

Definition at line 70 of file RNTupleSerialize.hxx.

◆ kEnvelopeTypePageList

constexpr std::uint16_t ROOT::Internal::RNTupleSerializer::kEnvelopeTypePageList = 0x03

staticconstexpr

Definition at line 72 of file RNTupleSerialize.hxx.

◆ kFlagDeferredColumn

constexpr std::uint16_t ROOT::Internal::RNTupleSerializer::kFlagDeferredColumn = 0x01

staticconstexpr

Definition at line 79 of file RNTupleSerialize.hxx.

◆ kFlagHasTypeChecksum

constexpr std::uint16_t ROOT::Internal::RNTupleSerializer::kFlagHasTypeChecksum = 0x04

staticconstexpr

Definition at line 76 of file RNTupleSerialize.hxx.

◆ kFlagHasValueRange

constexpr std::uint16_t ROOT::Internal::RNTupleSerializer::kFlagHasValueRange = 0x02

staticconstexpr

Definition at line 80 of file RNTupleSerialize.hxx.

◆ kFlagIsSoACollection

constexpr std::uint16_t ROOT::Internal::RNTupleSerializer::kFlagIsSoACollection = 0x08

staticconstexpr

Definition at line 77 of file RNTupleSerialize.hxx.

◆ kFlagProjectedField

constexpr std::uint16_t ROOT::Internal::RNTupleSerializer::kFlagProjectedField = 0x02

staticconstexpr

Definition at line 75 of file RNTupleSerialize.hxx.

◆ kFlagRepetitiveField

constexpr std::uint16_t ROOT::Internal::RNTupleSerializer::kFlagRepetitiveField = 0x01

staticconstexpr

Definition at line 74 of file RNTupleSerialize.hxx.

◆ kSuppressedColumnMarker

constexpr int64_t ROOT::Internal::RNTupleSerializer::kSuppressedColumnMarker = std::numeric_limits<std::int64_t>::min()

staticconstexpr

Definition at line 84 of file RNTupleSerialize.hxx.

◆ kZeroFieldId

constexpr ROOT::DescriptorId_t ROOT::Internal::RNTupleSerializer::kZeroFieldId = std::uint64_t(-2)

staticconstexpr

Definition at line 82 of file RNTupleSerialize.hxx.

Libraries for ROOT::Internal::RNTupleSerializer:

[legend]

The documentation for this class was generated from the following files:

tree/ntuple/inc/ROOT/RNTupleSerialize.hxx
tree/ntuple/src/RNTupleSerialize.cxx

Classes

Public Types

Static Public Member Functions

Static Public Attributes

Static Private Member Functions

Member Typedef Documentation

◆ StreamerInfoMap_t

Member Enumeration Documentation

◆ EDescriptorDeserializeMode

Member Function Documentation

◆ DeserializeAttributeSet()

◆ DeserializeClusterGroup()

◆ DeserializeClusterSummary()

◆ DeserializeColumnType()

◆ DeserializeEnvelope() [1/2]

◆ DeserializeEnvelope() [2/2]

◆ DeserializeEnvelopeLink()

◆ DeserializeExtraTypeInfoId()

◆ DeserializeFeatureFlags()

◆ DeserializeFieldStructure()

◆ DeserializeFooter()

◆ DeserializeFrameHeader() [1/2]

◆ DeserializeFrameHeader() [2/2]

◆ DeserializeHeader()

◆ DeserializeInt16()

◆ DeserializeInt32()

◆ DeserializeInt64()

◆ DeserializeLocator()

◆ DeserializePageList()

◆ DeserializePageListRaw()

◆ DeserializeSchemaDescription()

◆ DeserializeStreamerInfos()

◆ DeserializeString()

◆ DeserializeUInt16()

◆ DeserializeUInt32()

◆ DeserializeUInt64()

◆ SerializeAttributeSet()

◆ SerializeClusterGroup()

◆ SerializeClusterSummary()

◆ SerializeColumnType()

◆ SerializeEnvelopeLink()

◆ SerializeEnvelopePostscript() [1/2]

◆ SerializeEnvelopePostscript() [2/2]

◆ SerializeEnvelopePreamble()

◆ SerializeExtraTypeInfoId()

◆ SerializeFeatureFlags()

◆ SerializeFieldStructure()

◆ SerializeFooter()

◆ SerializeFramePostscript()

◆ SerializeHeader()

◆ SerializeInt16()

◆ SerializeInt32()

◆ SerializeInt64()

◆ SerializeListFramePreamble()

◆ SerializeLocator()

◆ SerializePageList()

◆ SerializeRecordFramePreamble()

◆ SerializeSchemaDescription()

◆ SerializeStreamerInfos()

◆ SerializeString()

◆ SerializeUInt16()

◆ SerializeUInt32()

◆ SerializeUInt64()

◆ SerializeXxHash3()

◆ VerifyXxHash3() [1/2]

◆ VerifyXxHash3() [2/2]

Member Data Documentation

◆ kEnvelopeTypeFooter

◆ kEnvelopeTypeHeader

◆ kEnvelopeTypePageList

◆ kFlagDeferredColumn

◆ kFlagHasTypeChecksum

◆ kFlagHasValueRange

◆ kFlagIsSoACollection

◆ kFlagProjectedField

◆ kFlagRepetitiveField

◆ kSuppressedColumnMarker

◆ kZeroFieldId