pub struct NullBuffer { /* private fields */ }
Expand description
A BooleanBuffer
used to encode validity for arrow arrays
As per the Arrow specification, array validity is encoded in a packed bitmask with a
true
value indicating the corresponding slot is not null, and false
indicating
that it is null.
Implementations§
Source§impl NullBuffer
impl NullBuffer
Sourcepub fn new(buffer: BooleanBuffer) -> Self
pub fn new(buffer: BooleanBuffer) -> Self
Create a new NullBuffer
computing the null count
Sourcepub fn new_null(len: usize) -> Self
pub fn new_null(len: usize) -> Self
Create a new NullBuffer
of length len
where all values are null
Sourcepub fn new_valid(len: usize) -> Self
pub fn new_valid(len: usize) -> Self
Create a new NullBuffer
of length len
where all values are valid
Note: it is more efficient to not set the null buffer if it is known to be all valid
Sourcepub unsafe fn new_unchecked(buffer: BooleanBuffer, null_count: usize) -> Self
pub unsafe fn new_unchecked(buffer: BooleanBuffer, null_count: usize) -> Self
Create a new NullBuffer
with the provided buffer
and null_count
§Safety
buffer
must contain null_count
0
bits
Sourcepub fn union(
lhs: Option<&NullBuffer>,
rhs: Option<&NullBuffer>,
) -> Option<NullBuffer>
pub fn union( lhs: Option<&NullBuffer>, rhs: Option<&NullBuffer>, ) -> Option<NullBuffer>
Computes the union of the nulls in two optional NullBuffer
This is commonly used by binary operations where the result is NULL if either of the input values is NULL. Handling the null mask separately in this way can yield significant performance improvements over an iterator approach
Sourcepub fn contains(&self, other: &NullBuffer) -> bool
pub fn contains(&self, other: &NullBuffer) -> bool
Returns true if all nulls in other
also exist in self
Sourcepub fn expand(&self, count: usize) -> Self
pub fn expand(&self, count: usize) -> Self
Returns a new NullBuffer
where each bit in the current null buffer
is repeated count
times. This is useful for masking the nulls of
the child of a FixedSizeListArray based on its parent
Sourcepub fn len(&self) -> usize
pub fn len(&self) -> usize
Returns the length of this NullBuffer
Sourcepub fn offset(&self) -> usize
pub fn offset(&self) -> usize
Returns the offset of this NullBuffer
in bits
Sourcepub fn is_empty(&self) -> bool
pub fn is_empty(&self) -> bool
Returns true if this NullBuffer
is empty
Sourcepub fn null_count(&self) -> usize
pub fn null_count(&self) -> usize
Returns the null count for this NullBuffer
Sourcepub fn validity(&self) -> &[u8] ⓘ
pub fn validity(&self) -> &[u8] ⓘ
Returns the packed validity of this NullBuffer
not including any offset
Sourcepub fn slice(&self, offset: usize, len: usize) -> Self
pub fn slice(&self, offset: usize, len: usize) -> Self
Slices this NullBuffer
by the provided offset
and length
Sourcepub fn iter(&self) -> BitIterator<'_> ⓘ
pub fn iter(&self) -> BitIterator<'_> ⓘ
Returns an iterator over the bits in this NullBuffer
true
indicates that the corresponding value is not NULLfalse
indicates that the corresponding value is NULL
Note: Self::valid_indices
will be significantly faster for most use-cases
Sourcepub fn valid_indices(&self) -> BitIndexIterator<'_> ⓘ
pub fn valid_indices(&self) -> BitIndexIterator<'_> ⓘ
Returns a BitIndexIterator
over the valid indices in this NullBuffer
Valid indices indicate the corresponding value is not NULL
Sourcepub fn valid_slices(&self) -> BitSliceIterator<'_> ⓘ
pub fn valid_slices(&self) -> BitSliceIterator<'_> ⓘ
Returns a BitSliceIterator
yielding contiguous ranges of valid indices
Valid indices indicate the corresponding value is not NULL
Sourcepub fn try_for_each_valid_idx<E, F: FnMut(usize) -> Result<(), E>>(
&self,
f: F,
) -> Result<(), E>
pub fn try_for_each_valid_idx<E, F: FnMut(usize) -> Result<(), E>>( &self, f: F, ) -> Result<(), E>
Calls the provided closure for each index in this null mask that is set
Sourcepub fn inner(&self) -> &BooleanBuffer
pub fn inner(&self) -> &BooleanBuffer
Returns the inner BooleanBuffer
Sourcepub fn into_inner(self) -> BooleanBuffer
pub fn into_inner(self) -> BooleanBuffer
Returns the inner BooleanBuffer
Trait Implementations§
Source§impl Clone for NullBuffer
impl Clone for NullBuffer
Source§fn clone(&self) -> NullBuffer
fn clone(&self) -> NullBuffer
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for NullBuffer
impl Debug for NullBuffer
Source§impl From<&[bool]> for NullBuffer
impl From<&[bool]> for NullBuffer
Source§impl From<BooleanBuffer> for NullBuffer
impl From<BooleanBuffer> for NullBuffer
Source§fn from(value: BooleanBuffer) -> Self
fn from(value: BooleanBuffer) -> Self
Source§impl FromIterator<bool> for NullBuffer
impl FromIterator<bool> for NullBuffer
Source§impl<'a> IntoIterator for &'a NullBuffer
impl<'a> IntoIterator for &'a NullBuffer
Source§impl PartialEq for NullBuffer
impl PartialEq for NullBuffer
impl Eq for NullBuffer
impl StructuralPartialEq for NullBuffer
Auto Trait Implementations§
impl Freeze for NullBuffer
impl RefUnwindSafe for NullBuffer
impl Send for NullBuffer
impl Sync for NullBuffer
impl Unpin for NullBuffer
impl UnwindSafe for NullBuffer
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)