Struct mungos::options::FindOneAndReplaceOptions
source · #[non_exhaustive]pub struct FindOneAndReplaceOptions {
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>,
}
Expand description
Specifies the options to a
Collection::find_one_and_replace
operation.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.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+.
Implementations§
source§impl FindOneAndReplaceOptions
impl FindOneAndReplaceOptions
sourcepub fn builder(
) -> FindOneAndReplaceOptionsBuilder<((), (), (), (), (), (), (), (), (), ())>
pub fn builder(
) -> FindOneAndReplaceOptionsBuilder<((), (), (), (), (), (), (), (), (), ())>
Create a builder for building FindOneAndReplaceOptions
.
On the builder, call .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) to set the values of the fields.
Finally, call .build()
to create the instance of FindOneAndReplaceOptions
.
Trait Implementations§
source§impl Clone for FindOneAndReplaceOptions
impl Clone for FindOneAndReplaceOptions
source§fn clone(&self) -> FindOneAndReplaceOptions
fn clone(&self) -> FindOneAndReplaceOptions
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more