Making changes to main and Build error in parsing response (#92)

This commit updates doc tests in README and lib.rs to use main
as the fn name

Co-authored-by: srikwit <4140019+srikwit@users.noreply.github.com>
(cherry picked from commit 29f1c33)

Author: russcam

README.md

@@ -185,10 +185,10 @@ a JSON body of `{"query":{"match_all":{}}}`
 use elasticsearch::{Elasticsearch, Error, SearchParts};
 use serde_json::{json, Value};
 
-async fn run() -> Result<(), Error> {
-
+#[tokio::main]
+async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let client = Elasticsearch::default();
-    
+
     // make a search API call
     let search_response = client
         .search(SearchParts::None)
@@ -200,14 +200,14 @@ async fn run() -> Result<(), Error> {
         .allow_no_indices(true)
         .send()
         .await?;
-    
+
     // get the HTTP response status code
     let status_code = search_response.status_code();
-    
+
     // read the response body. Consumes search_response
-    let response_body = search_response.json::<Value>().await?; 
-    
-    // read fields from the response body         
+    let response_body = search_response.json::<Value>().await?;
+
+    // read fields from the response body
     let took = response_body["took"].as_i64().unwrap();
 
     Ok(())
@@ -225,18 +225,19 @@ and beta APIs
 ```rust,no_run
 use elasticsearch::{http::Method, Elasticsearch, Error, SearchParts};
 use http::HeaderMap;
-use serde_json::{json, Value};
-use url::Url;
+use serde_json::Value;
 
-async fn run() -> Result<(), Error> {
+#[tokio::main]
+async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let client = Elasticsearch::default();
     let body = b"{\"query\":{\"match_all\":{}}}";
     let response = client
-        .send(Method::Post,
+        .send(
+            Method::Post,
             SearchParts::Index(&["tweets"]).url().as_ref(),
             HeaderMap::new(),
             Option::<&Value>::None,
-            Some(body.as_ref())
+            Some(body.as_ref()),
         )
         .await?;
     Ok(())

elasticsearch/docs/Elasticsearch.fn.scroll.md

@@ -5,10 +5,11 @@ then fetch the next set of hits using the `_scroll_id` returned in
 the response. Once no more hits are returned, clear the scroll.
 
 ```rust,norun
-# use elasticsearch::{Elasticsearch, SearchParts, ScrollParts, ClearScrollParts};
+# use elasticsearch::{Elasticsearch, Error, SearchParts, ScrollParts, ClearScrollParts};
 # use serde_json::{json, Value};
-# async fn run() -> Result<(), Box<dyn std::error::Error>> { 
-# let client = Elasticsearch::default();
+# async fn doc() -> Result<(), Box<dyn std::error::Error>> {
+let client = Elasticsearch::default();
+
 fn print_hits(hits: &[Value]) {
     for hit in hits {
         println!(

elasticsearch/docs/Indices.fn.create.md

@@ -3,10 +3,10 @@
 Create an index with a mapping
 
 ```rust,norun
-# use elasticsearch::{Elasticsearch, indices::IndicesCreateParts};
+# use elasticsearch::{Elasticsearch, Error, indices::IndicesCreateParts};
 # use serde_json::{json, Value};
-# async fn run() -> Result<(), Box<dyn std::error::Error>> { 
-# let client = Elasticsearch::default();
+# async fn doc() -> Result<(), Box<dyn std::error::Error>> {
+let client = Elasticsearch::default();
 let response = client
     .indices()
     .create(IndicesCreateParts::Index("test_index"))

elasticsearch/docs/Indices.fn.put_mapping.md

@@ -4,10 +4,10 @@ Put a mapping into an existing index, assuming the index does not have a mapping
 or that any properties specified do not conflict with existing properties
 
 ```rust,norun
-# use elasticsearch::{Elasticsearch, indices::IndicesPutMappingParts};
+# use elasticsearch::{Elasticsearch, Error, indices::IndicesPutMappingParts};
 # use serde_json::{json, Value};
-# async fn run() -> Result<(), Box<dyn std::error::Error>> { 
-# let client = Elasticsearch::default();
+# async fn doc() -> Result<(), Box<dyn std::error::Error>> {
+let client = Elasticsearch::default();
 let response = client
     .indices()
     .put_mapping(IndicesPutMappingParts::Index(&["test_index"]))

elasticsearch/src/cat/mod.rs

@@ -10,12 +10,11 @@
 //! and accept headers, returning plain text responses
 //!
 //! ```rust,no_run
-//! # use elasticsearch;
 //! # use elasticsearch::{Elasticsearch, Error, SearchParts};
 //! # use url::Url;
 //! # use elasticsearch::auth::Credentials;
 //! # use serde_json::{json, Value};
-//! # async fn run() -> Result<(), Error> {
+//! # async fn doc() -> Result<(), Box<dyn std::error::Error>> {
 //! # let client = Elasticsearch::default();
 //! let response = client
 //!     .cat()
@@ -33,12 +32,11 @@
 //! JSON responses can be returned from Cat APIs either by using `.format("json")`
 //!
 //! ```rust,no_run
-//! # use elasticsearch;
 //! # use elasticsearch::{Elasticsearch, Error, SearchParts};
 //! # use url::Url;
 //! # use elasticsearch::auth::Credentials;
 //! # use serde_json::{json, Value};
-//! # async fn run() -> Result<(), Error> {
+//! # async fn doc() -> Result<(), Box<dyn std::error::Error>> {
 //! # let client = Elasticsearch::default();
 //! let response = client
 //!     .cat()
@@ -55,12 +53,10 @@
 //! Or by setting an accept header using `.headers()`
 //!
 //! ```rust,no_run
-//! # use elasticsearch;
 //! # use elasticsearch::{Elasticsearch, Error, SearchParts, http::headers::{HeaderValue, DEFAULT_ACCEPT, ACCEPT}};
 //! # use url::Url;
-//! # use elasticsearch::auth::Credentials;
 //! # use serde_json::{json, Value};
-//! # async fn run() -> Result<(), Error> {
+//! # async fn doc() -> Result<(), Box<dyn std::error::Error>> {
 //! # let client = Elasticsearch::default();
 //! let response = client
 //!     .cat()
@@ -79,12 +75,10 @@
 //! The column headers to return can be controlled with `.h()`
 //!
 //! ```rust,no_run
-//! # use elasticsearch;
 //! # use elasticsearch::{Elasticsearch, Error, SearchParts};
 //! # use url::Url;
-//! # use elasticsearch::auth::Credentials;
 //! # use serde_json::{json, Value};
-//! # async fn run() -> Result<(), Error> {
+//! # async fn doc() -> Result<(), Box<dyn std::error::Error>> {
 //! # let client = Elasticsearch::default();
 //! let response = client
 //!     .cat()
@@ -98,6 +92,5 @@
 //! # }
 //! ```
 //!
-//!
 
 pub use super::generated::namespace_clients::cat::*;

elasticsearch/src/cert.rs

@@ -32,7 +32,7 @@ pub use reqwest::Certificate;
 # use std::fs::File;
 # use std::io::Read;
 # use url::Url;
-# async fn run() -> Result<(), Error> {
+# async fn doc() -> Result<(), Box<dyn std::error::Error>> {
 let url = Url::parse("https://example.com")?;
 let conn_pool = SingleNodeConnectionPool::new(url);
 
@@ -71,7 +71,7 @@ let _response = client.ping().send().await?;
 # use std::fs::File;
 # use std::io::Read;
 # use url::Url;
-# async fn run() -> Result<(), Error> {
+# async fn doc() -> Result<(), Box<dyn std::error::Error>> {
 let url = Url::parse("https://example.com")?;
 let conn_pool = SingleNodeConnectionPool::new(url);
 
@@ -105,7 +105,7 @@ let _response = client.ping().send().await?;
 /// # use std::fs::File;
 /// # use std::io::Read;
 /// # use url::Url;
-/// # async fn run() -> Result<(), Error> {
+/// # async fn doc() -> Result<(), Box<dyn std::error::Error>> {
 /// let url = Url::parse("https://example.com")?;
 /// let conn_pool = SingleNodeConnectionPool::new(url);
 /// let transport = TransportBuilder::new(conn_pool)

elasticsearch/src/generated/namespace_clients/indices.rs

@@ -7722,7 +7722,7 @@ impl<'a> Indices<'a> {
     pub fn close<'b>(&'a self, parts: IndicesCloseParts<'b>) -> IndicesClose<'a, 'b, ()> {
         IndicesClose::new(&self.client, parts)
     }
-    #[doc = "[Indices Create API](https://www.elastic.co/guide/en/elasticsearch/reference/7.6/indices-create-index.html)\n\nCreates an index with optional settings and mappings.\n\n# Examples\n\nCreate an index with a mapping\n\n```rust,norun\n# use elasticsearch::{Elasticsearch, indices::IndicesCreateParts};\n# use serde_json::{json, Value};\n# async fn run() -> Result<(), Box<dyn std::error::Error>> { \n# let client = Elasticsearch::default();\nlet response = client\n    .indices()\n    .create(IndicesCreateParts::Index(\"test_index\"))\n    .body(json!({\n        \"mappings\" : {\n            \"properties\" : {\n                \"field1\" : { \"type\" : \"text\" }\n            }\n        }\n    }))\n    .send()\n    .await?;\n    \n# Ok(())\n# }\n```"]
+    #[doc = "[Indices Create API](https://www.elastic.co/guide/en/elasticsearch/reference/7.6/indices-create-index.html)\n\nCreates an index with optional settings and mappings.\n\n# Examples\n\nCreate an index with a mapping\n\n```rust,norun\n# use elasticsearch::{Elasticsearch, Error, indices::IndicesCreateParts};\n# use serde_json::{json, Value};\n# async fn doc() -> Result<(), Box<dyn std::error::Error>> {\nlet client = Elasticsearch::default();\nlet response = client\n    .indices()\n    .create(IndicesCreateParts::Index(\"test_index\"))\n    .body(json!({\n        \"mappings\" : {\n            \"properties\" : {\n                \"field1\" : { \"type\" : \"text\" }\n            }\n        }\n    }))\n    .send()\n    .await?;\n    \n# Ok(())\n# }\n```"]
     pub fn create<'b>(&'a self, parts: IndicesCreateParts<'b>) -> IndicesCreate<'a, 'b, ()> {
         IndicesCreate::new(&self.client, parts)
     }
@@ -7842,7 +7842,7 @@ impl<'a> Indices<'a> {
     pub fn put_alias<'b>(&'a self, parts: IndicesPutAliasParts<'b>) -> IndicesPutAlias<'a, 'b, ()> {
         IndicesPutAlias::new(&self.client, parts)
     }
-    #[doc = "[Indices Put Mapping API](https://www.elastic.co/guide/en/elasticsearch/reference/7.6/indices-put-mapping.html)\n\nUpdates the index mappings.\n\n# Examples\n\nPut a mapping into an existing index, assuming the index does not have a mapping, \nor that any properties specified do not conflict with existing properties\n\n```rust,norun\n# use elasticsearch::{Elasticsearch, indices::IndicesPutMappingParts};\n# use serde_json::{json, Value};\n# async fn run() -> Result<(), Box<dyn std::error::Error>> { \n# let client = Elasticsearch::default();\nlet response = client\n    .indices()\n    .put_mapping(IndicesPutMappingParts::Index(&[\"test_index\"]))\n    .body(json!({\n        \"properties\" : {\n            \"field1\" : { \"type\" : \"text\" }\n        }\n    }))\n    .send()\n    .await?;\n    \n# Ok(())\n# }\n```"]
+    #[doc = "[Indices Put Mapping API](https://www.elastic.co/guide/en/elasticsearch/reference/7.6/indices-put-mapping.html)\n\nUpdates the index mappings.\n\n# Examples\n\nPut a mapping into an existing index, assuming the index does not have a mapping, \nor that any properties specified do not conflict with existing properties\n\n```rust,norun\n# use elasticsearch::{Elasticsearch, Error, indices::IndicesPutMappingParts};\n# use serde_json::{json, Value};\n# async fn doc() -> Result<(), Box<dyn std::error::Error>> {\nlet client = Elasticsearch::default();\nlet response = client\n    .indices()\n    .put_mapping(IndicesPutMappingParts::Index(&[\"test_index\"]))\n    .body(json!({\n        \"properties\" : {\n            \"field1\" : { \"type\" : \"text\" }\n        }\n    }))\n    .send()\n    .await?;\n    \n# Ok(())\n# }\n```"]
     pub fn put_mapping<'b>(
         &'a self,
         parts: IndicesPutMappingParts<'b>,

elasticsearch/src/generated/root.rs

@@ -8501,7 +8501,7 @@ impl Elasticsearch {
     ) -> RenderSearchTemplate<'a, 'b, ()> {
         RenderSearchTemplate::new(&self, parts)
     }
-    #[doc = "[Scroll API](https://www.elastic.co/guide/en/elasticsearch/reference/7.6/search-request-body.html#request-body-search-scroll)\n\nAllows to retrieve a large numbers of results from a single search request.\n\n# Examples\n\nTo initiate a scroll, make search API call with a specified `scroll` timeout,\nthen fetch the next set of hits using the `_scroll_id` returned in\nthe response. Once no more hits are returned, clear the scroll.\n\n```rust,norun\n# use elasticsearch::{Elasticsearch, SearchParts, ScrollParts, ClearScrollParts};\n# use serde_json::{json, Value};\n# async fn run() -> Result<(), Box<dyn std::error::Error>> { \n# let client = Elasticsearch::default();\nfn print_hits(hits: &[Value]) {\n    for hit in hits {\n        println!(\n            \"id: '{}', source: '{}', score: '{}'\",\n            hit[\"_id\"].as_str().unwrap(),\n            hit[\"_source\"],\n            hit[\"_score\"].as_f64().unwrap()\n        );\n    }\n}\n\nlet scroll = \"1m\";\nlet mut response = client\n    .search(SearchParts::Index(&[\"tweets\"]))\n    .scroll(scroll)\n    .body(json!({\n        \"query\": {\n            \"match\": {\n                \"body\": {\n                    \"query\": \"Elasticsearch rust\",\n                    \"operator\": \"AND\"\n                }\n            }\n        }\n    }))\n    .send()\n    .await?;\n\nlet mut response_body = response.json::<Value>().await?;\nlet mut scroll_id = response_body[\"_scroll_id\"].as_str().unwrap();\nlet mut hits = response_body[\"hits\"][\"hits\"].as_array().unwrap();\n\nprint_hits(hits);\n\nwhile hits.len() > 0 {\n    response = client\n        .scroll(ScrollParts::None)\n        .body(json!({\n            \"scroll\": scroll,\n            \"scroll_id\": scroll_id\n        }))\n        .send()\n        .await?;\n\n    response_body = response.json::<Value>().await?;\n    scroll_id = response_body[\"_scroll_id\"].as_str().unwrap();\n    hits = response_body[\"hits\"][\"hits\"].as_array().unwrap();\n    print_hits(hits);\n}\n\nresponse = client\n    .clear_scroll(ClearScrollParts::None)\n    .body(json!({\n        \"scroll_id\": scroll_id\n    }))\n    .send()\n    .await?;\n    \n# Ok(())\n# }\n```"]
+    #[doc = "[Scroll API](https://www.elastic.co/guide/en/elasticsearch/reference/7.6/search-request-body.html#request-body-search-scroll)\n\nAllows to retrieve a large numbers of results from a single search request.\n\n# Examples\n\nTo initiate a scroll, make search API call with a specified `scroll` timeout,\nthen fetch the next set of hits using the `_scroll_id` returned in\nthe response. Once no more hits are returned, clear the scroll.\n\n```rust,norun\n# use elasticsearch::{Elasticsearch, Error, SearchParts, ScrollParts, ClearScrollParts};\n# use serde_json::{json, Value};\n# async fn doc() -> Result<(), Box<dyn std::error::Error>> {\nlet client = Elasticsearch::default();\n\nfn print_hits(hits: &[Value]) {\n    for hit in hits {\n        println!(\n            \"id: '{}', source: '{}', score: '{}'\",\n            hit[\"_id\"].as_str().unwrap(),\n            hit[\"_source\"],\n            hit[\"_score\"].as_f64().unwrap()\n        );\n    }\n}\n\nlet scroll = \"1m\";\nlet mut response = client\n    .search(SearchParts::Index(&[\"tweets\"]))\n    .scroll(scroll)\n    .body(json!({\n        \"query\": {\n            \"match\": {\n                \"body\": {\n                    \"query\": \"Elasticsearch rust\",\n                    \"operator\": \"AND\"\n                }\n            }\n        }\n    }))\n    .send()\n    .await?;\n\nlet mut response_body = response.json::<Value>().await?;\nlet mut scroll_id = response_body[\"_scroll_id\"].as_str().unwrap();\nlet mut hits = response_body[\"hits\"][\"hits\"].as_array().unwrap();\n\nprint_hits(hits);\n\nwhile hits.len() > 0 {\n    response = client\n        .scroll(ScrollParts::None)\n        .body(json!({\n            \"scroll\": scroll,\n            \"scroll_id\": scroll_id\n        }))\n        .send()\n        .await?;\n\n    response_body = response.json::<Value>().await?;\n    scroll_id = response_body[\"_scroll_id\"].as_str().unwrap();\n    hits = response_body[\"hits\"][\"hits\"].as_array().unwrap();\n    print_hits(hits);\n}\n\nresponse = client\n    .clear_scroll(ClearScrollParts::None)\n    .body(json!({\n        \"scroll_id\": scroll_id\n    }))\n    .send()\n    .await?;\n    \n# Ok(())\n# }\n```"]
     pub fn scroll<'a, 'b>(&'a self, parts: ScrollParts<'b>) -> Scroll<'a, 'b, ()> {
         Scroll::new(&self, parts)
     }

elasticsearch/src/lib.rs

@@ -88,11 +88,10 @@
 //! To create a client to make API calls to Elasticsearch running on `http://localhost:9200`
 //!
 //! ```rust,no_run
-//! # use elasticsearch::{Error, Elasticsearch};
-//! # fn run() {
+//! # use elasticsearch::Elasticsearch;
 //! let client = Elasticsearch::default();
-//! # }
 //! ```
+//!
 //! Alternatively, you can create a client to make API calls against Elasticsearch running on a
 //! specific [url::Url]
 //!
@@ -101,7 +100,7 @@
 //! #     Error, Elasticsearch,
 //! #     http::transport::{Transport, SingleNodeConnectionPool}
 //! # };
-//! # fn run() -> Result<(), Error> {
+//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
 //! let transport = Transport::single_node("https://example.com")?;
 //! let client = Elasticsearch::new(transport);
 //! # Ok(())
@@ -119,7 +118,7 @@
 //! #     http::transport::Transport,
 //! # };
 //! # use url::Url;
-//! # fn run() -> Result<(), Error> {
+//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
 //! let cloud_id = "cluster_name:Y2xvdWQtZW5kcG9pbnQuZXhhbXBsZSQzZGFkZjgyM2YwNTM4ODQ5N2VhNjg0MjM2ZDkxOGExYQ==";
 //! let credentials = Credentials::Basic("<username>".into(), "<password>".into());
 //! let transport = Transport::cloud(cloud_id, credentials)?;
@@ -139,7 +138,7 @@
 //! #     http::transport::{TransportBuilder,SingleNodeConnectionPool},
 //! # };
 //! # use url::Url;
-//! # fn run() -> Result<(), Error> {
+//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
 //! let url = Url::parse("https://example.com")?;
 //! let conn_pool = SingleNodeConnectionPool::new(url);
 //! let transport = TransportBuilder::new(conn_pool).disable_proxy().build()?;
@@ -157,12 +156,11 @@
 //! The following makes an API call to the cat indices API
 //!
 //! ```rust,no_run
-//! # use elasticsearch;
-//! # use elasticsearch::{Elasticsearch, Error, cat::CatIndicesParts};
+//! # use elasticsearch::{auth::Credentials, Elasticsearch, Error, cat::CatIndicesParts};
 //! # use url::Url;
-//! # use elasticsearch::auth::Credentials;
 //! # use serde_json::{json, Value};
-//! # async fn run() -> Result<(), Error> {
+//! # #[tokio::main]
+//! # async fn main() -> Result<(), Box<dyn std::error::Error>> {
 //! # let client = Elasticsearch::default();
 //! let response = client
 //!     .cat()
@@ -187,12 +185,11 @@
 //! Indexing a single document can be achieved with the index API
 //!
 //! ```rust,no_run
-//! # use elasticsearch;
-//! # use elasticsearch::{Elasticsearch, Error, SearchParts, IndexParts};
+//! # use elasticsearch::{auth::Credentials, Elasticsearch, Error, SearchParts, IndexParts};
 //! # use url::Url;
-//! # use elasticsearch::auth::Credentials;
 //! # use serde_json::{json, Value};
-//! # async fn run() -> Result<(), Error> {
+//! # #[tokio::main]
+//! # async fn main() -> Result<(), Box<dyn std::error::Error>> {
 //! # let client = Elasticsearch::default();
 //! let response = client
 //!     .index(IndexParts::IndexId("tweets", "1"))
@@ -214,12 +211,11 @@
 //! to be sent in one API call
 //!
 //! ```rust,no_run
-//! # use elasticsearch;
-//! # use elasticsearch::{Elasticsearch, Error, IndexParts, BulkParts, http::request::JsonBody};
+//! # use elasticsearch::{auth::Credentials, Elasticsearch, Error, IndexParts, BulkParts, http::request::JsonBody};
 //! # use url::Url;
-//! # use elasticsearch::auth::Credentials;
 //! # use serde_json::{json, Value};
-//! # async fn run() -> Result<(), Error> {
+//! # #[tokio::main]
+//! # async fn main() -> Result<(), Box<dyn std::error::Error>> {
 //! # let client = Elasticsearch::default();
 //! let mut body: Vec<JsonBody<_>> = Vec::with_capacity(4);
 //!
@@ -258,12 +254,11 @@
 //! `{"query":{"match":{"message":"Elasticsearch"}}}`
 //!
 //! ```rust,no_run
-//! # use elasticsearch;
-//! # use elasticsearch::{Elasticsearch, Error, SearchParts};
+//! # use elasticsearch::{auth::Credentials, Elasticsearch, Error, SearchParts};
 //! # use url::Url;
-//! # use elasticsearch::auth::Credentials;
 //! # use serde_json::{json, Value};
-//! # async fn run() -> Result<(), Error> {
+//! # #[tokio::main]
+//! # async fn main() -> Result<(), Box<dyn std::error::Error>> {
 //! # let client = Elasticsearch::default();
 //! let response = client
 //!     .search(SearchParts::Index(&["tweets"]))
@@ -306,14 +301,11 @@
 //! [Elasticsearch::send] can be used
 //!
 //! ```rust,no_run
-//! # use elasticsearch;
-//! # use elasticsearch::{Elasticsearch, Error, SearchParts};
+//! # use elasticsearch::{auth::Credentials, http::{Method,headers::HeaderMap}, Elasticsearch, Error, SearchParts};
 //! # use url::Url;
-//! # use elasticsearch::auth::Credentials;
 //! # use serde_json::{json, Value};
-//! # use http::HeaderMap;
-//! # use elasticsearch::http::Method;
-//! # async fn run() -> Result<(), Error> {
+//! # #[tokio::main]
+//! # async fn main() -> Result<(), Box<dyn std::error::Error>> {
 //! # let client = Elasticsearch::default();
 //! let body = b"{\"query\":{\"match_all\":{}}}";
 //!