Rust implementation of the Fizyr RPC procotol.
The Fizyr RPC protocol is a request/response protocol, with bi-directional feedback as long as a request is open. Additionally, you can send individual stream messages that do not initiate a request.
As a user of the library, you will mostly be using the [PeerHandle] object.
The [PeerHandle] is used to interact with a remote peer.
It is used to send and receive requests and stream messages.
It can also be split in a [PeerReadHandle] and a [PeerWriteHandle],
to allow moving the handles into different tasks.
The write handle can also be cloned and used in multiple tasks.
To obtain a [PeerHandle], you must first create a [Peer] object.
The [Peer] object is responsible for reading and writing messages with the peer,
but you can't use it for sending or receiving messages directly.
Instead, you must ensure that the [Peer::run()] future is being polled.
The easiest way to do that is by calling [Peer::spawn()],
which will run the future in a background task and returns a [PeerHandle].
The [Server] struct is used to accept incoming connections
and gives you a [PeerHandle] for each incoming connection.
You can then use the handle to process incoming messages and to send messages to the peer.
Usually, you will want to spawn a task for each accepted connection that handles the communication.
Each peer internally uses a [Transport].
The transport is responsible for reading and writing raw messages.
By abstracting away the message transport,
the library can expose a single generic [Peer] and [Server] struct.
There are different transports for different socket types.
Different transports may also use different types as message body.
For example, the [TcpTransport] and [UnixStreamTransport]
use messages with a [StreamBody].
This [StreamBody] body type contains raw bytes.
The [UnixSeqpacketTransport] has messages with a [UnixBody],
which allows you to embed file descriptors with each message.
The library uses features to avoid unnecessarily large dependency trees. Each feature corresponds to a different transport type. None of the features are enabled by default. Currently, the library has these features:
tcp: for the [TcpTransport]unix-stream: for the [UnixStreamTransport]unix-seqpacket: for the [UnixSeqpacketTransport]