Write RNTuple data blocks in a TFile or a bare file container.

The writer can create a new TFile container for an RNTuple or add an RNTuple to an existing TFile. Creating a single RNTuple in a new TFile container can be done with a C file stream without a TFile class. Updating an existing TFile requires a proper TFile object. Also, writing a remote file requires a proper TFile object. A stand-alone version of RNTuple can remove the TFile based writer.

Definition at line 135 of file RMiniFile.hxx.

Classes
struct	RFileProper

struct	RFileSimple

Public Member Functions
	RNTupleFileWriter (const RNTupleFileWriter &other)=delete

	RNTupleFileWriter (RNTupleFileWriter &&other)=delete

	~RNTupleFileWriter ()

void	Commit ()
	Writes the RNTuple key to the file so that the header and footer keys can be found. More...

RNTupleFileWriter &	operator= (const RNTupleFileWriter &other)=delete

RNTupleFileWriter &	operator= (RNTupleFileWriter &&other)=delete

std::uint64_t	WriteBlob (const void *data, size_t nbytes, size_t len)
	Writes a new record as an RBlob key into the file. More...

std::uint64_t	WriteNTupleFooter (const void *data, size_t nbytes, size_t lenFooter)
	Writes the compressed footer and registeres its location; lenFooter is the size of the uncompressed footer. More...

std::uint64_t	WriteNTupleHeader (const void *data, size_t nbytes, size_t lenHeader)
	Writes the compressed header and registeres its location; lenHeader is the size of the uncompressed header. More...

Static Public Member Functions
static RNTupleFileWriter *	Append (std::string_view ntupleName, TFile &file)
	Add a new RNTuple identified by ntupleName to the existing TFile. More...

static RNTupleFileWriter *	Recreate (std::string_view ntupleName, std::string_view path, int defaultCompression, ENTupleContainerFormat containerFormat)
	Create or truncate the local file given by path with the new empty RNTuple identified by ntupleName. More...

static RNTupleFileWriter *	Recreate (std::string_view ntupleName, std::string_view path, std::unique_ptr< TFile > &file)
	Create or truncate the local or remote file given by path with the new empty RNTuple identified by ntupleName. More...

Private Member Functions
	RNTupleFileWriter (std::string_view name)

void	WriteBareFileSkeleton (int defaultCompression)
	For a bare file, which is necessarily written by a C file stream, write file header. More...

void	WriteTFileSkeleton (int defaultCompression)
	For a TFile container written by a C file stream, write the records that constitute an empty file. More...

Private Attributes
std::string	fFileName
	The file name without parent directory; only required when writing with a C file stream. More...

RFileProper	fFileProper
	For updating existing files and for storing more than just an RNTuple in the file. More...

RFileSimple	fFileSimple
	For simple use cases, survives without libRIO dependency. More...

bool	fIsBare = false
	A simple file can either be written as TFile container or as NTuple bare file. More...

RNTuple	fNTupleAnchor
	Header and footer location of the ntuple, written on Commit() More...

std::string	fNTupleName
	The identifier of the RNTuple; A single writer object can only write a single RNTuple but multiple writers can operate on the same file if (and only if) they use a proper TFile object for writing. More...

#include <ROOT/RMiniFile.hxx>

Constructor & Destructor Documentation

◆ RNTupleFileWriter() [1/3]

ROOT::Experimental::Internal::RNTupleFileWriter::RNTupleFileWriter ( std::string_view name )

explicitprivate

Definition at line 1082 of file RMiniFile.cxx.

◆ RNTupleFileWriter() [2/3]

ROOT::Experimental::Internal::RNTupleFileWriter::RNTupleFileWriter ( const RNTupleFileWriter & other )

delete

◆ RNTupleFileWriter() [3/3]

ROOT::Experimental::Internal::RNTupleFileWriter::RNTupleFileWriter ( RNTupleFileWriter && other )

delete

◆ ~RNTupleFileWriter()

ROOT::Experimental::Internal::RNTupleFileWriter::~RNTupleFileWriter ( )

Definition at line 1089 of file RMiniFile.cxx.

Member Function Documentation

◆ Append()

ROOT::Experimental::Internal::RNTupleFileWriter * ROOT::Experimental::Internal::RNTupleFileWriter::Append	(	std::string_view	ntupleName,
		TFile &	file
	)

static

Add a new RNTuple identified by ntupleName to the existing TFile.

Definition at line 1137 of file RMiniFile.cxx.

◆ Commit()

void ROOT::Experimental::Internal::RNTupleFileWriter::Commit ( )

Writes the RNTuple key to the file so that the header and footer keys can be found.

Definition at line 1146 of file RMiniFile.cxx.

◆ operator=() [1/2]

RNTupleFileWriter & ROOT::Experimental::Internal::RNTupleFileWriter::operator= ( const RNTupleFileWriter & other )

delete

◆ operator=() [2/2]

RNTupleFileWriter & ROOT::Experimental::Internal::RNTupleFileWriter::operator= ( RNTupleFileWriter && other )

