- Hide the test module from docs (it will be removed/hidden behind a feature flag into a separate crate eventually.

- Make util pub(crate)
- Remove unused code in the hash_seq module

Author: rklaehn

src/hashseq.rs

@@ -1,8 +1,7 @@
 //! Helpers for blobs that contain a sequence of hashes.
-use std::{fmt::Debug, io};
+use std::fmt::Debug;
 
 use bytes::Bytes;
-use iroh_io::{AsyncSliceReader, AsyncSliceReaderExt};
 
 use crate::Hash;
 
@@ -51,34 +50,6 @@ impl IntoIterator for HashSeq {
     }
 }
 
-/// Stream over the hashes in a [`HashSeq`].
-///
-/// todo: make this wrap a reader instead of a [`HashSeq`].
-#[derive(Debug, Clone)]
-pub struct HashSeqStream(HashSeq);
-
-impl HashSeqStream {
-    /// Get the next hash in the sequence.
-    #[allow(clippy::should_implement_trait, clippy::unused_async)]
-    pub async fn next(&mut self) -> io::Result<Option<Hash>> {
-        Ok(self.0.pop_front())
-    }
-
-    /// Skip a number of hashes in the sequence.
-    #[allow(clippy::unused_async)]
-    pub async fn skip(&mut self, n: u64) -> io::Result<()> {
-        let ok = self.0.drop_front(n as usize);
-        if !ok {
-            Err(io::Error::new(
-                io::ErrorKind::UnexpectedEof,
-                "end of sequence",
-            ))
-        } else {
-            Ok(())
-        }
-    }
-}
-
 impl HashSeq {
     /// Create a new sequence of hashes.
     pub fn new(bytes: Bytes) -> Option<Self> {
@@ -89,16 +60,6 @@ impl HashSeq {
         }
     }
 
-    fn drop_front(&mut self, n: usize) -> bool {
-        let start = n * 32;
-        if start > self.0.len() {
-            false
-        } else {
-            self.0 = self.0.slice(start..);
-            true
-        }
-    }
-
     /// Iterate over the hashes in this sequence.
     pub fn iter(&self) -> impl Iterator<Item = Hash> + '_ {
         self.0.chunks_exact(32).map(|chunk| {
@@ -155,14 +116,3 @@ impl Iterator for HashSeqIter {
         self.0.pop_front()
     }
 }
-
-/// Parse a sequence of hashes.
-pub async fn parse_hash_seq<'a, R: AsyncSliceReader + 'a>(
-    mut reader: R,
-) -> anyhow::Result<(HashSeqStream, u64)> {
-    let bytes = reader.read_to_end().await?;
-    let hashes = HashSeq::try_from(bytes)?;
-    let num_hashes = hashes.len() as u64;
-    let stream = HashSeqStream(hashes);
-    Ok((stream, num_hashes))
-}

src/lib.rs

@@ -11,9 +11,11 @@ mod net_protocol;
 pub use net_protocol::BlobsProtocol;
 pub mod protocol;
 pub mod provider;
-pub mod test;
 pub mod ticket;
-pub mod util;
+
+#[doc(hidden)]
+pub mod test;
+mod util;
 
 #[cfg(test)]
 mod tests;