DOCSP-30514: update one usage example (#78)

(cherry picked from commit e782270)

Author: rustagir

source/includes/usage-examples/code-snippets/update-one-async.rs

@@ -0,0 +1,32 @@
+use std::env;
+use mongodb::{ bson::doc, Client, Collection };
+use serde::{ Deserialize, Serialize };
+
+#[derive(Serialize, Deserialize, Debug)]
+struct Restaurant {
+    borough: String,
+    cuisine: String,
+    name: String,
+}
+
+#[tokio::main]
+async fn main() -> mongodb::error::Result<()> {
+    let uri = "<connection string>";
+
+    let client = Client::with_uri_str(uri).await?;
+    let my_coll: Collection<Restaurant> = client
+        .database("sample_restaurants")
+        .collection("restaurants");
+
+    let filter = doc! { "name": "Spice Market" };
+    let update = doc! { "$set": doc! {"price": "$$$"} };
+
+    let res = my_coll.update_one(filter, update, None).await?;
+    println!(
+        "Matched documents: {}\nUpdated documents: {}",
+        res.matched_count,
+        res.modified_count
+    );
+
+    Ok(())
+}

source/includes/usage-examples/code-snippets/update-one-sync.rs

@@ -0,0 +1,31 @@
+use std::env;
+use mongodb::{ bson::doc, sync::{ Client, Collection } };
+use serde::{ Deserialize, Serialize };
+
+#[derive(Serialize, Deserialize, Debug)]
+struct Restaurant {
+    borough: String,
+    cuisine: String,
+    name: String,
+}
+
+fn main() -> mongodb::error::Result<()> {
+    let uri = "<connection string>";
+
+    let client = Client::with_uri_str(uri)?;
+    let my_coll: Collection<Restaurant> = client
+        .database("sample_restaurants")
+        .collection("restaurants");
+
+    let filter = doc! { "name": "Spice Market" };
+    let update = doc! { "$set": doc! {"price": "$$$"} };
+
+    let res = my_coll.update_one(filter, update, None)?;
+    println!(
+        "Matched documents: {}\nUpdated documents: {}",
+        res.matched_count,
+        res.modified_count
+    );
+
+    Ok(())
+}

source/op-error-handling.txt

@@ -76,7 +76,7 @@ Connection Errors
 
 A concurrent operation error might clear the connection pool,
 interrupting your connection to the server. In this
-situation, the driver raises an ``Error`` type where the value of the
+situation, the driver raises an ``Error`` type in which the value of the
 ``kind`` field is ``ConnectionPoolCleared``. The error message describes
 the reason that the concurrent operation failed.
 

source/usage-examples.txt

@@ -15,6 +15,8 @@ Usage Examples
    /usage-examples/findOne
    /usage-examples/find
    /usage-examples/insertOne
+   /usage-examples/insertMany
+   /usage-examples/updateOne
    /usage-examples/replace
    /usage-examples/deleteMany
    /usage-examples/count
@@ -95,14 +97,14 @@ Available Usage Examples
 - :ref:`Find a Document <rust-find-one-usage>`
 - :ref:`Find Multiple Documents <rust-find-usage>`
 - :ref:`Insert a Document <rust-insert-one-usage>`
+- :ref:`Insert Multiple Documents <rust-insert-many-usage>`
+- :ref:`Update a Document <rust-update-one-usage>`
 - :ref:`Replace a Document <rust-replace-usage>`
 - :ref:`Delete Multiple Documents <rust-delete-many-usage>`
 - :ref:`Count Documents <rust-count-usage>`
 - :ref:`List Distinct Field Values <rust-distinct-usage>`
 
 .. TODO: add Usage Example pages as they are created
-    - :ref:`Insert Multiple Documents <rust-insert-many-usage>`
-    - :ref:`Update a Document <rust-update-one-usage>`
     - :ref:`Update Multiple Documents <rust-update-many-usage>`
     - :ref:`Delete a Document <rust-delete-one-usage>`
     - :ref:`Delete Multiple Documents <rust-delete-many-usage>`

source/usage-examples/count.txt

@@ -37,8 +37,8 @@ example uses the ``count_documents()`` method to count the number of
 documents that match a query filter. The filter matches documents in which
 the value of the ``name`` field includes the string ``"Sunset"``:
 
-Select the **Asynchronous** or **Synchronous** tab to see the
-corresponding code for each runtime:
+Select the :guilabel:`Asynchronous` or :guilabel:`Synchronous` tab to
+see the corresponding code for each runtime:
 
 .. tabs::
 

source/usage-examples/deleteMany.txt

@@ -36,8 +36,8 @@ This example passes a query filter as a parameter to the ``delete_many()`` metho
 The filter matches documents where the value of the ``borough`` field is ``"Manhattan"``
 and the value of the ``address.street`` field is ``"Broadway"``.
 
-Select the **Asynchronous** or **Synchronous** tab to see the
-corresponding code for each runtime:
+Select the :guilabel:`Asynchronous` or :guilabel:`Synchronous` tab to
+see the corresponding code for each runtime:
 
 .. tabs::
 

source/usage-examples/find.txt

@@ -33,8 +33,8 @@ in the collection.
 The following code passes a query filter as a parameter to the ``find()`` method. The
 filter matches documents in which the value of the ``cuisine`` field is ``"French"``.
 
-Select the **Asynchronous** or **Synchronous** tab to see the
-corresponding code for each runtime:
+Select the :guilabel:`Asynchronous` or :guilabel:`Synchronous` tab to
+see the corresponding code for each runtime:
 
 .. tabs::
 

source/usage-examples/findOne.txt

@@ -29,8 +29,8 @@ struct with the data from the retrieved document.
 This example uses a query filter that matches documents in which the value of the
 ``name`` field is ``"Tompkins Square Bagels"``.
 
-Select the **Asynchronous** or **Synchronous** tab to see the
-corresponding code for each runtime:
+Select the :guilabel:`Asynchronous` or :guilabel:`Synchronous` tab to
+see the corresponding code for each runtime:
 
 .. tabs::
 

source/usage-examples/insertOne.txt

@@ -17,7 +17,7 @@ document. To learn more about specifying a type parameter, see the
 of the Databases and Collections guide.
 
 The ``insert_one()`` method returns an `InsertOneResult
-<{+api+}/results/struct.InsertOneResult.html>`__ type which contains the
+<{+api+}/results/struct.InsertOneResult.html>`__ type that contains the
 ``_id`` field of the newly inserted document.
 
 To learn more about the ``insert_one()`` method, see the
@@ -34,8 +34,8 @@ documents in the collection.
 The following code creates a ``Restaurant`` instance and inserts it into
 the collection.
 
-Select the **Asynchronous** or **Synchronous** tab to see the
-corresponding code for each runtime:
+Select the :guilabel:`Asynchronous` or :guilabel:`Synchronous` tab to
+see the corresponding code for each runtime:
 
 .. tabs::
 

source/usage-examples/replace.txt

@@ -16,7 +16,7 @@ a document:
   replace an existing document
 
 The ``replace_one()`` method returns an `UpdateResult
-<{+api+}/results/struct.UpdateResult.html>`__ type which contains
+<{+api+}/results/struct.UpdateResult.html>`__ type that contains
 information about the result of the replace operation, such as the
 number of modified documents.
 
@@ -34,8 +34,8 @@ documents in the collection.
 The following code replaces a document in which the value of the
 ``name`` field is ``"Landmark Coffee Shop"`` with a new document.
 
-Select the **Asynchronous** or **Synchronous** tab to see the
-corresponding code for each runtime:
+Select the :guilabel:`Asynchronous` or :guilabel:`Synchronous` tab to
+see the corresponding code for each runtime:
 
 .. tabs::