Crate async_proto[−][src]
This is async-proto
, a library crate facilitating simple binary network protocols with async
support.
The main feature is the Protocol
trait, which allows reading a value of an implementing type from an async or sync stream, as well as writing one to an async or sync sink.
Protocol
can be derived for enum
s and struct
s if all fields implement Protocol
.
Features
The following features can be enabled via Cargo:
blocking
: Shorthand for enabling bothread-sync
andwrite-sync
.read-sync
: Adds a blockingread_sync
method to theProtocol
trait.serde_json
: Adds a dependency on theserde_json
crate and implementsProtocol
for itsValue
,Map
, andNumber
types.tokio-tungstenite
: Adds a dependency on thetokio-tungstenite
crate and convenience methods for reading/writingProtocol
types from/to its websockets.warp
: Adds a dependency on thewarp
crate and convenience methods for reading/writingProtocol
types from/to its websockets.write-sync
: Adds a blockingwrite_sync
method to theProtocol
trait.
Enums
ReadError | The error returned from the |
WriteError | The error returned from the |
Traits
Protocol | This trait allows reading a value of an implementing type from an async or sync stream, as well as writing one to an async or sync sink. |
Derive Macros
Protocol | Implements the |