mongocxx::cursor::iterator Class Reference

Class representing an input iterator of documents in a MongoDB cursor result set. More...

#include <cursor.hpp>

Inheritance diagram for mongocxx::cursor::iterator:

Public Member Functions
const bsoncxx::document::view &	operator* () const
	Dereferences the view for the document currently being pointed to.
const bsoncxx::document::view *	operator-> () const
	Accesses a member of the dereferenced document currently being pointed to.
iterator &	operator++ ()
	Pre-increments the iterator to move to the next document. More...
void	operator++ (int)
	Post-increments the iterator to move to the next document. More...

Friends
bool	operator== (const iterator &, const iterator &)
	Compare two iterators for (in)-equality.
bool	operator!= (const iterator &, const iterator &)
	Compare two iterators for (in)-equality.

Detailed Description

Class representing an input iterator of documents in a MongoDB cursor result set.

All non-empty iterators derived from the same mongocxx::cursor move in lock-step. Dereferencing any non-empty iterator always gives the first remaining document in the cursor. Incrementing one iterator is equivalent to incrementing them all.

Member Function Documentation

iterator& mongocxx::cursor::iterator::operator++

(

)

Pre-increments the iterator to move to the next document.

Exceptions

mongocxx::query_exception

if the query failed

void mongocxx::cursor::iterator::operator++

(

int

)

Post-increments the iterator to move to the next document.

Exceptions

mongocxx::query_exception

if the query failed

---

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

• src/mongocxx/cursor.hpp