SHORE API
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
shore::gzxindex Class Reference

Read and access the index extension of a gzip file. More...

Inheritance diagram for shore::gzxindex:
shore::gzxbase

Classes

class  iterator
 Iterator over the blocks of the streams. More...
 

Public Types

enum  ChkType { CHK_CRC32 =0, CHK_ALR32 =1, CHK_UNKNOWN }
 

Public Member Functions

 gzxindex (const uint64_t blocksize, const ChkType check)
 Construct an empty index with a block size and check type.
 
 gzxindex (std::istream *const is)
 Read the index for the stream, then return to the initial position.
 
void append (uint64_t syncoff, uint64_t chksum)
 
void set_totals (const uint64_t inflated, const uint64_t deflated)
 
void write_record (std::ostream &os) const
 
bool valid () const
 
size_t get_stream_count () const
 Get the number of gzip streams in the stream.
 
size_t get_block_count () const
 Get the total number of gzip blocks.
 
uint64_t get_uncompressed_size () const
 Get the total uncompressed size.
 
iterator begin () const
 Get an iterator over the blocks.
 
void print (std::ostream &os) const
 Print some info.
 

Additional Inherited Members

- Protected Member Functions inherited from shore::gzxbase
void z_error (const std::string &msg)
 Report & throw.
 
void zstat_error (const std::string &msg)
 Report together with zlib error status & throw.
 
- Protected Attributes inherited from shore::gzxbase
int m_zstat
 zlib error status.
 

Detailed Description

Read and access the index extension of a gzip file.


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