Skip to content

Commit a28f4ef

Browse files
authored
docs: add to bit slice iterator docs that the start value is inclusive and end value is exclusive (#7022)
1 parent 15249bf commit a28f4ef

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

arrow-buffer/src/util/bit_iterator.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,8 @@ impl DoubleEndedIterator for BitIterator<'_> {
9393
/// Returns `(usize, usize)` each representing an interval where the corresponding
9494
/// bits in the provides mask are set
9595
///
96+
/// the first value is the start of the range (inclusive) and the second value is the end of the range (exclusive)
97+
///
9698
#[derive(Debug)]
9799
pub struct BitSliceIterator<'a> {
98100
iter: UnalignedBitChunkIterator<'a>,

0 commit comments

Comments
 (0)