chunking: Add some doc comments

Just a drive by.
ostreedev · Jun 19, 2024 · dfcea4a · dfcea4a
1 parent 7e8a0ab
commit dfcea4a
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lib/src/chunking.rs b/lib/src/chunking.rs
@@ -30,7 +30,10 @@ pub(crate) const MAX_CHUNKS: u32 = 64;
 /// we will just drop down to one.
 const MIN_CHUNKED_LAYERS: u32 = 4;
 
+/// A convenient alias for a reference-counted, immutable string.
 type RcStr = Rc<str>;
+/// Maps from a checksum to its size and file names (multiple in the case of
+/// hard links).
 pub(crate) type ChunkMapping = BTreeMap<RcStr, (u64, Vec<Utf8PathBuf>)>;
 // TODO type PackageSet = HashSet<RcStr>;