mrpc 0.0.1

MessagePack-RPC for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

[![Crates.io](https://img.shields.io/crates/v/mrpc.svg)](https://crates.io/crates/mrpc)
[![Documentation](https://docs.rs/mrpc/badge.svg)](https://docs.rs/mrpc)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)


# mrpc

A MessagePack-RPC implementation in Rust.

## Features

- Asynchronous RPC servers and clients
- Support for TCP and Unix domain sockets
- Full MessagePack-RPC spec implementation (requests, responses, notifications)
- Bidirectional communication support
- Built on `tokio` for async I/O
- Uses `rmpv` for MessagePack serialization

## Quick Start

Add this to your `Cargo.toml`:

```toml
[dependencies]
rust-msgpack-rpc = "0.1.0"
```

### Implementing a Server

1. Implement the `RpcService` trait:

```rust
use rust_msgpack_rpc::{RpcService, RpcSender, Result};
use rmpv::Value;

struct MyService;

#[async_trait::async_trait]
impl RpcService for MyService {
    async fn handle_request<S>(&self, _client: RpcSender, method: &str, params: Vec<Value>) -> Result<Value> {
        // Implement your RPC methods here
    }
}
```

2. Create and run the server:

```rust
use rust_msgpack_rpc::Server;

#[tokio::main]
async fn main() -> Result<()> {
    let service = MyService;
    let server = Server::new(service).tcp("127.0.0.1:8080").await?;
    server.run().await
}
```

### Implementing a Client

```rust
use rust_msgpack_rpc::Client;

#[tokio::main]
async fn main() -> Result<()> {
    let client = Client::connect_tcp("127.0.0.1:8080", ()).await?;
    let result = client.send_request("method_name".to_string(), vec![]).await?;
    println!("Result: {:?}", result);
}
```

## Bidirectional Communication

Both servers and clients can handle incoming RPC messages. To enable this for a
client, implement `RpcService` for it just like you would for a server.

## License

This project is licensed under [MIT License](LICENSE).

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.