Add IntoFuture impls for the last operations in Cosmos (#846)

Author: rylev

sdk/core/src/macros.rs

@@ -29,7 +29,7 @@ macro_rules! setters {
         #[allow(clippy::redundant_field_names)]
         #[allow(clippy::needless_update)]
         // TODO: Declare using idiomatic with_$name when https://github.com/Azure/azure-sdk-for-rust/issues/292 is resolved.
-        pub fn $name<T: ::std::convert::Into<$typ>>(self, $name: T) -> Self {
+        pub fn $name<_T: ::std::convert::Into<$typ>>(self, $name: _T) -> Self {
             let $name: $typ = $name.into();
             Self  {
                 $name: $transform,

sdk/data_cosmos/examples/document_00.rs

@@ -1,7 +1,6 @@
 use futures::stream::StreamExt;
 use serde::{Deserialize, Serialize};
-// Using the prelude module of the Cosmos crate makes easier to use the Rust Azure SDK for Cosmos
-// DB.
+// Using the prelude module of the Cosmos crate makes easier to use the Rust Azure SDK for Cosmos DB.
 use azure_core::prelude::*;
 
 use azure_data_cosmos::prelude::*;
@@ -159,8 +158,8 @@ async fn main() -> azure_core::Result<()> {
     let get_document_response = collection
         .clone()
         .document_client(doc.id.clone(), &doc.id)?
-        .get_document()
-        .into_future::<MySampleStruct>()
+        .get_document::<MySampleStruct>()
+        .into_future()
         .await?;
     println!("get_document_response == {:#?}", get_document_response);
 

sdk/data_cosmos/examples/document_entries_01.rs

@@ -60,17 +60,17 @@ async fn main() -> azure_core::Result<()> {
 
     let get_document_response = client
         .document_client(doc.id.clone(), &doc.id)?
-        .get_document()
+        .get_document::<serde_json::Value>()
         .consistency_level(&create_document_response)
-        .into_future::<serde_json::Value>()
+        .into_future()
         .await?;
     println!("get_document_response == {:#?}", get_document_response);
 
     let get_document_response = client
         .document_client("ciccia", &doc.id)?
-        .get_document()
+        .get_document::<serde_json::Value>()
         .consistency_level(&create_document_response)
-        .into_future::<serde_json::Value>()
+        .into_future()
         .await?;
     println!(
         "get_document_response == {:#?}\n\n\n",

sdk/data_cosmos/examples/stored_proc_00.rs

@@ -32,9 +32,9 @@ async fn main() -> azure_core::Result<()> {
         .database_client(database)
         .collection_client(collection)
         .stored_procedure_client("test_proc")
-        .execute_stored_procedure()
+        .execute_stored_procedure::<serde_json::Value>()
         .parameters(["Robert"])
-        .into_future::<serde_json::Value>()
+        .into_future()
         .await?;
 
     println!("Response object:\n{:#?}", ret);

sdk/data_cosmos/examples/stored_proc_01.rs

@@ -65,9 +65,9 @@ async fn main() -> azure_core::Result<()> {
     );
 
     let execute_stored_procedure_response = stored_procedure
-        .execute_stored_procedure()
+        .execute_stored_procedure::<serde_json::Value>()
         .parameters(["Robert"])
-        .into_future::<serde_json::Value>()
+        .into_future()
         .await?;
 
     println!(

sdk/data_cosmos/src/clients/document.rs

@@ -2,6 +2,7 @@ use crate::clients::*;
 use crate::operations::*;
 use crate::ReadonlyString;
 use azure_core::Request;
+use serde::de::DeserializeOwned;
 use serde::Serialize;
 
 /// A client for Cosmos document resources.
@@ -29,7 +30,7 @@ impl DocumentClient {
     }
 
     /// Get the document.
-    pub fn get_document(&self) -> GetDocumentBuilder {
+    pub fn get_document<T: DeserializeOwned + Send>(&self) -> GetDocumentBuilder<T> {
         GetDocumentBuilder::new(self.clone())
     }
 

sdk/data_cosmos/src/clients/stored_procedure.rs

@@ -2,6 +2,7 @@ use crate::clients::*;
 use crate::prelude::*;
 use crate::ReadonlyString;
 use azure_core::{Pipeline, Request};
+use serde::de::DeserializeOwned;
 
 /// A client for Cosmos stored procedure resources.
 #[derive(Debug, Clone)]
@@ -38,7 +39,9 @@ impl StoredProcedureClient {
     }
 
     /// Execute the stored procedure.
-    pub fn execute_stored_procedure(&self) -> ExecuteStoredProcedureBuilder {
+    pub fn execute_stored_procedure<T: DeserializeOwned + Send>(
+        &self,
+    ) -> ExecuteStoredProcedureBuilder<T> {
         ExecuteStoredProcedureBuilder::new(self.clone())
     }
 

sdk/data_cosmos/src/operations/execute_stored_procedure.rs

@@ -1,3 +1,5 @@
+use std::marker::PhantomData;
+
 use crate::headers::from_headers::*;
 use crate::prelude::*;
 use crate::resources::stored_procedure::Parameters;
@@ -10,18 +12,19 @@ use chrono::{DateTime, Utc};
 use serde::de::DeserializeOwned;
 
 #[derive(Debug, Clone)]
-pub struct ExecuteStoredProcedureBuilder {
+pub struct ExecuteStoredProcedureBuilder<T> {
     client: StoredProcedureClient,
     parameters: Option<Parameters>,
     consistency_level: Option<ConsistencyLevel>,
     allow_tentative_writes: TentativeWritesAllowance,
     partition_key: Option<String>,
     context: Context,
+    _stored_proc: PhantomData<T>,
 }
 
 static EMPTY_LIST: &[u8; 2] = b"[]";
 
-impl ExecuteStoredProcedureBuilder {
+impl<T: DeserializeOwned + Send> ExecuteStoredProcedureBuilder<T> {
     pub(crate) fn new(client: StoredProcedureClient) -> Self {
         Self {
             client,
@@ -30,6 +33,7 @@ impl ExecuteStoredProcedureBuilder {
             allow_tentative_writes: TentativeWritesAllowance::Deny,
             partition_key: None,
             context: Context::new(),
+            _stored_proc: PhantomData,
         }
     }
 
@@ -47,10 +51,7 @@ impl ExecuteStoredProcedureBuilder {
         })
     }
 
-    pub fn into_future<T>(self) -> ExecuteStoredProcedure<T>
-    where
-        T: DeserializeOwned,
-    {
+    pub fn into_future(self) -> ExecuteStoredProcedure<T> {
         Box::pin(async move {
             let mut request = self.client.stored_procedure_request(http::Method::POST);
 
@@ -90,6 +91,14 @@ impl ExecuteStoredProcedureBuilder {
 pub type ExecuteStoredProcedure<T> =
     futures::future::BoxFuture<'static, azure_core::Result<ExecuteStoredProcedureResponse<T>>>;
 
+#[cfg(feature = "into_future")]
+impl<T: DeserializeOwned + Send> std::future::IntoFuture for ExecuteStoredProcedureBuilder<T> {
+    type IntoFuture = ExecuteStoredProcedure<T>;
+    type Output = <ExecuteStoredProcedure<T> as std::future::Future>::Output;
+    fn into_future(self) -> Self::IntoFuture {
+        Self::into_future(self)
+    }
+}
 #[derive(Debug, Clone)]
 pub struct ExecuteStoredProcedureResponse<T>
 where

sdk/data_cosmos/src/operations/get_document.rs

@@ -1,3 +1,5 @@
+use std::marker::PhantomData;
+
 use crate::headers::from_headers::*;
 use crate::prelude::*;
 use crate::resources::Document;
@@ -10,22 +12,24 @@ use http::StatusCode;
 use serde::de::DeserializeOwned;
 
 #[derive(Debug, Clone)]
-pub struct GetDocumentBuilder {
+pub struct GetDocumentBuilder<T> {
     client: DocumentClient,
     if_match_condition: Option<IfMatchCondition>,
     if_modified_since: Option<IfModifiedSince>,
     consistency_level: Option<ConsistencyLevel>,
     context: Context,
+    _document: PhantomData<T>,
 }
 
-impl GetDocumentBuilder {
+impl<T: DeserializeOwned + Send> GetDocumentBuilder<T> {
     pub(crate) fn new(client: DocumentClient) -> Self {
         Self {
             client,
             if_match_condition: None,
             if_modified_since: None,
             consistency_level: None,
             context: Context::new(),
+            _document: PhantomData,
         }
     }
 
@@ -41,7 +45,7 @@ impl GetDocumentBuilder {
     /// We do not implement `std::future::IntoFuture` because it requires the ability for the
     /// output of the future to be generic which is not possible in Rust (as of 1.59). Once
     /// generic associated types (GATs) stabilize, this will become possible.
-    pub fn into_future<T: DeserializeOwned>(self) -> GetDocument<T> {
+    pub fn into_future(self) -> GetDocument<T> {
         Box::pin(async move {
             let mut request = self.client.document_request(http::Method::GET);
 
@@ -76,6 +80,15 @@ impl GetDocumentBuilder {
 pub type GetDocument<T> =
     futures::future::BoxFuture<'static, azure_core::Result<GetDocumentResponse<T>>>;
 
+#[cfg(feature = "into_future")]
+impl<T: DeserializeOwned + Send> std::future::IntoFuture for GetDocumentBuilder<T> {
+    type IntoFuture = GetDocument<T>;
+    type Output = <GetDocument<T> as std::future::Future>::Output;
+    fn into_future(self) -> Self::IntoFuture {
+        Self::into_future(self)
+    }
+}
+
 #[derive(Debug, Clone)]
 // note(rylev): clippy seems to be falsely detecting that
 // one of the variants is much larger than the other (which

sdk/data_cosmos/tests/document_operations.rs

@@ -109,8 +109,8 @@ async fn document_operations() {
         .unwrap();
 
     let document_after_get = document
-        .get_document()
-        .into_future::<MyDocument>()
+        .get_document::<MyDocument>()
+        .into_future()
         .await
         .unwrap();
 
@@ -142,8 +142,8 @@ async fn document_operations() {
         .document_client(DOCUMENT_NAME, &DOCUMENT_NAME)
         .unwrap();
     let document_after_get = document
-        .get_document()
-        .into_future::<MyDocument>()
+        .get_document::<MyDocument>()
+        .into_future()
         .await
         .unwrap();