ifhd::v500 Namespace Reference

namespace for indexed file definitions in version 5.0 More...

Classes
class	IndexedFile
class	IndexedFileReader
class	IndexedFileWriter

Typedefs
using	TimeFormat = v400::TimeFormat
using	ReadFlags = v400::ReadFlags
using	FieldMask = v400::FieldMask
using	FileHeader = v400::FileHeader
	The File header for dat-files.
using	FileExtension = v400::FileExtension
	Header for a file extensions.
using	ChunkHeader = v400::ChunkHeader
	header for chunks Each Chunk header 16 Byte aligned within the file.
using	ChunkRef = v400::ChunkRef
	header for a chunk reference
using	StreamRef = v400::StreamRef
using	StreamInfoHeader = v400::StreamInfoHeader
using	AdditionalIndexInfo = v400::AdditionalIndexInfo
	Additional index table information.
using	ChecksumType = v400::ChecksumType
	Type of the checksum function used for calculating the checksum in the "checksums" extension.
using	ChecksumExtensionHeader = v201_v301::ChecksumExtensionHeader
	Header of the "checksums" extension.
using	FileRangeChecksumXxh3_64 = v400::FileRangeChecksumXxh3_64
	A checksum over a range within the file itself.
using	SeekFlags = v400::SeekFlags
using	ChunkType = v400::ChunkType
using	OpenMode = v400::OpenMode
using	IndexReadTable = v400::IndexReadTable
using	IndexWriteTable = v400::IndexWriteTable

Functions
a_util::datetime::DateTime	getDateTime (const a_util::filesystem::Path &filename)
	Retrieve the date time from the filename , if it is an indexed file.
void	getHeader (const std::string &filename, FileHeader &file_header)
void	updateHeader (const std::string &filename, const FileHeader &file_header, uint32_t mask)
void	queryFileInfo (const std::string &filename, std::string &file_info)
void	getExtension (const std::string &filename, const std::string &extension, FileExtension *extension_info, void **data)
void	writeExtension (const std::string &filename, const FileExtension &extension_info, const void *data)
void	isIfhdFile (const std::string &filename)
void	stream2FileHeader (FileHeader &file_header)
void	stream2FileHeaderExtension (const FileHeader &file_header, FileExtension *header_ext, size_t num_extensions)
void	stream2ChunkHeader (const FileHeader &file_header, ChunkHeader &chunk)
void	stream2ChunkRef (const FileHeader &file_header, ChunkRef &chunk_ref)
void	stream2StreamRef (const FileHeader &file_header, StreamRef &stream_ref)
void	stream2StreamInfoHeader (const FileHeader &file_header, StreamInfoHeader &stream_info)
void	stream2AdditionalStreamIndexInfo (const FileHeader &file_header, AdditionalIndexInfo &additional_index_info)
void	verifyIntegrity (const std::string &file_name)

Detailed Description

namespace for indexed file definitions in version 5.0

Typedef Documentation

AdditionalIndexInfo

using ifhd::v500::AdditionalIndexInfo = v400::AdditionalIndexInfo

Additional index table information.

ChecksumExtensionHeader

using ifhd::v500::ChecksumExtensionHeader = v201_v301::ChecksumExtensionHeader

Header of the "checksums" extension.

ChecksumType

using ifhd::v500::ChecksumType = v400::ChecksumType

Type of the checksum function used for calculating the checksum in the "checksums" extension.

ChunkHeader

using ifhd::v500::ChunkHeader = v400::ChunkHeader

header for chunks Each Chunk header 16 Byte aligned within the file.

ChunkRef

using ifhd::v500::ChunkRef = v400::ChunkRef

header for a chunk reference

ChunkType

using ifhd::v500::ChunkType = v400::ChunkType

The chunk types.

FieldMask

using ifhd::v500::FieldMask = v400::FieldMask

FileExtension

using ifhd::v500::FileExtension = v400::FileExtension

Header for a file extensions.

FileHeader

using ifhd::v500::FileHeader = v400::FileHeader

The File header for dat-files.

FileRangeChecksumXxh3_64

using ifhd::v500::FileRangeChecksumXxh3_64 = v400::FileRangeChecksumXxh3_64

A checksum over a range within the file itself.

IndexReadTable

using ifhd::v500::IndexReadTable = v400::IndexReadTable

Class for storing an index table of an indexed file.

IndexWriteTable

using ifhd::v500::IndexWriteTable = v400::IndexWriteTable

Class for storing an index table of an indexed file.

OpenMode

using ifhd::v500::OpenMode = v400::OpenMode

File open modes.

ReadFlags

using ifhd::v500::ReadFlags = v400::ReadFlags

Read options.

SeekFlags

using ifhd::v500::SeekFlags = v400::SeekFlags

Seek flags.

StreamInfoHeader

using ifhd::v500::StreamInfoHeader = v400::StreamInfoHeader

StreamRef

using ifhd::v500::StreamRef = v400::StreamRef

TimeFormat

using ifhd::v500::TimeFormat = v400::TimeFormat

Time format (for seek etc.)

Function Documentation

getDateTime()

a_util::datetime::DateTime ifhd::v201_v301::getDateTime

(

const a_util::filesystem::Path &

filename

)

