From 420bf4585080b3abe0809dc4b663413287b5072c Mon Sep 17 00:00:00 2001 From: Andrew Lamb Date: Fri, 25 Sep 2026 06:27:16 -0400 Subject: [PATCH] docs: Add example to BitChunks::chunk Applies review suggestion from https://github.com/apache/arrow-rs/pull/10136#discussion_r4094215179 Co-Authored-By: Claude Fable 5.1 --- arrow-buffer/src/util/bit_chunk_iterator.rs | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/arrow-buffer/src/util/bit_chunk_iterator.rs b/arrow-buffer/src/util/bit_chunk_iterator.rs index 77ebe83045c1..15bdafc589c1 100644 --- a/arrow-buffer/src/util/bit_chunk_iterator.rs +++ b/arrow-buffer/src/util/bit_chunk_iterator.rs @@ -330,6 +330,18 @@ impl<'a> BitChunks<'a> { /// # Panics /// /// Panics if `index >= self.chunk_len()` + /// + /// # Example + /// + /// ``` + /// # use arrow_buffer::Buffer; + /// let buffer = Buffer::from((0..17_u8).collect::>()); + /// // Start at bit 8, so chunk 1 holds bytes 9 through 16 + /// let chunks = buffer.bit_chunks(8, 128); + /// assert_eq!(chunks.chunk_len(), 2); + /// assert_eq!(chunks.chunk(1), 0x100f0e0d0c0b0a09); + /// assert_eq!(chunks.iter().nth(1), Some(chunks.chunk(1))); + /// ``` #[inline] pub fn chunk(&self, index: usize) -> u64 { assert!(index < self.chunk_len, "chunk index out of bounds");