39 releases (breaking)

0.28.0 Jan 14, 2025
0.27.0 Aug 9, 2024
0.26.3 Jun 4, 2024
0.26.1 Dec 9, 2023
0.1.1 Jul 13, 2020

#1733 in Network programming

Download history 66110/week @ 2025-02-05 74950/week @ 2025-02-12 60877/week @ 2025-02-19 62246/week @ 2025-02-26 64682/week @ 2025-03-05 66499/week @ 2025-03-12 60960/week @ 2025-03-19 70511/week @ 2025-03-26 61048/week @ 2025-04-02 62585/week @ 2025-04-09 52893/week @ 2025-04-16 76930/week @ 2025-04-23 58455/week @ 2025-04-30 54817/week @ 2025-05-07 65034/week @ 2025-05-14 53294/week @ 2025-05-21

244,935 downloads per month
Used in 269 crates (7 directly)

MIT license

1MB
16K SLoC

Generic request/response protocols.

General Usage

The Behaviour struct is a NetworkBehaviour that implements a generic request/response protocol or protocol family, whereby each request is sent over a new substream on a connection. Behaviour is generic over the actual messages being sent, which are defined in terms of a Codec. Creating a request/response protocol thus amounts to providing an implementation of this trait which can then be given to Behaviour::with_codec. Further configuration options are available via the Config.

Requests are sent using Behaviour::send_request and the responses received as Message::Response via Event::Message.

Responses are sent using Behaviour::send_response upon receiving a Message::Request via Event::Message.

Predefined codecs

In case your message types implement serde::Serialize and serde::Deserialize, you can use two predefined behaviours:

Protocol Families

A single Behaviour instance can be used with an entire protocol family that share the same request and response types. For that purpose, Codec::Protocol is typically instantiated with a sum type.

Limited Protocol Support

It is possible to only support inbound or outbound requests for a particular protocol. This is achieved by instantiating Behaviour with protocols using ProtocolSupport::Inbound or ProtocolSupport::Outbound. Any subset of protocols of a protocol family can be configured in this way. Such protocols will not be advertised during inbound respectively outbound protocol negotiation on the substreams.

Dependencies

~8–16MB
~196K SLoC