DOCSP-44971: Count & distinct usage ex updates (#163)

Author: norareidy

source/includes/usage-examples/code-snippets/count-async.rs

@@ -1,13 +1,24 @@
 use std::env;
-use mongodb::{ bson::doc, Client, Collection };
-use bson::Document;
+use mongodb::{
+    bson::{ doc, Document },
+    Client,
+    Collection
+};
+use serde::{ Deserialize, Serialize };
+
+#[derive(Serialize, Deserialize, Debug)]
+struct Restaurant {
+    name: String,
+    cuisine: 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<Document> = client
+
+    // Replace <T> with the <Document> or <Restaurant> type parameter
+    let my_coll: Collection<T> = client
         .database("sample_restaurants")
         .collection("restaurants");
 

source/includes/usage-examples/code-snippets/count-sync.rs

@@ -3,12 +3,20 @@ use mongodb::{
     bson::{ Document, doc },
     sync::{ Client, Collection }
 };
+use serde::{ Deserialize, Serialize };
+
+#[derive(Serialize, Deserialize, Debug)]
+struct Restaurant {
+    name: String,
+    cuisine: String,
+}
 
 fn main() -> mongodb::error::Result<()> {
     let uri = "<connection string>";
-
     let client = Client::with_uri_str(uri)?;
-    let my_coll: Collection<Document> = client
+
+    // Replace <T> with the <Document> or <Restaurant> type parameter
+    let my_coll: Collection<T> = client
         .database("sample_restaurants")
         .collection("restaurants");
 

source/includes/usage-examples/code-snippets/distinct-async.rs

@@ -3,13 +3,22 @@ use mongodb::{
     bson::{ Document, doc },
     Client,
     Collection };
+use serde::{ Deserialize, Serialize };
+
+#[derive(Serialize, Deserialize, Debug)]
+struct Restaurant {
+    name: String,
+    cuisine: 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<Document> = client
+
+    // Replace <T> with the <Document> or <Restaurant> type parameter
+    let my_coll: Collection<T> = client
         .database("sample_restaurants")
         .collection("restaurants");
 

source/includes/usage-examples/code-snippets/distinct-sync.rs

@@ -3,12 +3,21 @@ use mongodb::{
     bson::{ Document, doc },
     sync::{ Client, Collection }
 };
+use serde::{ Deserialize, Serialize };
+
+#[derive(Serialize, Deserialize, Debug)]
+struct Restaurant {
+    name: String,
+    cuisine: String,
+    borough: String,
+}
 
 fn main() -> mongodb::error::Result<()> {
     let uri = "<connection string>";
-
     let client = Client::with_uri_str(uri)?;
-    let my_coll: Collection<Document> = client
+
+    // Replace <T> with the <Document> or <Restaurant> type parameter
+    let my_coll: Collection<T> = client
         .database("sample_restaurants")
         .collection("restaurants");
 

source/usage-examples/count.txt

@@ -27,13 +27,19 @@ Example
 -------
 
 This example counts documents in the ``restaurants`` collection of the
-``sample_restaurants`` database.
-
-The following code first uses the ``estimated_document_count()`` method
+``sample_restaurants`` database. The example uses the ``estimated_document_count()`` method
 to count the total number of documents in the collection. Then, the
 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"``:
+documents in which the value of the ``name`` field includes the string ``"Sunset"``.
+
+You can access the documents in the ``restaurants`` collection as instances
+of the ``Document`` type or a custom data type. To specify which data type represents
+the collection's data, replace the ``<T>`` type parameter on the highlighted
+line with one of the following values:
+
+- ``<Document>``: Represents collection documents as BSON documents
+- ``<Restaurant>``: Represents collection documents as instances of the ``Restaurant``
+  struct, defined at the top of the code
 
 Select the :guilabel:`Asynchronous` or :guilabel:`Synchronous` tab to
 see the corresponding code for each runtime:
@@ -48,6 +54,7 @@ see the corresponding code for each runtime:
 
          .. input:: /includes/usage-examples/code-snippets/count-async.rs
             :language: rust
+            :emphasize-lines: 21
             :dedent:
 
          .. output::
@@ -66,6 +73,7 @@ see the corresponding code for each runtime:
 
          .. input:: /includes/usage-examples/code-snippets/count-sync.rs
             :language: rust
+            :emphasize-lines: 19
             :dedent:
 
          .. output::

source/usage-examples/distinct.txt

@@ -31,11 +31,19 @@ Example
 
 This example finds distinct values for a field in the
 ``restaurants`` collection of the ``sample_restaurants`` database.
-
-This example finds distinct values of the ``borough`` field in
+The ``distinct()`` method retrieves distinct values of the ``borough`` field in
 the subset of documents in which the value of the ``cuisine`` field
 is ``"Turkish"``.
 
+You can access the documents in the ``restaurants`` collection as instances
+of the ``Document`` type or a custom data type. To specify which data type represents
+the collection's data, replace the ``<T>`` type parameter on the highlighted
+line with one of the following values:
+
+- ``<Document>``: Represents collection documents as BSON documents
+- ``<Restaurant>``: Represents collection documents as instances of the ``Restaurant``
+  struct, defined at the top of the code
+
 Select the :guilabel:`Asynchronous` or :guilabel:`Synchronous` tab to
 see the corresponding code for each runtime:
 
@@ -49,6 +57,7 @@ see the corresponding code for each runtime:
 
          .. input:: /includes/usage-examples/code-snippets/distinct-async.rs
             :language: rust
+            :emphasize-lines: 21
             :dedent:
 
          .. output::
@@ -69,6 +78,7 @@ see the corresponding code for each runtime:
 
          .. input:: /includes/usage-examples/code-snippets/distinct-sync.rs
             :language: rust
+            :emphasize-lines: 20
             :dedent:
 
          .. output::