strus  0.17
Public Member Functions | List of all members
strus::ValueIteratorInterface Class Referenceabstract

Structure that represents a set of strings as iterator. More...

#include <valueIteratorInterface.hpp>

Public Member Functions

virtual ~ValueIteratorInterface ()
 
virtual void skip (const char *value, std::size_t size)=0
 Set the next key to find. More...
 
virtual void skipPrefix (const char *value, std::size_t size)=0
 Set the next key to find with the condition that all elements fetched contain the key specified as prefix. More...
 
virtual std::vector< std::string > fetchValues (std::size_t maxNofElements)=0
 Fetch the next N elements. More...
 

Detailed Description

Structure that represents a set of strings as iterator.

Constructor & Destructor Documentation

virtual strus::ValueIteratorInterface::~ValueIteratorInterface ( )
inlinevirtual

Member Function Documentation

virtual std::vector<std::string> strus::ValueIteratorInterface::fetchValues ( std::size_t  maxNofElements)
pure virtual

Fetch the next N elements.

Parameters
[in]maxNofElementsmaximum number of elements to fetch
Returns
list of next values
Note
the iterator position is on the element following the last element returned or at EOF
virtual void strus::ValueIteratorInterface::skip ( const char *  value,
std::size_t  size 
)
pure virtual

Set the next key to find.

Parameters
[in]valuepointer key string to seek
[in]sizesizeof of value in bytes
virtual void strus::ValueIteratorInterface::skipPrefix ( const char *  value,
std::size_t  size 
)
pure virtual

Set the next key to find with the condition that all elements fetched contain the key specified as prefix.

Parameters
[in]valuepointer key string to seek
[in]sizesizeof of value in bytes

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