Struct NullBuffer
pub struct NullBuffer {
buffer: BooleanBuffer,
null_count: usize,
}
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.
Fields§
§buffer: BooleanBuffer
§null_count: usize
Implementations§
§impl NullBuffer
impl NullBuffer
pub fn new(buffer: BooleanBuffer) -> NullBuffer
pub fn new(buffer: BooleanBuffer) -> NullBuffer
Create a new NullBuffer
computing the null count
pub fn new_null(len: usize) -> NullBuffer
pub fn new_null(len: usize) -> NullBuffer
Create a new NullBuffer
of length len
where all values are null
pub fn new_valid(len: usize) -> NullBuffer
pub fn new_valid(len: usize) -> NullBuffer
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
pub unsafe fn new_unchecked(
buffer: BooleanBuffer,
null_count: usize,
) -> NullBuffer
pub unsafe fn new_unchecked( buffer: BooleanBuffer, null_count: usize, ) -> NullBuffer
Create a new NullBuffer
with the provided buffer
and null_count
§Safety
buffer
must contain null_count
0
bits
pub 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
pub fn contains(&self, other: &NullBuffer) -> bool
pub fn contains(&self, other: &NullBuffer) -> bool
Returns true if all nulls in other
also exist in self
pub fn expand(&self, count: usize) -> NullBuffer
pub fn expand(&self, count: usize) -> NullBuffer
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
pub fn len(&self) -> usize
pub fn len(&self) -> usize
Returns the length of this NullBuffer
pub fn offset(&self) -> usize
pub fn offset(&self) -> usize
Returns the offset of this NullBuffer
in bits
pub fn is_empty(&self) -> bool
pub fn is_empty(&self) -> bool
Returns true if this NullBuffer
is empty
pub fn null_count(&self) -> usize
pub fn null_count(&self) -> usize
Returns the null count for this NullBuffer
pub fn validity(&self) -> &[u8] ⓘ
pub fn validity(&self) -> &[u8] ⓘ
Returns the packed validity of this NullBuffer
not including any offset
pub fn slice(&self, offset: usize, len: usize) -> NullBuffer
pub fn slice(&self, offset: usize, len: usize) -> NullBuffer
Slices this NullBuffer
by the provided offset
and length
pub 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
pub 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
pub 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
pub fn try_for_each_valid_idx<E, F>(&self, f: F) -> Result<(), E>
pub fn try_for_each_valid_idx<E, F>(&self, f: F) -> Result<(), E>
Calls the provided closure for each index in this null mask that is set
pub fn inner(&self) -> &BooleanBuffer
pub fn inner(&self) -> &BooleanBuffer
Returns the inner BooleanBuffer
pub fn into_inner(self) -> BooleanBuffer
pub fn into_inner(self) -> BooleanBuffer
Returns the inner BooleanBuffer
Trait Implementations§
§impl Clone for NullBuffer
impl Clone for NullBuffer
§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 more§impl Debug for NullBuffer
impl Debug for NullBuffer
§impl From<&[bool]> for NullBuffer
impl From<&[bool]> for NullBuffer
§fn from(value: &[bool]) -> NullBuffer
fn from(value: &[bool]) -> NullBuffer
§impl From<BooleanBuffer> for NullBuffer
impl From<BooleanBuffer> for NullBuffer
§fn from(value: BooleanBuffer) -> NullBuffer
fn from(value: BooleanBuffer) -> NullBuffer
§impl From<Vec<bool>> for NullBuffer
impl From<Vec<bool>> for NullBuffer
§fn from(value: Vec<bool>) -> NullBuffer
fn from(value: Vec<bool>) -> NullBuffer
§impl FromIterator<bool> for NullBuffer
impl FromIterator<bool> for NullBuffer
§fn from_iter<T>(iter: T) -> NullBufferwhere
T: IntoIterator<Item = bool>,
fn from_iter<T>(iter: T) -> NullBufferwhere
T: IntoIterator<Item = bool>,
§impl<'a> IntoIterator for &'a NullBuffer
impl<'a> IntoIterator for &'a NullBuffer
§type IntoIter = BitIterator<'a>
type IntoIter = BitIterator<'a>
§fn into_iter(self) -> <&'a NullBuffer as IntoIterator>::IntoIter
fn into_iter(self) -> <&'a NullBuffer as IntoIterator>::IntoIter
§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
)§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.