Struct mongodb::Cursor

pub struct Cursor<T = Document> where
    T: DeserializeOwned + Unpin,  { /* fields omitted */ }

A Cursor streams the result of a query. When a query is made, a Cursor will be returned with the first batch of results from the server; the documents will be returned as the Cursor is iterated. When the batch is exhausted and if there are more results, the Cursor will fetch the next batch of documents, and so forth until the results are exhausted. Note that because of this batching, additional network I/O may occur on any given call to Cursor::next. Because of this, a Cursor iterates over Result<Document> items rather than simply Document items.

The batch size of the Cursor can be configured using the options to the method that returns it. For example, setting the batch_size field of FindOptions will set the batch size of the Cursor returned by Collection::find.

Note that the batch size determines both the number of documents stored in memory by the Cursor at a given time as well as the total number of network round-trips needed to fetch all results from the server; both of these factors should be taken into account when choosing the optimal batch size.

A cursor can be used like any other Stream. The simplest way is just to iterate over the documents it yields:

while let Some(doc) = cursor.next().await {
  println!("{}", doc?)
}

Additionally, all the other methods that an Stream has are available on Cursor as well. This includes all of the functionality provided by StreamExt, which provides similar functionality to the standard library Iterator trait. For instance, if the number of results from a query is known to be small, it might make sense to collect them into a vector:

let results: Vec<Result<Document>> = cursor.collect().await;

Trait Implementations

impl<T: Debug> Debug for Cursor<T> where
    T: DeserializeOwned + Unpin, 

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Drop for Cursor<T> where
    T: DeserializeOwned + Unpin, 

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Stream for Cursor<T> where
    T: DeserializeOwned + Unpin, 

type Item = Result<T>

Values yielded by the stream.

fn poll_next(
    mut self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

pub fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.