DOCSP-30517: Delete One Usage Example (#77)

(cherry picked from commit 7d4905c)

Author: norareidy

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

@@ -0,0 +1,36 @@
+use mongodb::{ 
+    bson::doc,
+    Client,
+    Collection 
+};
+use serde::{ Deserialize, Serialize };
+
+#[derive(Serialize, Deserialize, Debug)]
+struct Restaurant {
+    name: String,
+    borough: 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! { "$and": [
+           doc! { "name": "Haagen-Dazs" },
+           doc! { "borough": "Brooklyn" }
+       ]
+    };
+
+    let result = my_coll.delete_one(filter, None).await?;
+
+    println!("Deleted documents: {}", result.deleted_count);
+        
+    Ok(())
+}
+    

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

@@ -0,0 +1,33 @@
+use mongodb::{
+    bson::doc,
+    sync::{Client, Collection}
+};
+use serde::{ Deserialize, Serialize };
+
+#[derive(Serialize, Deserialize, Debug)]
+struct Restaurant {
+    name: String,
+    borough: 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! { "$and": [
+           doc! { "name": "Haagen-Dazs" },
+           doc! { "borough": "Brooklyn" }
+       ]
+    };
+
+    let result = my_coll.delete_one(filter, None)?;
+
+    println!("Deleted documents: {}", result.deleted_count);
+        
+    Ok(())
+}

source/usage-examples.txt

@@ -18,6 +18,7 @@ Usage Examples
    /usage-examples/insertMany
    /usage-examples/updateOne
    /usage-examples/replace
+   /usage-examples/deleteOne
    /usage-examples/deleteMany
    /usage-examples/count
    /usage-examples/distinct
@@ -100,11 +101,10 @@ Available Usage Examples
 - :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 a Document <rust-delete-one-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:`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/deleteOne.txt

@@ -0,0 +1,70 @@
+.. _rust-delete-one-usage:
+
+=================
+Delete a Document
+=================
+
+You can delete a document from a collection by calling the `delete_one()
+<{+api+}/struct.Collection.html#method.delete_one>`__ method on a ``Collection``
+instance.
+
+Pass a query filter to the ``delete_one()`` method to match the document you want to
+delete from the collection. If multiple documents match the query filter, MongoDB
+deletes the first matching document according to their :term:`natural order` in the
+database or according to the sort order specified in a `DeleteOptions <{+api+}/options/struct.DeleteOptions.html>`__
+instance.
+
+The ``delete_one()`` method returns a `DeleteResult <{+api+}/results/struct.DeleteResult.html>`__
+type. This type contains information about the result of the delete operation, such as
+the total number of documents deleted.
+
+To learn more about delete operations, see the :ref:`rust-delete-guide` guide.
+
+Example
+-------
+
+This example deletes a document that matches a query filter from the ``restaurants``
+collection in the ``sample_restaurants`` database. The example uses a ``Restaurant`` struct
+that has ``name`` and ``borough`` fields to model the documents in the collection. 
+
+This example uses a query filter that matches documents in which the value of the
+``name`` field is ``"Haagen-Dazs"`` and the ``borough`` field is ``"Brooklyn"``. MongoDB
+deletes the first of several results that match the query filter.
+
+Select the **Asynchronous** or **Synchronous** tab to see the corresponding code for
+each runtime:
+
+.. tabs::
+
+   .. tab:: Asynchronous
+      :tabid: delete-many-async
+
+      .. io-code-block::
+         :copyable: true
+
+        .. input:: /includes/usage-examples/code-snippets/delete-one-async.rs
+            :language: rust
+            :dedent:
+
+        .. output::
+            :language: console
+            :visible: false
+
+            Deleted documents: 1
+
+   .. tab:: Synchronous
+      :tabid: delete-many-sync
+
+      .. io-code-block::
+         :copyable: true
+
+        .. input:: /includes/usage-examples/code-snippets/delete-one-sync.rs
+            :language: rust
+            :dedent:
+
+        .. output::
+            :language: console
+            :visible: false
+
+            Deleted documents: 1
+