Struct mongodb::options::FindOneOptions

#[non_exhaustive]
pub struct FindOneOptions {

    pub allow_partial_results: Option<bool>,
    pub collation: Option<Collation>,
    pub comment: Option<String>,
    pub comment_bson: Option<Bson>,
    pub hint: Option<Hint>,
    pub max: Option<Document>,
    pub max_scan: Option<u64>,
    pub max_time: Option<Duration>,
    pub min: Option<Document>,
    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 let_vars: Option<Document>,
}

Specifies the options to a Collection::find_one 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_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.

collation: Option<Collation>

The collation to use for the operation.

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

comment: Option<String>

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

If both this option and comment_bson are specified, comment_bson will take precedence.

comment_bson: Option<Bson>

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

This option is only supported on server versions 4.4+. Use the comment option on older server versions.

hint: Option<Hint>

The index to use for the operation.

max: Option<Document>

The exclusive upper bound for a specific index.

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.

projection: Option<Document>

Limits the fields of the document being returned.

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.

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.

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 FindOneOptions

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

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

Trait Implementations

impl Clone for FindOneOptions

fn clone(&self) -> FindOneOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FindOneOptions

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

Formats the value using the given formatter.

impl Default for FindOneOptions

fn default() -> FindOneOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FindOneOptions

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.