Struct mongodb::options::FindOneAndUpdateOptions[][src]

#[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>, }
Expand description

Specifies the options to a Collection::find_one_and_update operation.

Fields (Non-exhaustive)

This struct is marked as 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+.

Implementations

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) to set the values of the fields. Finally, call .build() to create the instance of FindOneAndUpdateOptions.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Performs the conversion.

Should always be Self

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.