GetDocument::into_future

Author: rylev

sdk/data_cosmos/examples/document_00.rs

@@ -156,7 +156,8 @@ async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
     let get_document_response = collection_client
         .clone()
         .into_document_client(doc.id.clone(), &doc.id)?
-        .get_document::<MySampleStruct>(Context::new(), GetDocumentOptions::new())
+        .get_document()
+        .into_future::<MySampleStruct>()
         .await?;
     println!("get_document_response == {:#?}", get_document_response);
 

sdk/data_cosmos/examples/document_entries_00.rs

@@ -115,13 +115,11 @@ async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
     let id = format!("unique_id{}", 3);
     let partition_key = &id;
 
-    let response = client
+    let response: GetDocumentResponse<MySampleStruct> = client
         .clone()
         .into_document_client(id.clone(), partition_key)?
-        .get_document::<MySampleStruct>(
-            Context::new(),
-            GetDocumentOptions::new().consistency_level(session_token),
-        )
+        .get_document()
+        .into_future()
         .await?;
 
     assert!(matches!(response, GetDocumentResponse::Found(_)));
@@ -155,14 +153,12 @@ async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
     // has_been_found == false
     println!("\n\nLooking for non-existing item");
     let id = format!("unique_id{}", 100);
-
-    let response = client
+    let response: GetDocumentResponse<MySampleStruct> = client
         .clone()
         .into_document_client(id.clone(), &id)?
-        .get_document::<MySampleStruct>(
-            Context::new(),
-            GetDocumentOptions::new().consistency_level(&response),
-        )
+        .get_document()
+        .consistency_level(&response)
+        .into_future()
         .await?;
 
     assert!(matches!(response, GetDocumentResponse::NotFound(_)));

sdk/data_cosmos/examples/document_entries_01.rs

@@ -62,20 +62,18 @@ async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
     let get_document_response = client
         .clone()
         .into_document_client(doc.id.clone(), &doc.id)?
-        .get_document::<serde_json::Value>(
-            Context::new(),
-            GetDocumentOptions::new().consistency_level(&create_document_response),
-        )
+        .get_document()
+        .consistency_level(&create_document_response)
+        .into_future::<serde_json::Value>()
         .await?;
     println!("get_document_response == {:#?}", get_document_response);
 
     let get_document_response = client
         .clone()
         .into_document_client("ciccia", &doc.id)?
