JASSv2
Public Member Functions | Private Attributes | List of all members
JASS::ciff_lin::postings_list_iterator Class Reference

iterator class for iterating over an index More...

Collaboration diagram for JASS::ciff_lin::postings_list_iterator:
Collaboration graph
[legend]

Public Member Functions

 postings_list_iterator (ciff_lin &of, size_t which)
 Constructor. More...
 
postings_list_iteratoroperator++ ()
 Move on to the next postings list by constructing and storing the current one. On error move to the end of the stream and mark it as bad. More...
 
postings_listoperator* ()
 Return the most recently constructed postings list. More...
 
bool operator!= (postings_list_iterator &with)
 Compare two iterators. More...
 

Private Attributes

ciff_linsource
 The ciff_lin being iterated over.
 
const uint8_t * stream
 Where in the source stream we are reading from.
 
size_t which
 Which postings list we are current on (counting from 0)
 
postings_list postings
 The postings list we just made.
 

Detailed Description

iterator class for iterating over an index

Constructor & Destructor Documentation

◆ postings_list_iterator()

JASS::ciff_lin::postings_list_iterator::postings_list_iterator ( ciff_lin of,
size_t  which 
)
inline

Constructor.

Parameters
of[in] The ciff_lin object we iterate over
where[in] Either 0 for start of n for the number of postings lists in the file

Member Function Documentation

◆ operator!=()

bool JASS::ciff_lin::postings_list_iterator::operator!= ( postings_list_iterator with)
inline

Compare two iterators.

Returns
True if the iterators are different

◆ operator*()

postings_list& JASS::ciff_lin::postings_list_iterator::operator* ( )
inline

Return the most recently constructed postings list.

Returns
A reference to the current postings list

◆ operator++()

postings_list_iterator& JASS::ciff_lin::postings_list_iterator::operator++ ( )
inline

Move on to the next postings list by constructing and storing the current one. On error move to the end of the stream and mark it as bad.

Returns
A reference to this iterator

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