Struct Find

pub struct Find<'a, T: Send + Sync, Session = ImplicitSession> { /* private fields */ }

Finds the documents in a collection matching a filter. Construct with Collection::find.

Implementations

impl<'a, T: Send + Sync, Session> Find<'a, T, Session>

pub fn session<'s>( self, value: impl Into<&'s mut ClientSession>, ) -> Find<'a, T, ExplicitSession<'s>>

Use the provided session when running the operation.

pub fn with_options(self, value: impl Into<Option<FindOptions>>) -> Self

Set all options. Note that this will replace all previous values set.

pub fn allow_disk_use(self, value: bool) -> Self

Enables writing to temporary files by the server. When set to true, the find operation can write data to the _tmp subdirectory in the dbPath directory. Only supported in server versions 4.4+.

pub fn allow_partial_results(self, value: bool) -> Self

If true, partial results will be returned from a mongos rather than an error being returned if one or more shards is down.

pub fn batch_size(self, value: u32) -> Self

The number of documents the server should return per cursor batch.

Note that this does not have any affect on the documents that are returned by a cursor, only the number of documents kept in memory at a given time (and by extension, the number of round trips needed to return the entire set of documents returned by the query.

pub fn comment(self, value: impl Into<Bson>) -> Self

Tags the query with an arbitrary Bson value to help trace the operation through the database profiler, currentOp and logs.

For server versions less than 4.4, only a string value may be provided.

pub fn cursor_type(self, value: CursorType) -> Self

The type of cursor to return.

pub fn hint(self, value: Hint) -> Self

The index to use for the operation.

pub fn limit(self, value: i64) -> Self

The maximum number of documents to query. If a negative number is specified, the documents will be returned in a single batch limited in number by the positive value of the specified limit.

pub fn max(self, value: Document) -> Self

The exclusive upper bound for a specific index.

pub fn max_await_time(self, value: Duration) -> Self

The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query. If the cursor is not tailable, this option is ignored.

pub fn max_scan(self, value: u64) -> Self

Maximum number of documents or index keys to scan when executing the query.

Note: this option is deprecated starting in MongoDB version 4.0 and removed in MongoDB 4.2. Use the maxTimeMS option instead.

pub fn max_time(self, value: Duration) -> Self

The maximum amount of time to allow the query to run.

This options maps to the maxTimeMS MongoDB query option, so the duration will be sent across the wire as an integer number of milliseconds.

pub fn min(self, value: Document) -> Self

The inclusive lower bound for a specific index.

pub fn no_cursor_timeout(self, value: bool) -> Self

Whether the server should close the cursor after a period of inactivity.

pub fn projection(self, value: Document) -> Self

The projection document to determine which fields to include in the returned document.

Specifying this option may cause deserialization errors if the returned fields do not fit the schema of the collection’s generic type. The clone_with_type method can be used to retrieve a handle to the collection with a different generic type configured.

pub fn read_concern(self, value: ReadConcern) -> Self

The read concern to use for this find query.

If none specified, the default set on the collection will be used.

pub fn return_key(self, value: bool) -> Self

Whether to return only the index keys in the documents.

pub fn selection_criteria(self, value: SelectionCriteria) -> Self

The criteria used to select a server for this find query.

If none specified, the default set on the collection will be used.

pub fn show_record_id(self, value: bool) -> Self

Whether to return the record identifier for each document. If true, adds a $recordId field to the returned documents.

Defaults to false.

pub fn skip(self, value: u64) -> Self

The number of documents to skip before counting.

pub fn sort(self, value: Document) -> Self

The order of the documents for the purposes of the operation.

pub fn collation(self, value: Collation) -> Self

The collation to use for the operation.

See the documentation for more information on how to use this option.

pub fn let_vars(self, value: Document) -> Self

Map of parameter names and values. Values must be constant or closed expressions that do not reference document fields. Parameters can then be accessed as variables in an aggregate expression context (e.g. “$$var”).

Only available in MongoDB 5.0+.

impl<'a, T: Send + Sync> Find<'a, T, ImplicitSession>

pub fn run(self) -> Result<Cursor<T>>

Available on crate feature sync only.

Synchronously execute this action.

impl<'a, T: Send + Sync> Find<'a, T, ExplicitSession<'a>>

pub fn run(self) -> Result<SessionCursor<T>>

Available on crate feature sync only.

Synchronously execute this action.

Trait Implementations

impl<'a, T: Send + Sync> Action for Find<'a, T, ImplicitSession>

fn optional<Value>( self, value: Option<Value>, f: impl FnOnce(Self, Value) -> Self, ) -> Self

where Self: Sized,

If the value is Some, call the provided function on self. Convenient for chained updates with values that need to be set conditionally. For example:

impl<'a, T: Send + Sync> Action for Find<'a, T, ExplicitSession<'a>>

fn optional<Value>( self, value: Option<Value>, f: impl FnOnce(Self, Value) -> Self, ) -> Self

where Self: Sized,

If the value is Some, call the provided function on self. Convenient for chained updates with values that need to be set conditionally. For example:

impl<'a, T: Send + Sync> IntoFuture for Find<'a, T, ImplicitSession>

type Output = Result<Cursor<T>, Error>

The output that the future will produce on completion.

type IntoFuture = FindFuture<'a, T>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.

impl<'a, T: Send + Sync> IntoFuture for Find<'a, T, ExplicitSession<'a>>

type Output = Result<SessionCursor<T>, Error>

The output that the future will produce on completion.

type IntoFuture = FindSessionFuture<'a, T>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.