diff --git a/src/errors.rs b/src/errors.rs index 011edce..622a9ab 100644 --- a/src/errors.rs +++ b/src/errors.rs @@ -129,10 +129,6 @@ impl Error { pub(crate) fn undetermined_error(error: Error) -> Self { Error::from(ErrorKind::UndeterminedError(error)) } - - pub(crate) fn multiple_errors(errors: Vec) -> Self { - Error::from(ErrorKind::MultipleErrors(errors)) - } } impl From for Error { diff --git a/src/lib.rs b/src/lib.rs index 1618f3d..3a7af79 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -54,7 +54,7 @@ //! Regardless of which API you choose, you'll need to connect your client //! ([raw](raw::Client), [transactional](transaction::Client)). //! -//! ```rust +//! ```rust,no_run //! # use tikv_client::*; //! # use futures::prelude::*; //! @@ -65,11 +65,8 @@ //! "192.168.0.101:2379", //! ]).with_security("root.ca", "internal.cert", "internal.key"); //! -//! // Get an unresolved connection. -//! let connect = TransactionClient::connect(config); -//! -//! // Resolve the connection into a client. -//! let client = connect.into_future().await; +//! // Get a transactional client. +//! let client = TransactionClient::new(config).await.unwrap(); //! # }); //! ``` //! diff --git a/src/transaction/client.rs b/src/transaction/client.rs index 56a2a11..d092d95 100644 --- a/src/transaction/client.rs +++ b/src/transaction/client.rs @@ -24,7 +24,7 @@ impl Client { /// use tikv_client::{Config, TransactionClient}; /// use futures::prelude::*; /// # futures::executor::block_on(async { - /// let client = TransactionClient::new(Config::default()).await.unwrap; + /// let client = TransactionClient::new(Config::default()).await.unwrap(); /// # }); /// ``` pub async fn new(config: Config) -> Result { @@ -43,8 +43,7 @@ impl Client { /// use tikv_client::{Config, TransactionClient}; /// use futures::prelude::*; /// # futures::executor::block_on(async { - /// let connect = TransactionClient::connect(Config::default()); - /// let client = connect.await.unwrap(); + /// let client = TransactionClient::new(Config::default()).await.unwrap(); /// let mut transaction = client.begin().await.unwrap(); /// // ... Issue some commands. /// let commit = transaction.commit(); @@ -67,8 +66,7 @@ impl Client { /// use tikv_client::{Config, TransactionClient}; /// use futures::prelude::*; /// # futures::executor::block_on(async { - /// let connect = TransactionClient::connect(Config::default()); - /// let client = connect.await.unwrap(); + /// let client = TransactionClient::new(Config::default()).await.unwrap(); /// let timestamp = client.current_timestamp().await.unwrap(); /// # }); /// ``` diff --git a/src/transaction/transaction.rs b/src/transaction/transaction.rs index f739fba..b2d8038 100644 --- a/src/transaction/transaction.rs +++ b/src/transaction/transaction.rs @@ -29,8 +29,7 @@ use std::sync::Arc; /// use tikv_client::{Config, TransactionClient}; /// use futures::prelude::*; /// # futures::executor::block_on(async { -/// let connect = TransactionClient::connect(Config::default()); -/// let client = connect.await.unwrap(); +/// let client = TransactionClient::new(Config::default()).await.unwrap(); /// let txn = client.begin().await.unwrap(); /// # }); /// ``` @@ -50,9 +49,8 @@ impl Transaction { /// # use tikv_client::{Value, Config, transaction::Client}; /// # use futures::prelude::*; /// # futures::executor::block_on(async { - /// # let connecting_client = Client::connect(Config::new(vec!["192.168.0.100", "192.168.0.101"])); - /// # let connected_client = connecting_client.await.unwrap(); - /// let mut txn = connected_client.begin().await.unwrap(); + /// # let client = Client::new(Config::new(vec!["192.168.0.100", "192.168.0.101"])).await.unwrap(); + /// let mut txn = client.begin().await.unwrap(); /// let key = "TiKV".to_owned(); /// let result: Option = txn.get(key).await.unwrap(); /// // Finish the transaction... @@ -75,9 +73,8 @@ impl Transaction { /// # use futures::prelude::*; /// # use std::collections::HashMap; /// # futures::executor::block_on(async { - /// # let connecting_client = Client::connect(Config::new(vec!["192.168.0.100", "192.168.0.101"])); - /// # let connected_client = connecting_client.await.unwrap(); - /// let mut txn = connected_client.begin().await.unwrap(); + /// # let client = Client::new(Config::new(vec!["192.168.0.100", "192.168.0.101"])).await.unwrap(); + /// let mut txn = client.begin().await.unwrap(); /// let keys = vec!["TiKV".to_owned(), "TiDB".to_owned()]; /// let result: HashMap = txn /// .batch_get(keys) @@ -115,9 +112,8 @@ impl Transaction { /// # use tikv_client::{Key, Value, Config, transaction::Client}; /// # use futures::prelude::*; /// # futures::executor::block_on(async { - /// # let connecting_client = Client::connect(Config::new(vec!["192.168.0.100", "192.168.0.101"])); - /// # let connected_client = connecting_client.await.unwrap(); - /// let mut txn = connected_client.begin().await.unwrap(); + /// # let client = Client::new(Config::new(vec!["192.168.0.100", "192.168.0.101"])).await.unwrap(); + /// let mut txn = client.begin().await.unwrap(); /// let key = "TiKV".to_owned(); /// let val = "TiKV".to_owned(); /// txn.set(key, val); @@ -135,9 +131,8 @@ impl Transaction { /// # use tikv_client::{Key, Config, transaction::Client}; /// # use futures::prelude::*; /// # futures::executor::block_on(async { - /// # let connecting_client = Client::connect(Config::new(vec!["192.168.0.100", "192.168.0.101"])); - /// # let connected_client = connecting_client.await.unwrap(); - /// let mut txn = connected_client.begin().await.unwrap(); + /// # let client = Client::new(Config::new(vec!["192.168.0.100", "192.168.0.101"])).await.unwrap(); + /// let mut txn = client.begin().await.unwrap(); /// let key = "TiKV".to_owned(); /// txn.delete(key); /// // Finish the transaction... @@ -154,9 +149,8 @@ impl Transaction { /// # use tikv_client::{Config, transaction::Client}; /// # use futures::prelude::*; /// # futures::executor::block_on(async { - /// # let connect = Client::connect(Config::default()); - /// # let connected_client = connect.await.unwrap(); - /// let mut txn = connected_client.begin().await.unwrap(); + /// # let client = Client::new(Config::default()).await.unwrap(); + /// let mut txn = client.begin().await.unwrap(); /// txn.lock_keys(vec!["TiKV".to_owned(), "Rust".to_owned()]); /// // ... Do some actions. /// txn.commit().await.unwrap(); @@ -174,9 +168,8 @@ impl Transaction { /// # use tikv_client::{Config, transaction::Client}; /// # use futures::prelude::*; /// # futures::executor::block_on(async { - /// # let connect = Client::connect(Config::default()); - /// # let connected_client = connect.await.unwrap(); - /// let mut txn = connected_client.begin().await.unwrap(); + /// # let client = Client::new(Config::default()).await.unwrap(); + /// let mut txn = client.begin().await.unwrap(); /// // ... Do some actions. /// let req = txn.commit(); /// let result: () = req.await.unwrap(); diff --git a/tests/integration_tests.rs b/tests/integration_tests.rs index d33e88c..509871b 100644 --- a/tests/integration_tests.rs +++ b/tests/integration_tests.rs @@ -12,7 +12,7 @@ fn get_timestamp() -> Fallible<()> { let mut pool = ThreadPool::new()?; let config = Config::new(pd_addrs()); let fut = async { - let client = TransactionClient::connect(config).await?; + let client = TransactionClient::new(config).await?; Result::Ok(future::join_all((0..COUNT).map(|_| client.current_timestamp())).await) }; // Calculate each version of retrieved timestamp