summaryrefslogtreecommitdiff
path: root/crates/arti-rpc-client-core/README.md
blob: 5898a8cef9e2b5582f45cc82d3d2900c6e8c97cc (plain)
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
Notes so far:

 * On top of io::{BufRead,Write}, we build llconn::{Reader,Writer}.  Reader is a tiny wrapper; Writer validates the
   syntax of outgoing messages.

 * On top of them, we build conn::RpcConn.  This is the one I expect most users would want; it
   matches requests to responses and assigns IDs as needed.

 * I'm not using tokio or async at all.  I'm trying to keep dependencies to a minimum.

 * I am *not* following our usual practice with Display on errors; instead, I am including
   inner errors in the Display implementation of the outer errors.  The rationale here
   is that we probably just want to return a single string for FFI purposes.


 Coming next:
 * [x] clean out the X X X Xs
 * [x] diziet's revisions on connimpl.
 * [x] actual implementations for making connections.
 * [ ] More tests.
 * [ ] update this readme.
 * [x] interface for connecting to arti
 * [x] Initial C FFI wrappers.
 * [ ] C FFI wrappers for everything reasonable
 * [x] enable the usual warnings.
 * [ ] Finish this readme.