Update arrow-buffer/src/builder/null.rs

apache · Jan 27, 2025 · e98d831 · e98d831
1 parent 2439103
commit e98d831
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/arrow-buffer/src/builder/null.rs b/arrow-buffer/src/builder/null.rs
@@ -133,7 +133,10 @@ impl NullBufferBuilder {
         }
     }
 
-    /// Returns the capacity of the buffer
+    /// Returns the allocated capacity of the buffer, if any
+    ///
+    /// Note: if no nulls have been added, no buffer has been materialized
+    /// and this function will return 0, regardless of the capacity passed to `Self::new`
     #[inline]
     pub fn capacity(&self) -> usize {
         if let Some(ref buf) = self.bitmap_builder {