Retrieve the date time from the filename , if it is an indexed file.

Parameters

filename

the filepath to open and to retrieve the date time from

Returns

a_util::datetime::DateTime

Exceptions

exceptions::ErrorFileAccess
std::runtime_error	if file is not a valid IFHD file

getExtension()

void ifhd::v201_v301::getExtension	(	const std::string &	filename,
		const std::string &	extension,
		FileExtension *	extension_info,
		void **	data )

Return the requested file extension. You have to release the memory for the return value data with delete [] data;

Parameters

filename	The input file name.
extension	The requested file extension.
extension_info	This will be filled with the file extension information.
data	This will be filled with the file extension data.

Exceptions

exceptions::ErrorFileAccess
std::runtime_error	if file is not a valid IFHD file

getHeader()

void ifhd::v201_v301::getHeader	(	const std::string &	filename,
		FileHeader &	file_header )

Returns the header of a file.

Parameters

filename	The filename
file_header	This will be filled with the information.

Exceptions

exceptions::ErrorFileAccess
std::runtime_error	if file is not a valid IFHD file

isIfhdFile()

void ifhd::v201_v301::isIfhdFile

(

const std::string &

filename

)

Check if a particular file is a DAT file.

Parameters

filename

Name of the file to check.

Exceptions

exceptions::ErrorFileAccess
std::runtime_error	if file is not a valid IFHD file

queryFileInfo()

void ifhd::v201_v301::queryFileInfo	(	const std::string &	filename,
		std::string &	file_info )

Returns the date and the description of a file in a string.

Parameters

filename	[in] The filename.
file_info	[out] The info string.

Exceptions

exceptions::ErrorFileAlreadyExists
exceptions::ErrorFileAccess
std::runtime_error	if file is not a valid IFHD file

stream2AdditionalStreamIndexInfo()

void ifhd::v201_v301::stream2AdditionalStreamIndexInfo	(	const FileHeader &	file_header,
		AdditionalIndexInfo &	additional_index_info )

Convert a additional stream info structure to native byte order.

Parameters

[in]	file_header	The header
[in]	additional_index_info	The additional index info.

Remarks

implemented rt safe

stream2ChunkHeader()

void ifhd::v201_v301::stream2ChunkHeader	(	const FileHeader &	file_header,
		ChunkHeader &	chunk )

Convert a chunk header structure to native byte order.

Parameters

[in]	file_header	The header
[in]	chunk	The chunk header.

Remarks

implemented rt safe

stream2ChunkRef()

void ifhd::v201_v301::stream2ChunkRef	(	const FileHeader &	file_header,
		ChunkRef &	chunk_ref )

Convert a chunk reference structure to native byte order.

Parameters

[in]	file_header	The header
[in]	chunk_ref	The chunk reference

Remarks

implemented rt safe

stream2FileHeader()

void ifhd::v201_v301::stream2FileHeader

(

FileHeader &

file_header

)

Convert a file header structure to native byte order.

Parameters

[in]

file_header

The header

Remarks

implemented rt safe

Exceptions

std::runtime_error

if file version in file_header is not supported

stream2FileHeaderExtension()

void ifhd::v201_v301::stream2FileHeaderExtension	(	const FileHeader &	file_header,
		FileExtension *	header_ext,
		size_t	num_extensions )

Convert a file header extension structure to native byte order.

Parameters

[in]	file_header	The header
[in]	header_ext	The header extension.
[in]	num_extensions	The number of Extensions.

Remarks

implemented rt safe

stream2StreamInfoHeader()

void ifhd::v201_v301::stream2StreamInfoHeader	(	const FileHeader &	file_header,
		StreamInfoHeader &	stream_info )

Convert a stream info header structure to native byte order.

Parameters

[in]	file_header	The header
[in]	stream_info	The stream info.

Remarks

implemented rt safe

stream2StreamRef()

void ifhd::v201_v301::stream2StreamRef	(	const FileHeader &	file_header,
		StreamRef &	stream_ref )

Convert a stream reference structure to native byte order.

Parameters

[in]	file_header	The header
[in]	stream_ref	The stream reference

Remarks

implemented rt safe

updateHeader()

void ifhd::v201_v301::updateHeader	(	const std::string &	filename,
		const FileHeader &	file_header,
		uint32_t	mask )

Update header info.

Parameters

filename	The filename.
file_header	The new header info.
mask	Which fields to update, see FieldMask

Exceptions

exceptions::ErrorFileAlreadyExists
exceptions::ErrorFileAccess
std::runtime_error	if file is not a valid IFHD file

verifyIntegrity()

void ifhd::v201_v301::verifyIntegrity

(

const std::string &

file_name

)

Verify the integrity of the given file by checking the contained hashes

Exceptions

std::runtime_error

in case of an error

writeExtension()

void ifhd::v201_v301::writeExtension	(	const std::string &	filename,
		const FileExtension &	extension_info,
		const void *	data )

Write an extension If the extension already exists, it will be overwritten

Warning

The extension 'GUID' is protected and could not be overwritten

Parameters

filename	The input file name.
extension_info	This will be filled with the file extension information.
data	This will be filled with the file extension data.

Exceptions

exceptions::ErrorFileAccess
std::runtime_error	if file is not a valid IFHD file