mongo::Cursor Class Reference

#include <cursor.h>

Inheritance diagram for mongo::Cursor:

[legend]

List of all members.

Public Member Functions
virtual Record *	_current ()=0
virtual void	aboutToDeleteBucket (const DiskLoc &b)
virtual bool	advance ()=0
virtual bool	capped () const
virtual void	checkLocation ()
virtual Cursor *	clone ()
virtual BSONObj	current ()=0
virtual BSONObj	currKey () const
virtual DiskLoc	currLoc ()=0
bool	eof ()
virtual bool	getsetdup (DiskLoc loc)=0
virtual BSONObj	indexKeyPattern ()
virtual bool	isMultiKey () const =0
virtual CoveredIndexMatcher *	matcher () const
virtual bool	modifiedKeys () const =0
virtual void	noteLocation ()
virtual long long	nscanned ()=0
virtual bool	ok ()=0
virtual BSONObj	prettyIndexBounds () const
virtual DiskLoc	refLoc ()=0
virtual void	setMatcher (shared_ptr< CoveredIndexMatcher > matcher)
virtual void	setTailable ()
virtual bool	supportGetMore ()=0
virtual bool	supportYields ()=0
virtual bool	tailable ()
virtual string	toString ()
virtual	~Cursor ()

---

Detailed Description

Definition at line 37 of file cursor.h.

---

Constructor & Destructor Documentation

virtual mongo::Cursor::~Cursor

(

)

[inline, virtual]

Definition at line 39 of file cursor.h.

---

Member Function Documentation

virtual Record* mongo::Cursor::_current

(

)

[pure virtual]

Implemented in mongo::BtreeCursor, mongo::BasicCursor, and mongo::MultiCursor.

virtual void mongo::Cursor::aboutToDeleteBucket

(

const DiskLoc &

b

)

[inline, virtual]

Reimplemented in mongo::BtreeCursor.

Definition at line 62 of file cursor.h.

virtual bool mongo::Cursor::advance

(

)

[pure virtual]

Implemented in mongo::BtreeCursor, mongo::BasicCursor, and mongo::MultiCursor.

virtual bool mongo::Cursor::capped

(

)

const [inline, virtual]

Reimplemented in mongo::ForwardCappedCursor, and mongo::ReverseCappedCursor.

Definition at line 109 of file cursor.h.

virtual void mongo::Cursor::checkLocation

(

)

[inline, virtual]

Reimplemented in mongo::BtreeCursor, and mongo::MultiCursor.

Definition at line 79 of file cursor.h.

virtual Cursor* mongo::Cursor::clone

(

)

[inline, virtual]

Definition at line 65 of file cursor.h.

virtual BSONObj mongo::Cursor::current

(

)

[pure virtual]

Implemented in mongo::BtreeCursor, mongo::BasicCursor, and mongo::MultiCursor.

virtual BSONObj mongo::Cursor::currKey

(

)

const [inline, virtual]

Reimplemented in mongo::BtreeCursor, and mongo::MultiCursor.

Definition at line 46 of file cursor.h.

virtual DiskLoc mongo::Cursor::currLoc

(

)

[pure virtual]

Implemented in mongo::BtreeCursor, mongo::BasicCursor, and mongo::MultiCursor.

bool mongo::Cursor::eof

(

)

[inline]

Definition at line 41 of file cursor.h.

virtual bool mongo::Cursor::getsetdup

(

DiskLoc

loc

)

[pure virtual]

Implemented in mongo::BtreeCursor, mongo::BasicCursor, and mongo::MultiCursor.

virtual BSONObj mongo::Cursor::indexKeyPattern

(

)

[inline, virtual]

Reimplemented in mongo::BtreeCursor.

Definition at line 69 of file cursor.h.

virtual bool mongo::Cursor::isMultiKey

(

)

const [pure virtual]

Implemented in mongo::BtreeCursor, mongo::BasicCursor, and mongo::MultiCursor.

virtual CoveredIndexMatcher* mongo::Cursor::matcher

(

)

const [inline, virtual]

Reimplemented in mongo::BtreeCursor, mongo::BasicCursor, and mongo::MultiCursor.

Definition at line 116 of file cursor.h.

virtual bool mongo::Cursor::modifiedKeys

(

)

const [pure virtual]

return true if the keys in the index have been modified from the main doc if you have { a : 1 , b : [ 1 , 2 ] } an index on { a : 1 } would not be modified an index on { b : 1 } would be since the values of the array are put in the index not the array

Implemented in mongo::BtreeCursor, mongo::BasicCursor, and mongo::MultiCursor.

virtual void mongo::Cursor::noteLocation

(

)

[inline, virtual]

Reimplemented in mongo::BtreeCursor, and mongo::MultiCursor.

Definition at line 76 of file cursor.h.

virtual long long mongo::Cursor::nscanned

(

)

[pure virtual]

Implemented in mongo::BtreeCursor, mongo::BasicCursor, and mongo::MultiCursor.

virtual bool mongo::Cursor::ok

(

)

[pure virtual]

Implemented in mongo::BtreeCursor, mongo::BasicCursor, and mongo::MultiCursor.

virtual BSONObj mongo::Cursor::prettyIndexBounds

(

)

const [inline, virtual]

Reimplemented in mongo::BtreeCursor.

Definition at line 107 of file cursor.h.

virtual DiskLoc mongo::Cursor::refLoc

(

)

[pure virtual]

Implemented in mongo::BtreeCursor, mongo::BasicCursor, and mongo::MultiCursor.

virtual void mongo::Cursor::setMatcher

(

shared_ptr< CoveredIndexMatcher >

matcher

)

[inline, virtual]

Reimplemented in mongo::BtreeCursor, and mongo::BasicCursor.

Definition at line 121 of file cursor.h.

virtual void mongo::Cursor::setTailable

(

)

[inline, virtual]

Reimplemented in mongo::BasicCursor.

Definition at line 56 of file cursor.h.

virtual bool mongo::Cursor::supportGetMore

(

)

[pure virtual]

Implemented in mongo::BtreeCursor, mongo::BasicCursor, and mongo::MultiCursor.

virtual bool mongo::Cursor::supportYields

(

)

[pure virtual]

Implemented in mongo::BtreeCursor, mongo::BasicCursor, and mongo::MultiCursor.

virtual bool mongo::Cursor::tailable

(

)

[inline, virtual]

Reimplemented in mongo::BasicCursor.

Definition at line 58 of file cursor.h.

virtual string mongo::Cursor::toString

(

)

[inline, virtual]

Reimplemented in mongo::BtreeCursor, mongo::BasicCursor, mongo::ReverseCursor, mongo::ForwardCappedCursor, and mongo::ReverseCappedCursor.

Definition at line 84 of file cursor.h.

---

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

• cursor.h