Struct mongodb::options::DeleteOptions

#[non_exhaustive]
pub struct DeleteOptions {
    pub collation: Option<Collation>,
    pub write_concern: Option<WriteConcern>,
    pub hint: Option<Hint>,
}

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

collation: Option<Collation>

The collation to use for the operation.

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

write_concern: Option<WriteConcern>

The write concern for the operation.

hint: Option<Hint>

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

Implementations

impl DeleteOptions

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

Create a builder for building DeleteOptions. On the builder, call .collation(...)(optional), .write_concern(...)(optional), .hint(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of DeleteOptions.

Trait Implementations

impl Clone for DeleteOptions

fn clone(&self) -> DeleteOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DeleteOptions

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

Formats the value using the given formatter.

impl Default for DeleteOptions

fn default() -> DeleteOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DeleteOptions

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

Deserialize this value from the given Serde deserializer.

impl Serialize for DeleteOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.