Struct FindOptions

#[non_exhaustive]
pub struct FindOptions {

    pub allow_disk_use: Option<bool>,
    pub allow_partial_results: Option<bool>,
    pub batch_size: Option<u32>,
    pub comment: Option<Bson>,
    pub cursor_type: Option<CursorType>,
    pub hint: Option<Hint>,
    pub limit: Option<i64>,
    pub max: Option<Document>,
    pub max_await_time: Option<Duration>,
    pub max_scan: Option<u64>,
    pub max_time: Option<Duration>,
    pub min: Option<Document>,
    pub no_cursor_timeout: Option<bool>,
    pub projection: Option<Document>,
    pub read_concern: Option<ReadConcern>,
    pub return_key: Option<bool>,
    pub selection_criteria: Option<SelectionCriteria>,
    pub show_record_id: Option<bool>,
    pub skip: Option<u64>,
    pub sort: Option<Document>,
    pub collation: Option<Collation>,
    pub let_vars: Option<Document>,
}

Specifies the options to a Collection::find operation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

allow_disk_use: Option<bool>

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+.

allow_partial_results: Option<bool>

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

batch_size: Option<u32>

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.

comment: Option<Bson>

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.

cursor_type: Option<CursorType>

The type of cursor to return.

hint: Option<Hint>

The index to use for the operation.

limit: Option<i64>

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.

max: Option<Document>

The exclusive upper bound for a specific index.

max_await_time: Option<Duration>

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.

max_scan: Option<u64>

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.

max_time: Option<Duration>

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.

min: Option<Document>

The inclusive lower bound for a specific index.

no_cursor_timeout: Option<bool>

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

projection: Option<Document>

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.

read_concern: Option<ReadConcern>

The read concern to use for this find query.

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

return_key: Option<bool>

Whether to return only the index keys in the documents.

selection_criteria: Option<SelectionCriteria>

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

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

show_record_id: Option<bool>

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

Defaults to false.

skip: Option<u64>

The number of documents to skip before counting.

sort: Option<Document>

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

collation: Option<Collation>

The collation to use for the operation.

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

let_vars: Option<Document>

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+.

Implementations

impl FindOptions

pub fn builder() -> FindOptionsBuilder<((), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), ())>

Create a builder for building FindOptions. On the builder, call .allow_disk_use(...)(optional), .allow_partial_results(...)(optional), .batch_size(...)(optional), .comment(...)(optional), .cursor_type(...)(optional), .hint(...)(optional), .limit(...)(optional), .max(...)(optional), .max_await_time(...)(optional), .max_scan(...)(optional), .max_time(...)(optional), .min(...)(optional), .no_cursor_timeout(...)(optional), .projection(...)(optional), .read_concern(...)(optional), .return_key(...)(optional), .selection_criteria(...)(optional), .show_record_id(...)(optional), .skip(...)(optional), .sort(...)(optional), .collation(...)(optional), .let_vars(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of FindOptions.

Trait Implementations

impl Clone for FindOptions

fn clone(&self) -> FindOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FindOptions

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

Formats the value using the given formatter.

impl Default for FindOptions

fn default() -> FindOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FindOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<FindOneOptions> for FindOptions

fn from(options: FindOneOptions) -> Self

Converts to this type from the input type.

impl From<GridFsFindOptions> for FindOptions

fn from(options: GridFsFindOptions) -> Self

Converts to this type from the input type.

impl Serialize for FindOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.