Crate async_proto
source ·Expand description
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
This crate offers optional dependencies on the following crates to enable Protocol
implementations for some of their types:
bytes
:Bytes
chrono
:NaiveDate
,DateTime
,Utc
, andFixedOffset
chrono-tz
:Tz
either
:Either
enumset
:EnumSet
git2
:Oid
gix-hash
:ObjectId
noisy_float
:NoisyFloat
semver
:Version
,Prerelease
, andBuildMetadata
serde_json
:Value
,Map
, andNumber
serenity
: The ID types, not includingShardId
uuid
:Uuid
Additionally, the following features can be enabled via Cargo:
tokio-tungstenite
: Adds a dependency on thetokio-tungstenite
crate and convenience methods for reading/writingProtocol
types from/to its websockets.tungstenite
: Adds a dependency on thetungstenite
crate and convenience methods for synchronously reading/writingProtocol
types from/to its websockets.
Macros§
- Implements
Protocol
for a type defined using thebitflags::bitflags
macro.
Structs§
- The error returned from the
write
andwrite_sync
methods.
Enums§
- Provides additional information about the origin of an error.
- Specifies what went wrong while reading (receiving) a value.
- Specifies what went wrong while writing (sending) a value.
Traits§
- 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.
Functions§
- websocket
tokio-tungstenite
Establishes a WebSocket connection to the given URL and returns a typed sink/stream pair.
Derive Macros§
- Implements the
Protocol
trait for this type.