Skip to content

Commit 98108bf

Browse files
nrcHoverbear
nrc
authored and
Hoverbear
committed
Rename Client::new to connect (#64)
Signed-off-by: Nick Cameron <nrc@ncameron.org>
1 parent e6f2251 commit 98108bf

File tree

6 files changed

+34
-36
lines changed

6 files changed

+34
-36
lines changed

‎examples/raw.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ async fn main() -> Result<()> {
2626

2727
// When we first create a client we receive a `Connect` structure which must be resolved before
2828
// the client is actually connected and usable.
29-
let unconnnected_client = Client::new(config);
29+
let unconnnected_client = Client::connect(config);
3030
let client = unconnnected_client.await?;
3131

3232
// Requests are created from the connected client. These calls return structures which

‎examples/transaction.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ async fn main() {
8383
Config::new(args.pd)
8484
};
8585

86-
let txn = Client::new(config)
86+
let txn = Client::connect(config)
8787
.await
8888
.expect("Could not connect to tikv");
8989

‎src/lib.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@
6565
//! ]).with_security("root.ca", "internal.cert", "internal.key");
6666
//!
6767
//! // Get an unresolved connection.
68-
//! let connect = Client::new(config);
68+
//! let connect = Client::connect(config);
6969
//!
7070
//! // Resolve the connection into a client.
7171
//! let client = connect.into_future().await;

‎src/raw.rs‎

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,11 @@ impl Client {
2828
/// # use tikv_client::{Config, raw::Client};
2929
/// # use futures::prelude::*;
3030
/// # futures::executor::block_on(async {
31-
/// let connect = Client::new(Config::default());
31+
/// let connect = Client::connect(Config::default());
3232
/// let client = connect.await.unwrap();
3333
/// # });
3434
/// ```
35-
#[allow(clippy::new_ret_no_self)]
36-
pub fn new(config: Config) -> Connect {
35+
pub fn connect(config: Config) -> Connect {
3736
Connect::new(config)
3837
}
3938

@@ -52,7 +51,7 @@ impl Client {
5251
/// # use tikv_client::{Value, Config, raw::Client};
5352
/// # use futures::prelude::*;
5453
/// # futures::executor::block_on(async {
55-
/// # let connecting_client = Client::new(Config::new(vec!["192.168.0.100", "192.168.0.101"]));
54+
/// # let connecting_client = Client::connect(Config::new(vec!["192.168.0.100", "192.168.0.101"]));
5655
/// # let connected_client = connecting_client.await.unwrap();
5756
/// let key = "TiKV";
5857
/// let req = connected_client.get(key);
@@ -73,7 +72,7 @@ impl Client {
7372
/// # use tikv_client::{KvPair, Config, raw::Client};
7473
/// # use futures::prelude::*;
7574
/// # futures::executor::block_on(async {
76-
/// # let connecting_client = Client::new(Config::new(vec!["192.168.0.100", "192.168.0.101"]));
75+
/// # let connecting_client = Client::connect(Config::new(vec!["192.168.0.100", "192.168.0.101"]));
7776
/// # let connected_client = connecting_client.await.unwrap();
7877
/// let keys = vec!["TiKV", "TiDB"];
7978
/// let req = connected_client.batch_get(keys);
@@ -96,7 +95,7 @@ impl Client {
9695
/// # use tikv_client::{Key, Value, Config, raw::Client};
9796
/// # use futures::prelude::*;
9897
/// # futures::executor::block_on(async {
99-
/// # let connecting_client = Client::new(Config::new(vec!["192.168.0.100", "192.168.0.101"]));
98+
/// # let connecting_client = Client::connect(Config::new(vec!["192.168.0.100", "192.168.0.101"]));
10099
/// # let connected_client = connecting_client.await.unwrap();
101100
/// let key = "TiKV";
102101
/// let val = "TiKV";
@@ -117,7 +116,7 @@ impl Client {
117116
/// # use tikv_client::{Error, Result, KvPair, Key, Value, Config, raw::Client};
118117
/// # use futures::prelude::*;
119118
/// # futures::executor::block_on(async {
120-
/// # let connecting_client = Client::new(Config::new(vec!["192.168.0.100", "192.168.0.101"]));
119+
/// # let connecting_client = Client::connect(Config::new(vec!["192.168.0.100", "192.168.0.101"]));
121120
/// # let connected_client = connecting_client.await.unwrap();
122121
/// let kvpair1 = ("PD", "Go");
123122
/// let kvpair2 = ("TiKV", "Rust");
@@ -142,7 +141,7 @@ impl Client {
142141
/// # use tikv_client::{Key, Config, raw::Client};
143142
/// # use futures::prelude::*;
144143
/// # futures::executor::block_on(async {
145-
/// # let connecting_client = Client::new(Config::new(vec!["192.168.0.100", "192.168.0.101"]));
144+
/// # let connecting_client = Client::connect(Config::new(vec!["192.168.0.100", "192.168.0.101"]));
146145
/// # let connected_client = connecting_client.await.unwrap();
147146
/// let key = "TiKV";
148147
/// let req = connected_client.delete(key);
@@ -162,7 +161,7 @@ impl Client {
162161
/// # use tikv_client::{Config, raw::Client};
163162
/// # use futures::prelude::*;
164163
/// # futures::executor::block_on(async {
165-
/// # let connecting_client = Client::new(Config::new(vec!["192.168.0.100", "192.168.0.101"]));
164+
/// # let connecting_client = Client::connect(Config::new(vec!["192.168.0.100", "192.168.0.101"]));
166165
/// # let connected_client = connecting_client.await.unwrap();
167166
/// let keys = vec!["TiKV", "TiDB"];
168167
/// let req = connected_client.batch_delete(keys);
@@ -185,7 +184,7 @@ impl Client {
185184
/// # use tikv_client::{KvPair, Config, raw::Client};
186185
/// # use futures::prelude::*;
187186
/// # futures::executor::block_on(async {
188-
/// # let connecting_client = Client::new(Config::new(vec!["192.168.0.100", "192.168.0.101"]));
187+
/// # let connecting_client = Client::connect(Config::new(vec!["192.168.0.100", "192.168.0.101"]));
189188
/// # let connected_client = connecting_client.await.unwrap();
190189
/// let inclusive_range = "TiKV"..="TiDB";
191190
/// let req = connected_client.scan(inclusive_range, 2);
@@ -205,7 +204,7 @@ impl Client {
205204
/// # use tikv_client::{Key, Config, raw::Client};
206205
/// # use futures::prelude::*;
207206
/// # futures::executor::block_on(async {
208-
/// # let connecting_client = Client::new(Config::new(vec!["192.168.0.100", "192.168.0.101"]));
207+
/// # let connecting_client = Client::connect(Config::new(vec!["192.168.0.100", "192.168.0.101"]));
209208
/// # let connected_client = connecting_client.await.unwrap();
210209
/// let inclusive_range1 = "TiDB"..="TiKV";
211210
/// let inclusive_range2 = "TiKV"..="TiSpark";
@@ -237,7 +236,7 @@ impl Client {
237236
/// # use tikv_client::{Key, Config, raw::Client};
238237
/// # use futures::prelude::*;
239238
/// # futures::executor::block_on(async {
240-
/// # let connecting_client = Client::new(Config::new(vec!["192.168.0.100", "192.168.0.101"]));
239+
/// # let connecting_client = Client::connect(Config::new(vec!["192.168.0.100", "192.168.0.101"]));
241240
/// # let connected_client = connecting_client.await.unwrap();
242241
/// let inclusive_range = "TiKV"..="TiDB";
243242
/// let req = connected_client.delete_range(inclusive_range);
@@ -259,7 +258,7 @@ impl Client {
259258
/// use futures::prelude::*;
260259
///
261260
/// # futures::executor::block_on(async {
262-
/// let connect: Connect = Client::new(Config::default());
261+
/// let connect: Connect = Client::connect(Config::default());
263262
/// let client: Client = connect.await.unwrap();
264263
/// # });
265264
/// ```

‎src/transaction.rs‎

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,11 @@ impl Client {
2525
/// use tikv_client::{Config, transaction::Client};
2626
/// use futures::prelude::*;
2727
/// # futures::executor::block_on(async {
28-
/// let connect = Client::new(Config::default());
28+
/// let connect = Client::connect(Config::default());
2929
/// let client = connect.await.unwrap();
3030
/// # });
3131
/// ```
32-
#[allow(clippy::new_ret_no_self)]
33-
pub fn new(config: Config) -> Connect {
32+
pub fn connect(config: Config) -> Connect {
3433
Connect::new(config)
3534
}
3635

@@ -43,7 +42,7 @@ impl Client {
4342
/// use tikv_client::{Config, transaction::Client};
4443
/// use futures::prelude::*;
4544
/// # futures::executor::block_on(async {
46-
/// let connect = Client::new(Config::default());
45+
/// let connect = Client::connect(Config::default());
4746
/// let client = connect.await.unwrap();
4847
/// let transaction = client.begin();
4948
/// // ... Issue some commands.
@@ -62,7 +61,7 @@ impl Client {
6261
/// use tikv_client::{Config, transaction::Client};
6362
/// use futures::prelude::*;
6463
/// # futures::executor::block_on(async {
65-
/// let connect = Client::new(Config::default());
64+
/// let connect = Client::connect(Config::default());
6665
/// let client = connect.await.unwrap();
6766
/// let timestamp = client.current_timestamp();
6867
/// let transaction = client.begin_with_timestamp(timestamp);
@@ -82,7 +81,7 @@ impl Client {
8281
/// use tikv_client::{Config, transaction::Client};
8382
/// use futures::prelude::*;
8483
/// # futures::executor::block_on(async {
85-
/// let connect = Client::new(Config::default());
84+
/// let connect = Client::connect(Config::default());
8685
/// let client = connect.await.unwrap();
8786
/// let snapshot = client.snapshot();
8887
/// // ... Issue some commands.
@@ -99,7 +98,7 @@ impl Client {
9998
/// use tikv_client::{Config, transaction::Client};
10099
/// use futures::prelude::*;
101100
/// # futures::executor::block_on(async {
102-
/// let connect = Client::new(Config::default());
101+
/// let connect = Client::connect(Config::default());
103102
/// let client = connect.await.unwrap();
104103
/// let timestamp = client.current_timestamp();
105104
/// # });
@@ -119,7 +118,7 @@ impl Client {
119118
/// use futures::prelude::*;
120119
///
121120
/// # futures::executor::block_on(async {
122-
/// let connect: Connect = Client::new(Config::default());
121+
/// let connect: Connect = Client::connect(Config::default());
123122
/// let client: Client = connect.await.unwrap();
124123
/// # });
125124
/// ```
@@ -196,7 +195,7 @@ impl Transaction {
196195
/// use tikv_client::{Config, transaction::Client};
197196
/// use futures::prelude::*;
198197
/// # futures::executor::block_on(async {
199-
/// let connect = Client::new(Config::default());
198+
/// let connect = Client::connect(Config::default());
200199
/// let client = connect.await.unwrap();
201200
/// let txn = client.begin();
202201
/// # });
@@ -214,7 +213,7 @@ impl Transaction {
214213
/// # use tikv_client::{Config, transaction::Client};
215214
/// # use futures::prelude::*;
216215
/// # futures::executor::block_on(async {
217-
/// # let connect = Client::new(Config::default());
216+
/// # let connect = Client::connect(Config::default());
218217
/// # let connected_client = connect.await.unwrap();
219218
/// let txn = connected_client.begin();
220219
/// // ... Do some actions.
@@ -233,7 +232,7 @@ impl Transaction {
233232
/// # use tikv_client::{Config, transaction::Client};
234233
/// # use futures::prelude::*;
235234
/// # futures::executor::block_on(async {
236-
/// # let connect = Client::new(Config::default());
235+
/// # let connect = Client::connect(Config::default());
237236
/// # let connected_client = connect.await.unwrap();
238237
/// let txn = connected_client.begin();
239238
/// // ... Do some actions.
@@ -252,7 +251,7 @@ impl Transaction {
252251
/// # use tikv_client::{Config, transaction::Client};
253252
/// # use futures::prelude::*;
254253
/// # futures::executor::block_on(async {
255-
/// # let connect = Client::new(Config::default());
254+
/// # let connect = Client::connect(Config::default());
256255
/// # let connected_client = connect.await.unwrap();
257256
/// let mut txn = connected_client.begin();
258257
/// // ... Do some actions.
@@ -275,7 +274,7 @@ impl Transaction {
275274
/// # use tikv_client::{Config, transaction::{Client, Timestamp}};
276275
/// # use futures::prelude::*;
277276
/// # futures::executor::block_on(async {
278-
/// # let connect = Client::new(Config::default());
277+
/// # let connect = Client::connect(Config::default());
279278
/// # let connected_client = connect.await.unwrap();
280279
/// let txn = connected_client.begin();
281280
/// // ... Do some actions.
@@ -293,7 +292,7 @@ impl Transaction {
293292
/// # use tikv_client::{Config, transaction::{Client, Snapshot}};
294293
/// # use futures::prelude::*;
295294
/// # futures::executor::block_on(async {
296-
/// # let connect = Client::new(Config::default());
295+
/// # let connect = Client::connect(Config::default());
297296
/// # let connected_client = connect.await.unwrap();
298297
/// let txn = connected_client.begin();
299298
/// // ... Do some actions.
@@ -311,7 +310,7 @@ impl Transaction {
311310
/// # use tikv_client::{Config, transaction::{Client, IsolationLevel}};
312311
/// # use futures::prelude::*;
313312
/// # futures::executor::block_on(async {
314-
/// # let connect = Client::new(Config::default());
313+
/// # let connect = Client::connect(Config::default());
315314
/// # let connected_client = connect.await.unwrap();
316315
/// let mut txn = connected_client.begin();
317316
/// txn.set_isolation_level(IsolationLevel::SnapshotIsolation);
@@ -331,7 +330,7 @@ impl Transaction {
331330
/// # use tikv_client::{Value, Config, transaction::Client};
332331
/// # use futures::prelude::*;
333332
/// # futures::executor::block_on(async {
334-
/// # let connecting_client = Client::new(Config::new(vec!["192.168.0.100", "192.168.0.101"]));
333+
/// # let connecting_client = Client::connect(Config::new(vec!["192.168.0.100", "192.168.0.101"]));
335334
/// # let connected_client = connecting_client.await.unwrap();
336335
/// let mut txn = connected_client.begin();
337336
/// let key = "TiKV";
@@ -355,7 +354,7 @@ impl Transaction {
355354
/// # use tikv_client::{KvPair, Config, transaction::Client};
356355
/// # use futures::prelude::*;
357356
/// # futures::executor::block_on(async {
358-
/// # let connecting_client = Client::new(Config::new(vec!["192.168.0.100", "192.168.0.101"]));
357+
/// # let connecting_client = Client::connect(Config::new(vec!["192.168.0.100", "192.168.0.101"]));
359358
/// # let connected_client = connecting_client.await.unwrap();
360359
/// let mut txn = connected_client.begin();
361360
/// let keys = vec!["TiKV", "TiDB"];
@@ -386,7 +385,7 @@ impl Transaction {
386385
/// # use tikv_client::{Key, Value, Config, transaction::Client};
387386
/// # use futures::prelude::*;
388387
/// # futures::executor::block_on(async {
389-
/// # let connecting_client = Client::new(Config::new(vec!["192.168.0.100", "192.168.0.101"]));
388+
/// # let connecting_client = Client::connect(Config::new(vec!["192.168.0.100", "192.168.0.101"]));
390389
/// # let connected_client = connecting_client.await.unwrap();
391390
/// let mut txn = connected_client.begin();
392391
/// let key = "TiKV";
@@ -410,7 +409,7 @@ impl Transaction {
410409
/// # use tikv_client::{Key, Config, transaction::Client};
411410
/// # use futures::prelude::*;
412411
/// # futures::executor::block_on(async {
413-
/// # let connecting_client = Client::new(Config::new(vec!["192.168.0.100", "192.168.0.101"]));
412+
/// # let connecting_client = Client::connect(Config::new(vec!["192.168.0.100", "192.168.0.101"]));
414413
/// # let connected_client = connecting_client.await.unwrap();
415414
/// let mut txn = connected_client.begin();
416415
/// let key = "TiKV";

‎tests/integration_tests/raw.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ async fn wipe_all(client: &Client) {
2222
}
2323

2424
async fn connect() -> Client {
25-
let client = Client::new(Config::new(pd_addr()))
25+
let client = Client::connect(Config::new(pd_addr()))
2626
.await
2727
.expect("Could not connect to tikv");
2828
wipe_all(&client).await;

0 commit comments

Comments
 (0)