core/muxing: Force StreamMuxer::Substream to implement `Async{Read,…

…Write}` (#2707) Co-authored-by: Max Inden <[email protected]>
libp2p · Jun 23, 2022 · eb490c0 · eb490c0
1 parent 118046c
commit eb490c0
Show file tree

Hide file tree

Showing 65 changed files with 367 additions and 779 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -44,10 +44,27 @@
 # `libp2p` facade crate
 
 # 0.46.0 [unreleased]
+
 - Semver bump Rust from `1.56.1` to `1.60.0` . See [PR 2646].
 - Added weak dependencies for features. See [PR 2646].
 - Update individual crates.
+    - Update to [`libp2p-autonat` `v0.5.0`](protocols/autonat/CHANGELOG.md#050).
+    - Update to [`libp2p-core` `v0.34.0`](core/CHANGELOG.md#0340).
+    - Update to [`libp2p-dcutr` `v0.4.0`](protocols/dcutr/CHANGELOG.md#040).
+    - Update to [`libp2p-floodsub` `v0.37.0`](protocols/floodsub/CHANGELOG.md#0370).
+    - Update to [`libp2p-identify` `v0.37.0`](protocols/identify/CHANGELOG.md#0370).
+    - Update to [`libp2p-kad` `v0.38.0`](protocols/kad/CHANGELOG.md#0380).
+    - Update to [`libp2p-metrics` `v0.7.0`](misc/metrics/CHANGELOG.md#070).
     - Update to [`libp2p-mplex` `v0.34.0`](muxers/mplex/CHANGELOG.md).
+    - Update to [`libp2p-noise` `v0.37.0`](transports/noise/CHANGELOG.md#0370).
+    - Update to [`libp2p-ping` `v0.37.0`](protocols/ping/CHANGELOG.md#0370).
+    - Update to [`libp2p-plaintext` `v0.34.0`](transports/plaintext/CHANGELOG.md#0340).
+    - Update to [`libp2p-relay` `v0.10.0`](protocols/relay/CHANGELOG.md#0100).
+    - Update to [`libp2p-rendezvous` `v0.7.0`](protocols/rendezvous/CHANGELOG.md#070).
+    - Update to [`libp2p-request-response` `v0.19.0`](protocols/request-response/CHANGELOG.md#0190).
+    - Update to [`libp2p-swarm` `v0.37.0`](swarm/CHANGELOG.md#0370).
+    - Update to [`libp2p-wasm-ext` `v0.34.0`](transports/wasm-ext/CHANGELOG.md#0340).
+    - Update to [`libp2p-yamux` `v0.38.0`](muxers/yamux/CHANGELOG.md#0380).
     - Update to `libp2p-uds` [`v0.33.0`](transports/uds/CHANGELOG.md).
 
 [PR 2646]: https://github.com/libp2p/rust-libp2p/pull/2646

diff --git a/Cargo.toml b/Cargo.toml
@@ -3,7 +3,7 @@ name = "libp2p"
 edition = "2021"
 rust-version = "1.60.0"
 description = "Peer-to-peer networking library"
-version = "0.46.0"
+version = "0.47.0"
 authors = ["Parity Technologies <[email protected]>"]
 license = "MIT"
 repository = "https://github.com/libp2p/rust-libp2p"
@@ -76,41 +76,41 @@ getrandom = "0.2.3" # Explicit dependency to be used in `wasm-bindgen` feature
 instant = "0.1.11" # Explicit dependency to be used in `wasm-bindgen` feature
 lazy_static = "1.2"
 
-libp2p-autonat = { version = "0.4.0", path = "protocols/autonat", optional = true }
-libp2p-core = { version = "0.33.0", path = "core",  default-features = false }
-libp2p-dcutr = { version = "0.3.1", path = "protocols/dcutr",  optional = true }
-libp2p-floodsub = { version = "0.36.0", path = "protocols/floodsub", optional = true }
-libp2p-identify = { version = "0.36.1", path = "protocols/identify", optional = true }
-libp2p-kad = { version = "0.37.1", path = "protocols/kad", optional = true }
-libp2p-metrics = { version = "0.6.0", path = "misc/metrics", optional = true }
+libp2p-autonat = { version = "0.5.0", path = "protocols/autonat", optional = true }
+libp2p-core = { version = "0.34.0", path = "core",  default-features = false }
+libp2p-dcutr = { version = "0.4.0", path = "protocols/dcutr",  optional = true }
+libp2p-floodsub = { version = "0.37.0", path = "protocols/floodsub", optional = true }
+libp2p-identify = { version = "0.37.0", path = "protocols/identify", optional = true }
+libp2p-kad = { version = "0.38.0", path = "protocols/kad", optional = true }
+libp2p-metrics = { version = "0.7.0", path = "misc/metrics", optional = true }
 libp2p-mplex = { version = "0.34.0", path = "muxers/mplex", optional = true }
-libp2p-noise = { version = "0.36.0", path = "transports/noise", optional = true }
-libp2p-ping = { version = "0.36.0", path = "protocols/ping", optional = true }
-libp2p-plaintext = { version = "0.33.0", path = "transports/plaintext", optional = true }
+libp2p-noise = { version = "0.37.0", path = "transports/noise", optional = true }
+libp2p-ping = { version = "0.37.0", path = "protocols/ping", optional = true }
+libp2p-plaintext = { version = "0.34.0", path = "transports/plaintext", optional = true }
 libp2p-pnet = { version = "0.22.0", path = "transports/pnet", optional = true }
-libp2p-relay = { version = "0.9.1", path = "protocols/relay", optional = true }
-libp2p-rendezvous = { version = "0.6.0", path = "protocols/rendezvous", optional = true }
-libp2p-request-response = { version = "0.18.0", path = "protocols/request-response", optional = true }
-libp2p-swarm = { version = "0.36.1", path = "swarm" }
+libp2p-relay = { version = "0.10.0", path = "protocols/relay", optional = true }
+libp2p-rendezvous = { version = "0.7.0", path = "protocols/rendezvous", optional = true }
+libp2p-request-response = { version = "0.19.0", path = "protocols/request-response", optional = true }
+libp2p-swarm = { version = "0.37.0", path = "swarm" }
 libp2p-swarm-derive = { version = "0.27.0", path = "swarm-derive" }
 libp2p-uds = { version = "0.33.0", path = "transports/uds", optional = true }
-libp2p-wasm-ext = { version = "0.33.0", path = "transports/wasm-ext", default-features = false, optional = true }
-libp2p-yamux = { version = "0.37.0", path = "muxers/yamux", optional = true }
+libp2p-wasm-ext = { version = "0.34.0", path = "transports/wasm-ext", default-features = false, optional = true }
+libp2p-yamux = { version = "0.38.0", path = "muxers/yamux", optional = true }
 multiaddr = { version = "0.14.0" }
 parking_lot = "0.12.0"
 pin-project = "1.0.0"
 rand = "0.7.3" # Explicit dependency to be used in `wasm-bindgen` feature
 smallvec = "1.6.1"
 
 [target.'cfg(not(any(target_os = "emscripten", target_os = "wasi", target_os = "unknown")))'.dependencies]
-libp2p-deflate = { version = "0.33.0", path = "transports/deflate", optional = true }
-libp2p-dns = { version = "0.33.0", path = "transports/dns", optional = true, default-features = false }
-libp2p-mdns = { version = "0.37.0", path = "protocols/mdns", optional = true }
-libp2p-tcp = { version = "0.33.0", path = "transports/tcp", default-features = false, optional = true }
-libp2p-websocket = { version = "0.35.0", path = "transports/websocket", optional = true }
+libp2p-deflate = { version = "0.34.0", path = "transports/deflate", optional = true }
+libp2p-dns = { version = "0.34.0", path = "transports/dns", optional = true, default-features = false }
+libp2p-mdns = { version = "0.38.0", path = "protocols/mdns", optional = true }
+libp2p-tcp = { version = "0.34.0", path = "transports/tcp", default-features = false, optional = true }
+libp2p-websocket = { version = "0.36.0", path = "transports/websocket", optional = true }
 
 [target.'cfg(not(target_os = "unknown"))'.dependencies]
-libp2p-gossipsub = { version = "0.38.0", path = "protocols/gossipsub", optional = true }
+libp2p-gossipsub = { version = "0.39.0", path = "protocols/gossipsub", optional = true }
 
 [dev-dependencies]
 async-std = { version = "1.6.2", features = ["attributes"] }

diff --git a/core/CHANGELOG.md b/core/CHANGELOG.md
@@ -1,8 +1,11 @@
-# 0.33.1 - unreleased
+# 0.34.0 - unreleased
 
 - Introduce `StreamMuxerEvent::map_inbound_stream`. See [PR 2691].
+- Remove `{read,write,flush,shutdown,destroy}_substream` functions from `StreamMuxer` trait
+  in favor of forcing `StreamMuxer::Substream` to implement `AsyncRead + AsyncWrite`. See [PR 2707].
 
 [PR 2691]: https://github.com/libp2p/rust-libp2p/pull/2691
+[PR 2707]: https://github.com/libp2p/rust-libp2p/pull/2707
 
 # 0.33.0
 

diff --git a/core/Cargo.toml b/core/Cargo.toml
@@ -3,7 +3,7 @@ name = "libp2p-core"
 edition = "2021"
 rust-version = "1.56.1"
 description = "Core traits and structs of libp2p"
-version = "0.33.1"
+version = "0.34.0"
 authors = ["Parity Technologies <[email protected]>"]
 license = "MIT"
 repository = "https://github.com/libp2p/rust-libp2p"

diff --git a/core/src/either.rs b/core/src/either.rs
@@ -259,85 +259,6 @@ where
         }
     }
 
-    fn read_substream(
-        &self,
-        cx: &mut Context<'_>,
-        sub: &mut Self::Substream,
-        buf: &mut [u8],
-    ) -> Poll<Result<usize, Self::Error>> {
-        match (self, sub) {
-            (EitherOutput::First(ref inner), EitherOutput::First(ref mut sub)) => {
-                inner.read_substream(cx, sub, buf).map_err(|e| e.into())
-            }
-            (EitherOutput::Second(ref inner), EitherOutput::Second(ref mut sub)) => {
-                inner.read_substream(cx, sub, buf).map_err(|e| e.into())
-            }
-            _ => panic!("Wrong API usage"),
-        }
-    }
-
-    fn write_substream(
-        &self,
-        cx: &mut Context<'_>,
-        sub: &mut Self::Substream,
-        buf: &[u8],
-    ) -> Poll<Result<usize, Self::Error>> {
-        match (self, sub) {
-            (EitherOutput::First(ref inner), EitherOutput::First(ref mut sub)) => {
-                inner.write_substream(cx, sub, buf).map_err(|e| e.into())
-            }
-            (EitherOutput::Second(ref inner), EitherOutput::Second(ref mut sub)) => {
-                inner.write_substream(cx, sub, buf).map_err(|e| e.into())
-            }
-            _ => panic!("Wrong API usage"),
-        }
-    }
-
-    fn flush_substream(
-        &self,
-        cx: &mut Context<'_>,
-        sub: &mut Self::Substream,
-    ) -> Poll<Result<(), Self::Error>> {
-        match (self, sub) {
-            (EitherOutput::First(ref inner), EitherOutput::First(ref mut sub)) => {
-                inner.flush_substream(cx, sub).map_err(|e| e.into())
-            }
-            (EitherOutput::Second(ref inner), EitherOutput::Second(ref mut sub)) => {
-                inner.flush_substream(cx, sub).map_err(|e| e.into())
-            }
-            _ => panic!("Wrong API usage"),
-        }
-    }
-
-    fn shutdown_substream(
-        &self,
-        cx: &mut Context<'_>,
-        sub: &mut Self::Substream,
-    ) -> Poll<Result<(), Self::Error>> {
-        match (self, sub) {
-            (EitherOutput::First(ref inner), EitherOutput::First(ref mut sub)) => {
-                inner.shutdown_substream(cx, sub).map_err(|e| e.into())
-            }
-            (EitherOutput::Second(ref inner), EitherOutput::Second(ref mut sub)) => {
-                inner.shutdown_substream(cx, sub).map_err(|e| e.into())
-            }
-            _ => panic!("Wrong API usage"),
-        }
-    }
-
-    fn destroy_substream(&self, substream: Self::Substream) {
-        match self {
-            EitherOutput::First(inner) => match substream {
-                EitherOutput::First(substream) => inner.destroy_substream(substream),
-                _ => panic!("Wrong API usage"),
-            },
-            EitherOutput::Second(inner) => match substream {
-                EitherOutput::Second(substream) => inner.destroy_substream(substream),
-                _ => panic!("Wrong API usage"),
-            },
-        }
-    }
-
     fn poll_close(&self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
         match self {
             EitherOutput::First(inner) => inner.poll_close(cx).map_err(|e| e.into()),