zipios::ZipInputStreambuf Class Reference

ZipInputStreambuf is a zip input streambuf filter. More...

#include <zipinputstreambuf.h>

Public Member Functions

void close ()
 Closes the streambuf. More...
 
void closeEntry ()
 Closes the current entry, and positions the stream read pointer at the beginning of the next entry (if there is one). More...
 
ConstEntryPointer getNextEntry ()
 Opens the next entry in the zip archive and returns a const pointer to a FileEntry object for the entry. More...
 
 ZipInputStreambuf (streambuf *inbuf, int s_pos=-1, bool del_inbuf=false)
 ZipInputStreambuf constructor. More...
 
virtual ~ZipInputStreambuf ()
 Destructor. More...
 
- Public Member Functions inherited from zipios::InflateInputStreambuf
 InflateInputStreambuf (streambuf *inbuf, int s_pos=-1, bool del_inbuf=false)
 InflateInputStreambuf constructor. More...
 
bool reset (int stream_position=-1)
 Resets the zlib stream and purges input and output buffers. More...
 
virtual ~InflateInputStreambuf ()
 
- Public Member Functions inherited from zipios::FilterInputStreambuf
 FilterInputStreambuf (streambuf *inbuf, bool del_inbuf=false)
 Constructor. More...
 
virtual ~FilterInputStreambuf ()
 Destructor. More...
 

Protected Member Functions

virtual int underflow ()
 
virtual int underflow ()
 

Detailed Description

ZipInputStreambuf is a zip input streambuf filter.

Constructor & Destructor Documentation

◆ ZipInputStreambuf()

zipios::ZipInputStreambuf::ZipInputStreambuf ( streambuf *  inbuf,
int  s_pos = -1,
bool  del_inbuf = false 
)
explicit

ZipInputStreambuf constructor.

Parameters
inbufthe streambuf to use for input.
s_posa position to reset the inbuf to before reading. Specify -1 to read from the current position.
del_inbufif true is specified inbuf will be deleted, when the ZipInputStreambuf is destructed.

References getNextEntry().

◆ ~ZipInputStreambuf()

zipios::ZipInputStreambuf::~ZipInputStreambuf ( )
virtual

Destructor.

Member Function Documentation

◆ close()

void zipios::ZipInputStreambuf::close ( )

◆ closeEntry()

void zipios::ZipInputStreambuf::closeEntry ( )

Closes the current entry, and positions the stream read pointer at the beginning of the next entry (if there is one).

Referenced by zipios::ZipInputStream::closeEntry(), and getNextEntry().

◆ getNextEntry()

ConstEntryPointer zipios::ZipInputStreambuf::getNextEntry ( )

Opens the next entry in the zip archive and returns a const pointer to a FileEntry object for the entry.

Returns
a const FileEntry * containing information about the (now) current entry.

References closeEntry(), zipios::DEFLATED, zipios::InflateInputStreambuf::reset(), and zipios::STORED.

Referenced by zipios::ZipInputStream::getNextEntry(), and ZipInputStreambuf().

◆ underflow()

int zipios::ZipInputStreambuf::underflow ( )
protectedvirtual

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