Compound Operations

Modify Find and Delete Behavior

You can optionally modify the behavior of the find_one_and_delete() method by passing a FineOneAndDeleteOptions instance as a parameter. To use default values for each setting, specify the value None for the options parameter.

The following table describes the options available in FineOneAndDeleteOptions:

The Rust driver implements the Builder design pattern for the creation of a FindOneAndDeleteOptions instance. You can use the type's builder() method to construct an options instance by chaining option builder functions one at a time.

The following code shows how to construct a FindOneAndDeleteOptions instance and pass it to the find_one_and_delete() method:

let opts = FindOneAndDeleteOptions::builder().comment(bson!("hello")).build();
let res = my_coll.find_one_and_delete(filter, opts).await?;

Find and Delete Example

The following example uses the find_one_and_delete() method to match and delete the first document where the value of the age field is less than or equal to 10:

let filter = doc! { "age": doc! { "$lte": 10 } };
let res = my_coll.find_one_and_delete(filter, None).await?;
println!("Deleted document:\n{:?}", res);

Deleted document:
Some(Document({"_id": ObjectId("..."),
"name": String("Deanna Porowski"), "age": Int32(10), "school":
String("Lakeside Elementary")}))

Modify Find and Update Behavior

You can optionally modify the behavior of the find_one_and_update() method by passing a FindOneAndUpdateOptions instance as a parameter. To use default values for each setting, specify the value None for the options parameter.

The following table describes the options available in FineOneAndDeleteOptions:

The Rust driver implements the Builder design pattern for the creation of a FindOneAndUpdateOptions instance. You can use the type's builder() method to construct an options instance by chaining option builder methods one at a time.

The following code shows how to construct a FindOneAndUpdateOptions instance and pass it to the find_one_and_update() method:

let opts = FindOneAndUpdateOptions::builder().comment(bson!("hello")).build();
let res = my_coll.find_one_and_update(filter, update, opts).await?;

Find and Update Example

This example shows how to call the find_one_and_update() method with the following parameters:

• A query filter that matches a document where the value of school is "Aurora High School"

• An update document that sets the school field to "Durango High School" and increments the age field by 1

• A FindOneAndUpdateOptions instance that returns the document after the update

let filter = doc! { "school": "Aurora High School" };
let update =
    doc! { "$set": doc! { "school": "Durango High School" },
           "$inc": doc! { "age": 1 } };
let opts = FindOneAndUpdateOptions::builder()
    .return_document(Some(ReturnDocument::After))
    .build();
let res = my_coll.find_one_and_update(filter, update, opts).await?;
println!("Updated document:\n{:?}", res);

Updated document:
Some(Document({"_id": ObjectId("..."),
"name": String("Ben Joseph"), "age": Int32(17), "school":
String("Durango High School")}))

Modify Find and Replace Behavior

You can optionally modify the behavior of the find_one_and_replace() method by passing a FindOneAndReplaceOptions instance as a parameter. To use default values for each setting, specify the value None for the options parameter.

The following table describes the options available in FindOneAndReplaceOptions:

The Rust driver implements the Builder design pattern for the creation of a FindOneAndReplaceOptions instance. You can use the type's builder() method to construct an options instance by chaining option builder functions one at a time.

The following code shows how to construct a FindOneAndReplaceOptions instance and pass it to the find_one_and_replace() method:

let opts = FindOneAndReplaceOptions::builder().comment(bson!("hello")).build();
let res = my_coll.find_one_and_replace(filter, replacement, opts).await?;

Find and Replace Example

This example shows how to call the find_one_and_replace() method with the following parameters:

• A query filter that matches a document where the value of name includes the string "Johnson"

• A replacement document that describes a new student

• A FindOneAndReplaceOptions instance that returns the document after replacement and projects only the name and school fields in the output

let filter = doc! { "name": doc! { "$regex": "Johnson" } };
let replacement =
    doc! { "name": "Toby Fletcher", 
           "age": 14,
           "school": "Durango High School" };
let opts = FindOneAndReplaceOptions::builder()
    .return_document(Some(ReturnDocument::After))
    .projection(doc! { "name": 1, "school": 1, "_id": 0 })
    .build();
let res = my_coll.find_one_and_replace(filter, replacement, opts).await?;
println!("Document after replacement:\n{:?}", res);

Document after replacement:
Some(Document({"name": String("Toby Fletcher"), "school":
String("Durango High School")}))

API Documentation

To learn more about the methods and types mentioned in this guide, see the following API documentation:

• find_one_and_delete()

• FindOneAndDeleteOptions

• find_one_and_update()

• FindOneAndUpdateOptions

• ReturnDocument

• find_one_and_replace()

• FindOneAndReplaceOptions