-        .get_document::<serde_json::Value>(
-            Context::new(),
-            GetDocumentOptions::new().consistency_level(&create_document_response),
-        )
+        .get_document()
+        .consistency_level(&create_document_response)
+        .into_future::<serde_json::Value>()
         .await?;
     println!(
         "get_document_response == {:#?}\n\n\n",

sdk/data_cosmos/src/clients/document_client.rs

@@ -3,7 +3,6 @@ use crate::operations::*;
 use crate::resources::ResourceType;
 use crate::{requests, ReadonlyString};
 use azure_core::{Context, HttpClient, Request};
-use serde::de::DeserializeOwned;
 use serde::Serialize;
 
 /// A client for Cosmos document resources.
@@ -59,25 +58,8 @@ impl DocumentClient {
     }
 
     /// Get a document
-    pub async fn get_document<T>(
-        &self,
-        ctx: Context,
-        options: GetDocumentOptions,
-    ) -> crate::Result<GetDocumentResponse<T>>
-    where
-        T: DeserializeOwned,
-    {
-        let mut request = self.prepare_request_pipeline_with_document_name(http::Method::GET);
-
-        options.decorate_request(&mut request)?;
-
-        let response = self
-            .cosmos_client()
-            .pipeline()
-            .send(ctx.clone().insert(ResourceType::Documents), &mut request)
-            .await?;
-
-        GetDocumentResponse::try_from(response).await
+    pub fn get_document(&self) -> GetDocumentBuilder {
+        GetDocumentBuilder::new(self.clone())
     }
 
     /// replace a document in a collection

sdk/data_cosmos/src/operations/get_document.rs

@@ -4,26 +4,28 @@ use crate::resources::Document;
 use crate::ResourceQuota;
 use azure_core::headers::{etag_from_headers, session_token_from_headers};
 use azure_core::prelude::*;
-use azure_core::{
-    collect_pinned_stream, Request as HttpRequest, Response as HttpResponse, SessionToken,
-};
+use azure_core::{collect_pinned_stream, Response as HttpResponse, SessionToken};
 use chrono::{DateTime, Utc};
 use http::{HeaderMap, StatusCode};
 use serde::de::DeserializeOwned;
 
 #[derive(Debug, Clone)]
-pub struct GetDocumentOptions {
+pub struct GetDocumentBuilder {
+    client: DocumentClient,
     if_match_condition: Option<IfMatchCondition>,
     if_modified_since: Option<IfModifiedSince>,
     consistency_level: Option<ConsistencyLevel>,
+    context: Context,
 }
 
-impl GetDocumentOptions {
-    pub fn new() -> Self {
+impl GetDocumentBuilder {
+    pub(crate) fn new(client: DocumentClient) -> Self {
         Self {
+            client,
             if_match_condition: None,
             if_modified_since: None,
             consistency_level: None,
+            context: Context::new(),
         }
     }
 
@@ -33,14 +35,41 @@ impl GetDocumentOptions {
         if_modified_since: DateTime<Utc> => Some(IfModifiedSince::new(if_modified_since)),
     }
 
-    pub(crate) fn decorate_request(&self, request: &mut HttpRequest) -> crate::Result<()> {
-        azure_core::headers::add_optional_header2(&self.if_match_condition, request)?;
-        azure_core::headers::add_optional_header2(&self.if_modified_since, request)?;
-        azure_core::headers::add_optional_header2(&self.consistency_level, request)?;
+    pub fn into_future<T: DeserializeOwned>(self) -> GetDocument<T> {
+        Box::pin(async move {
+            let mut request = self
+                .client
+                .prepare_request_pipeline_with_document_name(http::Method::GET);
+
+            azure_core::headers::add_optional_header2(&self.if_match_condition, &mut request)?;
+            azure_core::headers::add_optional_header2(&self.if_modified_since, &mut request)?;
+            azure_core::headers::add_optional_header2(&self.consistency_level, &mut request)?;
+
+            request.set_body(azure_core::EMPTY_BODY.into());
+
+            let response = self
+                .client
+                .cosmos_client()
+                .pipeline()
+                .send(
+                    self.context.clone().insert(ResourceType::Documents),
+                    &mut request,
+                )
+                .await?;
+
+            GetDocumentResponse::try_from(response).await
+        })
+    }
+}
 
-        request.set_body(azure_core::EMPTY_BODY.into());
+type GetDocument<T> = futures::future::BoxFuture<'static, crate::Result<GetDocumentResponse<T>>>;
 
-        Ok(())
+#[cfg(feature = "into_future")]
+impl std::future::IntoFuture for GetDocumentBuilder {
+    type Future = GetDocument;
+    type Output = <GetDocument as std::future::Future>::Output;
+    fn into_future(self) -> Self::Future {
+        Self::into_future(self)
     }
 }
 

sdk/data_cosmos/tests/cosmos_document.rs

@@ -1,6 +1,5 @@
 #![cfg(all(test, feature = "test_e2e"))]
 use azure_core::Context;
-use azure_data_cosmos::prelude::GetDocumentOptions;
 use serde::{Deserialize, Serialize};
 
 mod setup;
@@ -85,7 +84,8 @@ async fn create_and_delete_document() {
         .unwrap();
 
     let document_after_get = document_client
-        .get_document::<MyDocument>(Context::new(), GetDocumentOptions::new())
+        .get_document()
+        .into_future::<MyDocument>()
         .await
         .unwrap();
 
@@ -272,7 +272,8 @@ async fn replace_document() {
         .into_document_client(DOCUMENT_NAME, &DOCUMENT_NAME)
         .unwrap();
     let document_after_get = document_client
-        .get_document::<MyDocument>(Context::new(), GetDocumentOptions::new())
+        .get_document()
+        .into_future::<MyDocument>()
         .await
         .unwrap();