storm::io::ArchiveWriter Class Reference

#include <ArchiveWriter.h>

Public Member Functions
	ArchiveWriter (std::filesystem::path const &filename, CompressionMode const compression)
	Create a new archive and open it as a file on disk.
void	addDirectory (std::filesystem::path const &archivePath)
	Adds a (sub-) directory to the archive.
void	addFile (std::filesystem::path const &archivePath, char const *data, std::size_t const size)
	Add a file to the archive.
template<detail::ArchiveWritableRange Range, std::endian Endianness = std::endian::little> requires (detail::ArchiveWritableWithoutBuffer<Range, Endianness>)
void	addBinaryFile (std::filesystem::path const &archivePath, Range &&data)
	Add a file to the archive using a binary encoding of the provided data.
template<detail::ArchiveWritableRange Range, std::endian Endianness = std::endian::little> requires (!detail::ArchiveWritableWithoutBuffer<Range, Endianness> && !std::is_same_v<std::ranges::range_value_t<Range>, bool>)
void	addBinaryFile (std::filesystem::path const &archivePath, Range const &data)
	Add a file to the archive using a binary encoding of the provided data.
void	addBinaryFile (std::filesystem::path const &archivePath, storm::storage::BitVector const &data)
	Add a file to the archive using a binary encoding of the provided data.
void	addTextFile (std::filesystem::path const &archivePath, std::string const &data)
	Add a text file to the archive.

Detailed Description

Definition at line 43 of file ArchiveWriter.h.

Constructor & Destructor Documentation

ArchiveWriter()

storm::io::ArchiveWriter::ArchiveWriter	(	std::filesystem::path const &	filename,
		CompressionMode const	compression
	)

Create a new archive and open it as a file on disk.

Definition at line 33 of file ArchiveWriter.cpp.

Member Function Documentation

addBinaryFile() [1/3]

template<detail::ArchiveWritableRange Range, std::endian Endianness = std::endian::little>
requires (detail::ArchiveWritableWithoutBuffer<Range, Endianness>)

void storm::io::ArchiveWriter::addBinaryFile ( std::filesystem::path const &  archivePath, Range &&  data  )

inline

Add a file to the archive using a binary encoding of the provided data.

Parameters

archivePath	The file’s path inside the archive
data	The file contents

Definition at line 69 of file ArchiveWriter.h.

addBinaryFile() [2/3]

template<detail::ArchiveWritableRange Range, std::endian Endianness = std::endian::little>
requires (!detail::ArchiveWritableWithoutBuffer<Range, Endianness> && !std::is_same_v<std::ranges::range_value_t<Range>, bool>)

void storm::io::ArchiveWriter::addBinaryFile ( std::filesystem::path const &  archivePath, Range const &  data  )

inline

Add a file to the archive using a binary encoding of the provided data.

Parameters

archivePath	The file’s path inside the archive
data	The file contents

Definition at line 81 of file ArchiveWriter.h.

addBinaryFile() [3/3]

void storm::io::ArchiveWriter::addBinaryFile	(	std::filesystem::path const &	archivePath,
		storm::storage::BitVector const &	data
	)

Add a file to the archive using a binary encoding of the provided data.

Parameters

archivePath	The file’s path inside the archive
data	The file contents

Definition at line 70 of file ArchiveWriter.cpp.

addDirectory()

void storm::io::ArchiveWriter::addDirectory

(

std::filesystem::path const &

archivePath

)

Adds a (sub-) directory to the archive.

Definition at line 38 of file ArchiveWriter.cpp.

addFile()

void storm::io::ArchiveWriter::addFile	(	std::filesystem::path const &	archivePath,
		char const *	data,
		std::size_t const	size
	)

Add a file to the archive.

Parameters

archivePath	The file’s path inside the archive
data	The file contents

Definition at line 59 of file ArchiveWriter.cpp.

addTextFile()

void storm::io::ArchiveWriter::addTextFile	(	std::filesystem::path const &	archivePath,
		std::string const &	data
	)

Add a text file to the archive.

Parameters

archivePath	The file’s path inside the archive
data	The file contents

Definition at line 94 of file ArchiveWriter.cpp.

---

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

• src/storm/io/ArchiveWriter.h
• src/storm/io/ArchiveWriter.cpp