Helper methods to read & write file details in a cache file. More...

Classes
struct	DiskRecordInfo
	Helper class to store record information on disk. More...

struct	DiskStreamId
	Helper class to store stream id on disk. More...

Functions
int	write (const string &cacheFile, const set< StreamId > &streamIds, const map< string, string > &fileTags, const map< StreamId, StreamTags > &streamTags, const vector< IndexRecord::RecordInfo > &recordIndex, bool fileHasIndex)

int	read (const string &cacheFile, set< StreamId > &outStreamIds, map< string, string > &outFileTags, map< StreamId, StreamTags > &outStreamTags, vector< IndexRecord::RecordInfo > &outRecordIndex, bool &outFileHasIndex)

Detailed Description

Helper methods to read & write file details in a cache file.

Function Documentation

int vrs::FileDetailsCache::read	(	const string &	cacheFile,
		set< StreamId > &	outStreamIds,
		map< string, string > &	outFileTags,
		map< StreamId, StreamTags > &	outStreamTags,
		vector< IndexRecord::RecordInfo > &	outRecordIndex,
		bool &	outFileHasIndex
	)

Read a VRS details file cache from a disk location.

Parameters

cacheFile	path to the cache file to read.
outStreamIds	stream Ids read.
outFileTags	file tags read.
outStreamTags	stream tags read.
outRecordIndex	VRS file index read.
outFileHasIndex	does the original VRS file have a proper index.

int vrs::FileDetailsCache::write	(	const string &	cacheFile,
		const set< StreamId > &	streamIds,
		const map< string, string > &	fileTags,
		const map< StreamId, StreamTags > &	streamTags,
		const vector< IndexRecord::RecordInfo > &	recordIndex,
		bool	fileHasIndex
	)

Create a VRS details file cache at a disk location, in one synchronous operation.

Parameters

cacheFile	path to the cache file to write.
streamIds	stream IDs to save.
fileTags	file tags to save.
streamTags	stream tags to save.
recordIndex	VRS file index to save.
fileHasIndex	does the original VRS file have a proper index.