Skip to content

Commit 19312c1

Browse files
jjeffcaiijjeffcaii
committed
chore: fix readme
1 parent 0439e93 commit 19312c1

File tree

9 files changed

+61
-82
lines changed

9 files changed

+61
-82
lines changed

‎README.md‎

Lines changed: 14 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -21,32 +21,26 @@ Add dependencies in your `Cargo.toml`.
2121

2222
```toml
2323
[dependencies]
24-
tokio = "0.2"
25-
rsocket_rust = "*"
24+
tokio = "0.3.6"
25+
rsocket_rust = "0.7.0"
2626

27-
# choose transport:
28-
# rsocket_rust_transport_tcp = "*"
29-
# rsocket_rust_transport_websocket = "*"
27+
# add transport dependencies:
28+
# rsocket_rust_transport_tcp = "0.7.0"
29+
# rsocket_rust_transport_websocket = "0.7.0"
3030
```
3131

3232
### Server
3333

3434
```rust
35-
#[macro_use]
36-
extern crate log;
37-
3835
use rsocket_rust::prelude::*;
36+
use rsocket_rust::utils::EchoRSocket;
37+
use rsocket_rust::Result;
3938
use rsocket_rust_transport_tcp::TcpServerTransport;
40-
use std::env;
41-
use std::error::Error;
4239

4340
#[tokio::main]
44-
async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
45-
env_logger::builder().format_timestamp_millis().init();
46-
let addr = env::args().nth(1).unwrap_or("127.0.0.1:7878".to_string());
47-
41+
async fn main() -> Result<()> {
4842
RSocketFactory::receive()
49-
.transport(TcpServerTransport::from(addr))
43+
.transport(TcpServerTransport::from("127.0.0.1:7878"))
5044
.acceptor(Box::new(|setup, _socket| {
5145
info!("accept setup: {:?}", setup);
5246
Ok(Box::new(EchoRSocket))
@@ -63,24 +57,22 @@ async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
6357

6458
```rust
6559
use rsocket_rust::prelude::*;
60+
use rsocket_rust::Result;
6661
use rsocket_rust_transport_tcp::TcpClientTransport;
6762

