MongoDB  2.6.0
Public Member Functions | List of all members
mongo::BSONObjIterator Class Reference

iterator for a BSONObj More...

#include <bsonobjiterator.h>

Public Member Functions

 BSONObjIterator (const BSONObj &jso)
 Create an iterator for a BSON object.
 BSONObjIterator (const char *start, const char *end)
bool more ()
bool moreWithEOO ()
BSONElement next (bool checkEnd)
BSONElement next ()
void operator++ ()
void operator++ (int)
BSONElement operator* ()

Detailed Description

iterator for a BSONObj

Note each BSONObj ends with an EOO element: so you will get more() on an empty object, although next().eoo() will be true.

The BSONObj must stay in scope for the duration of the iterator's execution.

todo: we may want to make a more stl-like iterator interface for this with things like begin() and end()

Member Function Documentation

bool mongo::BSONObjIterator::more ( )
true if more elements exist to be enumerated.
bool mongo::BSONObjIterator::moreWithEOO ( )
true if more elements exist to be enumerated INCLUDING the EOO element which is always at the end.
BSONElement mongo::BSONObjIterator::next ( bool  checkEnd)
the next element in the object. For the final element, element.eoo() will be true.

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