PR review: rename the weirdly named ...Specific traits

hopefully this makes it more clear what they are for!

Author: rklaehn

examples/compression.rs

@@ -60,7 +60,8 @@ mod lz4 {
     use async_compression::tokio::{bufread::Lz4Decoder, write::Lz4Encoder};
     use iroh::endpoint::VarInt;
     use iroh_blobs::util::{
-        AsyncReadRecvStream, AsyncWriteSendStream, RecvStreamSpecific, SendStreamSpecific,
+        AsyncReadRecvStream, AsyncReadRecvStreamExtra, AsyncWriteSendStream,
+        AsyncWriteSendStreamExtra,
     };
     use tokio::io::{AsyncRead, AsyncWrite, BufReader};
 
@@ -72,7 +73,7 @@ mod lz4 {
         }
     }
 
-    impl SendStreamSpecific for SendStream {
+    impl AsyncWriteSendStreamExtra for SendStream {
         fn inner(&mut self) -> &mut (impl AsyncWrite + Unpin + Send) {
             &mut self.0
         }
@@ -84,6 +85,10 @@ mod lz4 {
         async fn stopped(&mut self) -> io::Result<Option<VarInt>> {
             Ok(self.0.get_mut().stopped().await?)
         }
+
+        fn id(&self) -> u64 {
+            self.0.get_ref().id().index()
+        }
     }
 
     struct RecvStream(Lz4Decoder<BufReader<iroh::endpoint::RecvStream>>);
@@ -94,7 +99,7 @@ mod lz4 {
         }
     }
 
-    impl RecvStreamSpecific for RecvStream {
+    impl AsyncReadRecvStreamExtra for RecvStream {
         fn inner(&mut self) -> &mut (impl AsyncRead + Unpin + Send) {
             &mut self.0
         }

src/util.rs

@@ -4,8 +4,8 @@ pub mod connection_pool;
 mod stream;
 pub(crate) mod temp_tag;
 pub use stream::{
-    AsyncReadRecvStream, AsyncWriteSendStream, RecvStream, RecvStreamAsyncStreamReader,
-    RecvStreamSpecific, SendStream, SendStreamSpecific,
+    AsyncReadRecvStream, AsyncReadRecvStreamExtra, AsyncWriteSendStream, AsyncWriteSendStreamExtra,
+    RecvStream, RecvStreamAsyncStreamReader, SendStream,
 };
 pub(crate) use stream::{RecvStreamExt, SendStreamExt};
 

src/util/stream.rs

@@ -170,13 +170,22 @@ impl<W: SendStream> SendStream for &mut W {
 #[derive(Debug)]
 pub struct AsyncReadRecvStream<R>(R);
 
+/// This is a helper trait to work with [`AsyncReadRecvStream`]. If you have an
+/// `AsyncRead + Unpin + Send`, you can implement these additional methods and wrap the result
+/// in an `AsyncReadRecvStream` to get a `RecvStream` that reads from the underlying `AsyncRead`.
+pub trait AsyncReadRecvStreamExtra: Send {
+    fn inner(&mut self) -> &mut (impl AsyncRead + Unpin + Send);
+    fn stop(&mut self, code: VarInt) -> io::Result<()>;
+    fn id(&self) -> u64;
+}
+
 impl<R> AsyncReadRecvStream<R> {
     pub fn new(inner: R) -> Self {
         Self(inner)
     }
 }
 
-impl<R: RecvStreamSpecific> RecvStream for AsyncReadRecvStream<R> {
+impl<R: AsyncReadRecvStreamExtra> RecvStream for AsyncReadRecvStream<R> {
     async fn recv_bytes(&mut self, len: usize) -> io::Result<Bytes> {
         let mut res = vec![0; len];
         let mut n = 0;
@@ -215,18 +224,6 @@ impl<R: RecvStreamSpecific> RecvStream for AsyncReadRecvStream<R> {
     }
 }
 
-pub trait RecvStreamSpecific: Send {
-    fn inner(&mut self) -> &mut (impl AsyncRead + Unpin + Send);
-    fn stop(&mut self, code: VarInt) -> io::Result<()>;
-    fn id(&self) -> u64;
-}
-
-pub trait SendStreamSpecific: Send {
-    fn inner(&mut self) -> &mut (impl AsyncWrite + Unpin + Send);
-    fn reset(&mut self, code: VarInt) -> io::Result<()>;
-    fn stopped(&mut self) -> impl Future<Output = io::Result<Option<VarInt>>> + Send;
-}
-
 impl RecvStream for Bytes {
     async fn recv_bytes(&mut self, len: usize) -> io::Result<Bytes> {
         let n = len.min(self.len());
@@ -267,19 +264,31 @@ impl RecvStream for Bytes {
 #[derive(Debug, Clone)]
 pub struct AsyncWriteSendStream<W>(W);
 
-impl<W: SendStreamSpecific> AsyncWriteSendStream<W> {
+/// This is a helper trait to work with [`AsyncWriteSendStream`].
+///
+/// If you have an `AsyncWrite + Unpin + Send`, you can implement these additional
+/// methods and wrap the result in an `AsyncWriteSendStream` to get a `SendStream`
+/// that writes to the underlying `AsyncWrite`.
+pub trait AsyncWriteSendStreamExtra: Send {
+    fn inner(&mut self) -> &mut (impl AsyncWrite + Unpin + Send);
+    fn reset(&mut self, code: VarInt) -> io::Result<()>;
+    fn stopped(&mut self) -> impl Future<Output = io::Result<Option<VarInt>>> + Send;
+    fn id(&self) -> u64;
+}
+
+impl<W: AsyncWriteSendStreamExtra> AsyncWriteSendStream<W> {
     pub fn new(inner: W) -> Self {
         Self(inner)
     }
 }
 
-impl<W: SendStreamSpecific> AsyncWriteSendStream<W> {
+impl<W: AsyncWriteSendStreamExtra> AsyncWriteSendStream<W> {
     pub fn into_inner(self) -> W {
         self.0
     }
 }
 
-impl<W: SendStreamSpecific> SendStream for AsyncWriteSendStream<W> {
+impl<W: AsyncWriteSendStreamExtra> SendStream for AsyncWriteSendStream<W> {
     async fn send_bytes(&mut self, bytes: Bytes) -> io::Result<()> {
         self.0.inner().write_all(&bytes).await
     }
@@ -303,7 +312,7 @@ impl<W: SendStreamSpecific> SendStream for AsyncWriteSendStream<W> {
     }
 
     fn id(&self) -> u64 {
-        0
+        self.0.id()
     }
 }