add documentation to Bitmap::as_slice

jorgecarleitao · Dec 2, 2021 · 65b70c3 · 65b70c3
1 parent 8300684
commit 65b70c3
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/bitmap/immutable.rs b/src/bitmap/immutable.rs
@@ -238,6 +238,12 @@ impl Bitmap {
 
 impl Bitmap {
     /// Returns the byte slice of this Bitmap.
+    ///
+    /// The returned tuple contains:
+    /// .1 -> The byte slice, truncated to the start of the first bit. So the start of the slice
+    ///       is within the first 8 bits.
+    /// .2 -> The start offset in bits, given what described above `0 <= offsets < 8`.
+    /// .3 -> The length in bits.
     #[inline]
     pub fn as_slice(&self) -> (&[u8], usize, usize) {
         let start = self.offset / 8;