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.
bool	more ()
bool	moreWithEOO ()
BSONElement	next (bool checkEnd)

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

more()

bool mongo::BSONObjIterator::more ( )

inline

Returns

true if more elements exist to be enumerated.

moreWithEOO()

bool mongo::BSONObjIterator::moreWithEOO ( )

inline

Returns

true if more elements exist to be enumerated INCLUDING the EOO element which is always at the end.

next()

BSONElement mongo::BSONObjIterator::next ( bool  checkEnd )

inline

Returns

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:

• src/mongo/bson/bsonobjiterator.h