vrs::UncompressedRecordReader Class Reference

RecordReader specialized to read uncompressed records. For VRS internal usage only. More...

#include <RecordReaders.h>

Inheritance diagram for vrs::UncompressedRecordReader:

Public Member Functions
int	read (DataReference &destination, uint32_t &outReadSize) override
CompressionType	getCompressionType () const override
Public Member Functions inherited from vrs::RecordReader
RecordReader *	init (FileHandler &file, uint32_t diskSize, uint32_t expandedSize)
template<typename T, std::enable_if_t< std::is_trivially_copyable< T >::value, int > = 0>
int	read (std::vector< T > &buffer)
int	read (void *destination, size_t size)
virtual void	finish ()
	Discard any unread data.
uint32_t	getUnreadDiskBytes () const
uint32_t	getUnreadBytes () const
int64_t	getFileOffset () const
int	getFileError () const
const void *	getRef () const

Additional Inherited Members
Protected Attributes inherited from vrs::RecordReader
FileHandler *	file_
uint32_t	remainingDiskBytes_
uint32_t	remainingUncompressedSize_
int	fileError_ {}

Detailed Description

RecordReader specialized to read uncompressed records. For VRS internal usage only.

Member Function Documentation

getCompressionType()

CompressionType vrs::UncompressedRecordReader::getCompressionType ( ) const

overridevirtual

Tell if/how the record was compressed.

Returns

The compression type.

Implements vrs::RecordReader.

read()

int vrs::UncompressedRecordReader::read ( DataReference & destination, uint32_t & outReadSize )

overridevirtual

Read data to a DataReference.

Parameters

destination	DataReference to read data to.
outReadSize	Reference to set to the number of bytes read.

Returns

0 on success, or a non-zero error code.

Implements vrs::RecordReader.

---

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

• vrs/RecordReaders.h
• vrs/RecordReaders.cpp