Struct mongodb::options::UpdateOptions

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

This is supported on crate feature tokio-runtime and non-crate feature async-std-runtime, or non-crate feature tokio-runtime and crate feature async-std-runtime only.

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

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

impl UpdateOptions

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

impl Clone for UpdateOptions

fn clone(&self) -> UpdateOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateOptions

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

Formats the value using the given formatter.

impl Default for UpdateOptions

fn default() -> UpdateOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UpdateOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.