Struct mongodb::options::FindOneAndUpdateOptions

#[non_exhaustive]
pub struct FindOneAndUpdateOptions {
    pub array_filters: Option<Vec<Document>>,
    pub bypass_document_validation: Option<bool>,
    pub max_time: Option<Duration>,
    pub projection: Option<Document>,
    pub return_document: Option<ReturnDocument>,
    pub sort: Option<Document>,
    pub upsert: Option<bool>,
    pub write_concern: Option<WriteConcern>,
    pub collation: Option<Collation>,
    pub hint: Option<Hint>,
    pub let_vars: Option<Document>,
    pub comment: Option<Bson>,
}

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

array_filters: Option<Vec<Document>>

A set of filters specifying to which array elements an update should apply.

See the documentation here for more information on array filters.

bypass_document_validation: Option<bool>

Opt out of document-level validation.

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.

projection: Option<Document>

Limits the fields of the document being returned.

return_document: Option<ReturnDocument>

Whether the operation should return the document before or after modification.

sort: Option<Document>

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

upsert: Option<bool>

If true, insert a document if no matching document is found.

write_concern: Option<WriteConcern>

The level of the write concern

collation: Option<Collation>

The collation to use for the operation.

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

hint: Option<Hint>

The index to use for the operation. Only available in MongoDB 4.4+.

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

comment: 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 available on server versions 4.4+.

Implementations

impl FindOneAndUpdateOptions

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

Create a builder for building FindOneAndUpdateOptions. On the builder, call .array_filters(...)(optional), .bypass_document_validation(...)(optional), .max_time(...)(optional), .projection(...)(optional), .return_document(...)(optional), .sort(...)(optional), .upsert(...)(optional), .write_concern(...)(optional), .collation(...)(optional), .hint(...)(optional), .let_vars(...)(optional), .comment(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of FindOneAndUpdateOptions.

Trait Implementations

impl Clone for FindOneAndUpdateOptions

fn clone(&self) -> FindOneAndUpdateOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FindOneAndUpdateOptions

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

Formats the value using the given formatter.

impl Default for FindOneAndUpdateOptions

fn default() -> FindOneAndUpdateOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FindOneAndUpdateOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.