6863
#[tokio::main]
69-
#[test]
70-
async fn test() {
64+
async fn main() -> Result<()> {
7165
let cli = RSocketFactory::connect()
72-
.acceptor(Box::new(|| Box::new(EchoRSocket)))
7366
.transport(TcpClientTransport::from("127.0.0.1:7878"))
7467
.setup(Payload::from("READY!"))
7568
.mime_type("text/plain", "text/plain")
7669
.start()
77-
.await
78-
.unwrap();
70+
.await?;
7971
let req = Payload::builder()
8072
.set_data_utf8("Hello World!")
8173
.set_metadata_utf8("Rust")
8274
.build();
83-
let res = cli.request_response(req).await.unwrap();
75+
let res = cli.request_response(req).await?;
8476
println!("got: {:?}", res);
8577
cli.close();
8678
}
@@ -100,7 +92,7 @@ async fn test() {
10092
- [ ] Cancel
10193
- [x] Fragmentation
10294
- [ ] Resume
103-
- [ ] Keepalive
95+
- [x] Keepalive
10496
- QoS
10597
- [ ] RequestN
10698
- [ ] Lease

‎rsocket-messaging/Cargo.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "rsocket_rust_messaging"
3-
version = "0.6.1"
3+
version = "0.7.0"
44
authors = ["Jeffsky <jjeffcaii@outlook.com>"]
55
edition = "2018"
66
license = "Apache-2.0"

‎rsocket-transport-tcp/Cargo.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "rsocket_rust_transport_tcp"
3-
version = "0.6.1"
3+
version = "0.7.0"
44
authors = ["Jeffsky <jjeffcaii@outlook.com>"]
55
edition = "2018"
66
license = "Apache-2.0"

‎rsocket-transport-tcp/README.md‎

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,22 @@ Add dependencies in your `Cargo.toml`.
66

77
```toml
88
[dependencies]
9-
tokio = "0.2.21"
10-
rsocket_rust = "0.5.3"
11-
rsocket_rust_transport_tcp = "0.5.3"
9+
tokio = "0.3.6"
10+
rsocket_rust = "0.7.0"
11+
rsocket_rust_transport_tcp = "0.7.0"
1212
```
1313

1414
### Server
1515

1616
```rust
1717
use log::info;
18-
use rsocket_rust::prelude::{EchoRSocket, RSocketFactory, ServerResponder};
18+
use rsocket_rust::prelude::{RSocketFactory, ServerResponder};
19+
use rsocket_rust::Result;
20+
use rsocket_rust::utils::EchoRSocket;
1921
use rsocket_rust_transport_tcp::TcpServerTransport;
20-
use std::error::Error;
2122

2223
#[tokio::main]
23-
async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
24+
async fn main() -> Result<()> {
2425
let transport: TcpServerTransport = TcpServerTransport::from("127.0.0.1:7878");
2526

2627
let responder: ServerResponder = Box::new(|setup, _socket| {
@@ -49,29 +50,25 @@ async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
4950

5051
```rust
5152
use log::info;
52-
use rsocket_rust::prelude::{ClientResponder, EchoRSocket, Payload, RSocket, RSocketFactory};
53+
use rsocket_rust::prelude::{ClientResponder, Payload, RSocket, RSocketFactory};
54+
use rsocket_rust::Result;
5355
use rsocket_rust_transport_tcp::TcpClientTransport;
54-
use std::error::Error;
5556

5657
#[tokio::main]
57-
async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
58-
let responder: ClientResponder = Box::new(|| Box::new(EchoRSocket));
59-
58+
async fn main() -> Result<()> {
6059
let client = RSocketFactory::connect()
61-
.acceptor(responder)
6260
.transport(TcpClientTransport::from("127.0.0.1:7878"))
6361
.setup(Payload::from("READY!"))
6462
.mime_type("text/plain", "text/plain")
6563
.start()
66-
.await
67-
.unwrap();
64+
.await?;
6865

6966
let request_payload: Payload = Payload::builder()
7067
.set_data_utf8("Hello World!")
7168
.set_metadata_utf8("Rust")
7269
.build();
7370

74-
let res = client.request_response(request_payload).await.unwrap();
71+
let res = client.request_response(request_payload).await?;
7572

7673
info!("got: {:?}", res);
7774

‎rsocket-transport-wasm/Cargo.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "rsocket_rust_transport_wasm"
3-
version = "0.6.1"
3+
version = "0.7.0"
44
authors = ["Jeffsky <jjeffcaii@outlook.com>"]
55
edition = "2018"
66
license = "Apache-2.0"

‎rsocket-transport-websocket/Cargo.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "rsocket_rust_transport_websocket"
3-
version = "0.6.1"
3+
version = "0.7.0"
44
authors = ["Jeffsky <jjeffcaii@outlook.com>"]
55
edition = "2018"
66
license = "Apache-2.0"

‎rsocket-transport-websocket/README.md‎

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,22 @@ Add dependencies in your `Cargo.toml`.
66

77
```toml
88
[dependencies]
9-
tokio = "0.2.21"
10-
rsocket_rust = "0.5.3"
11-
rsocket_rust_transport_websocket = "0.5.3"
9+
tokio = "0.3.6"
10+
rsocket_rust = "0.7.0"
11+
rsocket_rust_transport_websocket = "0.7.0"
1212
```
1313

1414
### Server
1515

1616
```rust
1717
use log::info;
18-
use rsocket_rust::prelude::{EchoRSocket, RSocketFactory, ServerResponder};
18+
use rsocket_rust::prelude::*;
19+
use rsocket_rust::utils::EchoRSocket;
20+
use rsocket_rust::Result;
1921
use rsocket_rust_transport_websocket::WebsocketServerTransport;
20-
use std::error::Error;
2122

2223
#[tokio::main]
23-
async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
24+
async fn main() -> Result<()> {
2425
let transport: WebsocketServerTransport = WebsocketServerTransport::from("127.0.0.1:8080");
2526

2627
let responder: ServerResponder = Box::new(|setup, _socket| {
@@ -49,35 +50,30 @@ async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
4950

5051
```rust
5152
use log::info;
52-
use rsocket_rust::prelude::{ClientResponder, EchoRSocket, Payload, RSocket, RSocketFactory};
53+
use rsocket_rust::prelude::*;
54+
use rsocket_rust::Result;
5355
use rsocket_rust_transport_websocket::WebsocketClientTransport;
54-
use std::error::Error;
5556

5657
#[tokio::main]
57-
async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
58-
let responder: ClientResponder = Box::new(|| Box::new(EchoRSocket));
59-
58+
async fn main() -> Result<()> {
6059
let client = RSocketFactory::connect()
61-
.acceptor(responder)
6260
.transport(WebsocketClientTransport::from("127.0.0.1:8080"))
6361
.setup(Payload::from("READY!"))
6462
.mime_type("text/plain", "text/plain")
6563
.start()
66-
.await
67-
.unwrap();
64+
.await?;
6865

69-
let request_payload: Payload = Payload::builder()
66+
let request_payload = Payload::builder()
7067
.set_data_utf8("Hello World!")
7168
.set_metadata_utf8("Rust")
7269
.build();
7370

74-
let res = client.request_response(request_payload).await.unwrap();
71+
let res = client.request_response(request_payload).await?;
7572

7673
info!("got: {:?}", res);
7774

7875
client.close();
7976

8077
Ok(())
8178
}
82-
8379
```

‎rsocket/Cargo.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "rsocket_rust"
3-
version = "0.6.1"
3+
version = "0.7.0"
44
authors = ["Jeffsky <jjeffcaii@outlook.com>"]
55
edition = "2018"
66
license = "Apache-2.0"

‎rsocket/README.md‎

Lines changed: 17 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -10,39 +10,34 @@ Add dependencies in your `Cargo.toml`.
1010

1111
```toml
1212
[dependencies]
13-
tokio = "0.2"
14-
rsocket_rust = "*"
13+
tokio = "0.3.6"
14+
rsocket_rust = "0.7.0"
1515

16-
# choose transport:
17-
# rsocket_rust_transport_tcp = "*"
18-
# rsocket_rust_transport_websocket = "*"
16+
# add transport dependencies:
17+
# rsocket_rust_transport_tcp = "0.7.0"
18+
# rsocket_rust_transport_websocket = "0.7.0"
1919
```
2020

2121
### Server
2222

2323
```rust
24-
#[macro_use]
25-
extern crate log;
26-
2724
use rsocket_rust::prelude::*;
25+
use rsocket_rust::utils::EchoRSocket;
26+
use rsocket_rust::Result;
2827
use rsocket_rust_transport_tcp::TcpServerTransport;
29-
use std::env;
30-
use std::error::Error;
3128

3229
#[tokio::main]
33-
async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
34-
env_logger::builder().format_timestamp_millis().init();
35-
let addr = env::args().nth(1).unwrap_or("127.0.0.1:7878".to_string());
36-
30+
async fn main() -> Result<()> {
3731
RSocketFactory::receive()
38-
.transport(TcpServerTransport::from(addr))
32+
.transport(TcpServerTransport::from("127.0.0.1:7878"))
3933
.acceptor(Box::new(|setup, _socket| {
40-
info!("accept setup: {:?}", setup);
34+
println!("accept setup: {:?}", setup);
35+
// Use EchoRSocket as example RSocket, you can implement RSocket trait.
4136
Ok(Box::new(EchoRSocket))
4237
// Or you can reject setup
4338
// Err(From::from("SETUP_NOT_ALLOW"))
4439
}))
45-
.on_start(|| info!("+++++++ echo server started! +++++++"))
40+
.on_start(|| println!("+++++++ echo server started! +++++++"))
4641
.serve()
4742
.await
4843
}
@@ -52,26 +47,25 @@ async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
5247

5348
```rust
5449
use rsocket_rust::prelude::*;
50+
use rsocket_rust::Result;
5551
use rsocket_rust_transport_tcp::TcpClientTransport;
5652

5753
#[tokio::main]
58-
#[test]
59-
async fn test() {
54+
async fn main() -> Result<()> {
6055
let cli = RSocketFactory::connect()
61-
.acceptor(Box::new(|| Box::new(EchoRSocket)))
6256
.transport(TcpClientTransport::from("127.0.0.1:7878"))
6357
.setup(Payload::from("READY!"))
6458
.mime_type("text/plain", "text/plain")
6559
.start()
66-
.await
67-
.unwrap();
60+
.await?;
6861
let req = Payload::builder()
6962
.set_data_utf8("Hello World!")
7063
.set_metadata_utf8("Rust")
7164
.build();
72-
let res = cli.request_response(req).await.unwrap();
65+
let res = cli.request_response(req).await?;
7366
println!("got: {:?}", res);
7467
cli.close();
68+
Ok(())
7569
}
7670

7771
```

0 commit comments

Comments
 (0)