MongoCursor

Represents a cursor for a MongoDB query.

Use foreach( doc; cursor ) to iterate over the list of documents.

This struct uses reference counting to destroy the underlying MongoDB cursor.

alias MongoCursor(Q, R = Bson, S = Bson) = MongoCursor!R
struct MongoCursor(DocType = Bson)
struct MongoCursor (
DocType = Bson
) {
this(this);
~this();
bool empty [@property getter];
DocType front [@property getter];
MongoCursor sort(T order);
MongoCursor limit(size_t count);
MongoCursor skip(int count);
void popFront();
auto byPair();
}

Constructors

this this(MongoClient client, string collection, QueryFlags flags, int nskip, int nret, Q query, S return_field_selector): Undocumented in source.
this this(MongoClient client, string collection, long cursor, DocType[] existing_documents): Undocumented in source.

Destructor

~this ~this(): Undocumented in source.

Postblit

this(this) this(this): Undocumented in source.

Members

Functions

byPair auto byPair(): Iterates over all remaining documents.
limit MongoCursor limit(size_t count): Limits the number of documents that the cursor returns.
popFront void popFront(): Advances the cursor to the next document of the response.
skip MongoCursor skip(int count): Skips a given number of elements at the beginning of the cursor.
sort MongoCursor sort(T order): Controls the order in which the query returns matching documents.

Properties

empty bool empty [@property getter]: Returns true if there are no more documents for this cursor.
front DocType front [@property getter]: Returns the current document of the response.

Meta

Source

See Implementation

index vibe db mongo cursor aliases

MongoCursor