Struct mongodb::options::UpdateOptions
source · [−]#[non_exhaustive]pub struct UpdateOptions {
pub array_filters: Option<Vec<Document>>,
pub bypass_document_validation: Option<bool>,
pub upsert: Option<bool>,
pub collation: Option<Collation>,
pub hint: Option<Hint>,
pub write_concern: Option<WriteConcern>,
}
Expand description
Specifies the options to a
Collection::update_one
or
Collection::update_many
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.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.
upsert: Option<bool>
If true, insert a document if no matching document is found.
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>
A document or string that specifies the index to use to support the query predicate.
Only available in MongoDB 4.2+. See the official MongoDB documentation for examples.
write_concern: Option<WriteConcern>
The write concern for the operation.
Implementations
sourceimpl UpdateOptions
impl UpdateOptions
sourcepub fn builder() -> UpdateOptionsBuilder<((), (), (), (), (), ())>
pub fn builder() -> UpdateOptionsBuilder<((), (), (), (), (), ())>
Create a builder for building UpdateOptions
.
On the builder, call .array_filters(...)
(optional), .bypass_document_validation(...)
(optional), .upsert(...)
(optional), .collation(...)
(optional), .hint(...)
(optional), .write_concern(...)
(optional) to set the values of the fields.
Finally, call .build()
to create the instance of UpdateOptions
.
Trait Implementations
sourceimpl Clone for UpdateOptions
impl Clone for UpdateOptions
sourcefn clone(&self) -> UpdateOptions
fn clone(&self) -> UpdateOptions
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for UpdateOptions
impl Debug for UpdateOptions
sourceimpl Default for UpdateOptions
impl Default for UpdateOptions
sourcefn default() -> UpdateOptions
fn default() -> UpdateOptions
Returns the “default value” for a type. Read more
sourceimpl<'de> Deserialize<'de> for UpdateOptions
impl<'de> Deserialize<'de> for UpdateOptions
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations
impl RefUnwindSafe for UpdateOptions
impl Send for UpdateOptions
impl Sync for UpdateOptions
impl Unpin for UpdateOptions
impl UnwindSafe for UpdateOptions
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more