Fix concerns

This commit is contained in:
Pierre Krieger
2017-12-07 12:59:46 +01:00
parent 853656c938
commit f3f9c214e0
2 changed files with 6 additions and 4 deletions

View File

@@ -1,7 +1,8 @@
This crate provides the `RwStreamSink` type. It wraps around a `Stream + Sink` that produces
byte arrays, and implements `AsyncRead` and `AsyncWrite`.
and accepts byte arrays, and implements `AsyncRead` and `AsyncWrite`.
Each call to `write()` will send one packet on the sink. Calls to `read()` will read from
incoming packets.
> **Note**: This crate is mostly a utility crate and is not at all specific to libp2p.
> **Note**: Although this crate is hosted in the libp2p repo, it is purely a utility crate and
> not at all specific to libp2p.

View File

@@ -22,12 +22,13 @@
//#![doc(include = "../README.md")]
//! This crate provides the `RwStreamSink` type. It wraps around a `Stream + Sink` that produces
//! byte arrays, and implements `AsyncRead` and `AsyncWrite`.
//! and accepts byte arrays, and implements `AsyncRead` and `AsyncWrite`.
//!
//! Each call to `write()` will send one packet on the sink. Calls to `read()` will read from
//! incoming packets.
//!
//! > **Note**: This crate is mostly a utility crate and is not at all specific to libp2p.
//! > **Note**: Although this crate is hosted in the libp2p repo, it is purely a utility crate and
//! > not at all specific to libp2p.
extern crate bytes;
extern crate futures;