delete

◆ Recreate() [1/2]

ROOT::Experimental::Internal::RNTupleFileWriter * ROOT::Experimental::Internal::RNTupleFileWriter::Recreate	(	std::string_view	ntupleName,
		std::string_view	path,
		int	defaultCompression,
		ENTupleContainerFormat	containerFormat
	)

static

Create or truncate the local file given by path with the new empty RNTuple identified by ntupleName.

Uses a C stream for writing

Definition at line 1094 of file RMiniFile.cxx.

◆ Recreate() [2/2]

ROOT::Experimental::Internal::RNTupleFileWriter * ROOT::Experimental::Internal::RNTupleFileWriter::Recreate	(	std::string_view	ntupleName,
		std::string_view	path,
		std::unique_ptr< TFile > &	file
	)

static

Create or truncate the local or remote file given by path with the new empty RNTuple identified by ntupleName.

Creates a new TFile object for writing and hands over ownership of the object to the user.

Definition at line 1125 of file RMiniFile.cxx.

◆ WriteBareFileSkeleton()

void ROOT::Experimental::Internal::RNTupleFileWriter::WriteBareFileSkeleton ( int defaultCompression )

private

For a bare file, which is necessarily written by a C file stream, write file header.

Definition at line 1227 of file RMiniFile.cxx.

◆ WriteBlob()

std::uint64_t ROOT::Experimental::Internal::RNTupleFileWriter::WriteBlob	(	const void *	data,
		size_t	nbytes,
		size_t	len
	)

Writes a new record as an RBlob key into the file.

Definition at line 1188 of file RMiniFile.cxx.

◆ WriteNTupleFooter()

std::uint64_t ROOT::Experimental::Internal::RNTupleFileWriter::WriteNTupleFooter	(	const void *	data,
		size_t	nbytes,
		size_t	lenFooter
	)

Writes the compressed footer and registeres its location; lenFooter is the size of the uncompressed footer.

Definition at line 1216 of file RMiniFile.cxx.

◆ WriteNTupleHeader()

std::uint64_t ROOT::Experimental::Internal::RNTupleFileWriter::WriteNTupleHeader	(	const void *	data,
		size_t	nbytes,
		size_t	lenHeader
	)

Writes the compressed header and registeres its location; lenHeader is the size of the uncompressed header.

Definition at line 1205 of file RMiniFile.cxx.

◆ WriteTFileSkeleton()

void ROOT::Experimental::Internal::RNTupleFileWriter::WriteTFileSkeleton ( int defaultCompression )

private

For a TFile container written by a C file stream, write the records that constitute an empty file.

Definition at line 1242 of file RMiniFile.cxx.

Member Data Documentation

◆ fFileName

std::string ROOT::Experimental::Internal::RNTupleFileWriter::fFileName

private

The file name without parent directory; only required when writing with a C file stream.

Definition at line 184 of file RMiniFile.hxx.

◆ fFileProper

RFileProper ROOT::Experimental::Internal::RNTupleFileWriter::fFileProper

private

For updating existing files and for storing more than just an RNTuple in the file.

Definition at line 175 of file RMiniFile.hxx.

◆ fFileSimple

RFileSimple ROOT::Experimental::Internal::RNTupleFileWriter::fFileSimple

private

For simple use cases, survives without libRIO dependency.

Definition at line 177 of file RMiniFile.hxx.

◆ fIsBare

bool ROOT::Experimental::Internal::RNTupleFileWriter::fIsBare = false

private

A simple file can either be written as TFile container or as NTuple bare file.

Definition at line 179 of file RMiniFile.hxx.

◆ fNTupleAnchor

RNTuple ROOT::Experimental::Internal::RNTupleFileWriter::fNTupleAnchor

private

Header and footer location of the ntuple, written on Commit()

Definition at line 186 of file RMiniFile.hxx.

◆ fNTupleName

std::string ROOT::Experimental::Internal::RNTupleFileWriter::fNTupleName

private

The identifier of the RNTuple; A single writer object can only write a single RNTuple but multiple writers can operate on the same file if (and only if) they use a proper TFile object for writing.

Definition at line 182 of file RMiniFile.hxx.

Libraries for ROOT::Experimental::Internal::RNTupleFileWriter:

[legend]

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ RNTupleFileWriter() [1/3]

◆ RNTupleFileWriter() [2/3]

◆ RNTupleFileWriter() [3/3]

◆ ~RNTupleFileWriter()

Member Function Documentation

◆ Append()

◆ Commit()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ Recreate() [1/2]

◆ Recreate() [2/2]

◆ WriteBareFileSkeleton()

◆ WriteBlob()

◆ WriteNTupleFooter()

◆ WriteNTupleHeader()

◆ WriteTFileSkeleton()

Member Data Documentation

◆ fFileName

◆ fFileProper

◆ fFileSimple

◆ fIsBare

◆ fNTupleAnchor

◆ fNTupleName