Strigi::SubStreamProvider Class Reference

Extracts substreams from an InputStream. More...

#include <substreamprovider.h>

Inheritance diagram for Strigi::SubStreamProvider:

Public Member Functions
	SubStreamProvider (InputStream *input)
virtual	~SubStreamProvider ()
InputStream *	currentEntry ()
const EntryInfo &	entryInfo () const
const char *	error () const
virtual InputStream *	nextEntry ()=0
StreamStatus	status () const
Protected Attributes
EntryInfo	m_entryinfo
InputStream *	m_entrystream
std::string	m_error
InputStream *	m_input
StreamStatus	m_status

Detailed Description

Extracts substreams from an InputStream.

This class extracts substreams, such as files and directories, from an InputStream. For example, it may extract files and directories from a tar archive, or uncompressed data from a gzipped data stream.

Definition at line 67 of file substreamprovider.h.

Constructor & Destructor Documentation

Strigi::SubStreamProvider::SubStreamProvider ( InputStream * input ) [inline]

Initialize the SubStreamProvider.

This just sets the members to sane defaults, and assigns input to m_input

Parameters:

input

the inputstream that will be split into substreams

Definition at line 91 of file substreamprovider.h.

virtual Strigi::SubStreamProvider::~SubStreamProvider ( ) [inline, virtual]

Releases the memory used by entrystream, if there is one.

NB: does not delete input

Definition at line 101 of file substreamprovider.h.

Member Function Documentation

InputStream* Strigi::SubStreamProvider::currentEntry ( ) [inline]

get the current substream

Definition at line 140 of file substreamprovider.h.

const EntryInfo& Strigi::SubStreamProvider::entryInfo ( ) const [inline]

get information about the current substream

Definition at line 147 of file substreamprovider.h.

const char* Strigi::SubStreamProvider::error ( ) const [inline]

Return a string representation of the last error.

If no error has occurred, an empty string is returned.

Definition at line 155 of file substreamprovider.h.

virtual InputStream* Strigi::SubStreamProvider::nextEntry ( ) [pure virtual]

Get the next substream.

This function should return a stream representing the next substream that can be read from the input stream, or 0 if there are no more substreams.

For example, if the input stream were a tar archive, it would return a stream representing the next file or directory in the archive.

It should also load the substream (the same one that was returned) into entrystream, and set entryinfo to an EntryInfo giving information about the substream.

If there may be more substreams, but an error occurred, 0 should be returned, the status should be set to Error and an error message should be set.