pub struct NullArray { /* private fields */ }
Expand description
An Array where all elements are nulls
A NullArray
is a simplified array where all values are null.
Example: Create an array
use arrow::array::{Array, NullArray};
let array = NullArray::new(10);
assert_eq!(array.len(), 10);
assert_eq!(array.null_count(), 10);
Implementations
Trait Implementations
sourceimpl Array for NullArray
impl Array for NullArray
sourcefn is_null(&self, _index: usize) -> bool
fn is_null(&self, _index: usize) -> bool
Returns whether the element at index
is null.
All elements of a NullArray
are always null.
sourcefn is_valid(&self, _index: usize) -> bool
fn is_valid(&self, _index: usize) -> bool
Returns whether the element at index
is valid.
All elements of a NullArray
are always invalid.
sourcefn null_count(&self) -> usize
fn null_count(&self) -> usize
Returns the total number of null values in this array.
The null count of a NullArray
always equals its length.
sourcefn data_ref(&self) -> &ArrayData
fn data_ref(&self) -> &ArrayData
Returns a reference-counted pointer to the underlying data of this array.
sourcefn slice(&self, offset: usize, length: usize) -> ArrayRef
fn slice(&self, offset: usize, length: usize) -> ArrayRef
Returns a zero-copy slice of this array with the indicated offset and length. Read more
sourcefn offset(&self) -> usize
fn offset(&self) -> usize
Returns the offset into the underlying data used by this array(-slice).
Note that the underlying data can be shared by many arrays.
This defaults to 0
. Read more
sourcefn get_buffer_memory_size(&self) -> usize
fn get_buffer_memory_size(&self) -> usize
Returns the total number of bytes of memory pointed to by this array. The buffers store bytes in the Arrow memory format, and include the data as well as the validity map. Read more
sourcefn get_array_memory_size(&self) -> usize
fn get_array_memory_size(&self) -> usize
Returns the total number of bytes of memory occupied physically by this array.
This value will always be greater than returned by get_buffer_memory_size()
and
includes the overhead of the data structures that contain the pointers to the various buffers. Read more
sourcefn to_raw(&self) -> Result<(*const FFI_ArrowArray, *const FFI_ArrowSchema)>
fn to_raw(&self) -> Result<(*const FFI_ArrowArray, *const FFI_ArrowSchema)>
returns two pointers that represent this array in the C Data Interface (FFI)
Auto Trait Implementations
impl RefUnwindSafe for NullArray
impl Send for NullArray
impl Sync for NullArray
impl Unpin for NullArray
impl UnwindSafe for NullArray
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more