Struct arrow::array::GenericListArray
source · [−]pub struct GenericListArray<OffsetSize> { /* private fields */ }
Expand description
Generic struct for a variable-size list array.
Columnar format in Apache Arrow: https://arrow.apache.org/docs/format/Columnar.html#variable-size-list-layout
For non generic lists, you may wish to consider using ListArray
or LargeListArray
`
Implementations
sourceimpl<OffsetSize: OffsetSizeTrait> GenericListArray<OffsetSize>
impl<OffsetSize: OffsetSizeTrait> GenericListArray<OffsetSize>
sourcepub fn value_type(&self) -> DataType
pub fn value_type(&self) -> DataType
Returns a clone of the value type of this list.
sourcepub unsafe fn value_unchecked(&self, i: usize) -> ArrayRef
pub unsafe fn value_unchecked(&self, i: usize) -> ArrayRef
Returns ith value of this list array.
Safety
Caller must ensure that the index is within the array bounds
sourcepub fn value_offsets(&self) -> &[OffsetSize]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]
pub fn value_offsets(&self) -> &[OffsetSize]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]
Returns the offset values in the offsets buffer
sourcepub fn value_length(&self, i: usize) -> OffsetSize
pub fn value_length(&self, i: usize) -> OffsetSize
Returns the length for value at index i
.
sourcepub fn iter<'a>(&'a self) -> GenericListArrayIter<'a, OffsetSize>ⓘNotable traits for GenericListArrayIter<'a, S>impl<'a, S: OffsetSizeTrait> Iterator for GenericListArrayIter<'a, S> type Item = Option<ArrayRef>;
pub fn iter<'a>(&'a self) -> GenericListArrayIter<'a, OffsetSize>ⓘNotable traits for GenericListArrayIter<'a, S>impl<'a, S: OffsetSizeTrait> Iterator for GenericListArrayIter<'a, S> type Item = Option<ArrayRef>;
constructs a new iterator
sourcepub fn from_iter_primitive<T, P, I>(iter: I) -> Self where
T: ArrowPrimitiveType,
P: AsRef<[Option<<T as ArrowPrimitiveType>::Native>]> + IntoIterator<Item = Option<<T as ArrowPrimitiveType>::Native>>,
I: IntoIterator<Item = Option<P>>,
pub fn from_iter_primitive<T, P, I>(iter: I) -> Self where
T: ArrowPrimitiveType,
P: AsRef<[Option<<T as ArrowPrimitiveType>::Native>]> + IntoIterator<Item = Option<<T as ArrowPrimitiveType>::Native>>,
I: IntoIterator<Item = Option<P>>,
Creates a GenericListArray
from an iterator of primitive values
Example
let data = vec![
Some(vec![Some(0), Some(1), Some(2)]),
None,
Some(vec![Some(3), None, Some(5)]),
Some(vec![Some(6), Some(7)]),
];
let list_array = ListArray::from_iter_primitive::<Int32Type, _, _>(data);
println!("{:?}", list_array);
Trait Implementations
sourceimpl<OffsetSize: 'static + OffsetSizeTrait> Array for GenericListArray<OffsetSize>
impl<OffsetSize: 'static + OffsetSizeTrait> Array for GenericListArray<OffsetSize>
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 is_null(&self, index: usize) -> bool
fn is_null(&self, index: usize) -> bool
Returns whether the element at index
is null.
When using this function on a slice, the index is relative to the slice. Read more
sourcefn is_valid(&self, index: usize) -> bool
fn is_valid(&self, index: usize) -> bool
Returns whether the element at index
is not null.
When using this function on a slice, the index is relative to the slice. Read more
sourcefn null_count(&self) -> usize
fn null_count(&self) -> usize
Returns the total number of null values in this array. 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)
sourceimpl<OffsetSize: OffsetSizeTrait> Debug for GenericListArray<OffsetSize>
impl<OffsetSize: OffsetSizeTrait> Debug for GenericListArray<OffsetSize>
sourceimpl<OffsetSize: OffsetSizeTrait> From<ArrayData> for GenericListArray<OffsetSize>
impl<OffsetSize: OffsetSizeTrait> From<ArrayData> for GenericListArray<OffsetSize>
sourceimpl<T: BinaryOffsetSizeTrait> From<GenericListArray<T>> for GenericBinaryArray<T>
impl<T: BinaryOffsetSizeTrait> From<GenericListArray<T>> for GenericBinaryArray<T>
sourcefn from(v: GenericListArray<T>) -> Self
fn from(v: GenericListArray<T>) -> Self
Converts to this type from the input type.
sourceimpl<T: StringOffsetSizeTrait> From<GenericListArray<T>> for GenericStringArray<T>
impl<T: StringOffsetSizeTrait> From<GenericListArray<T>> for GenericStringArray<T>
sourcefn from(v: GenericListArray<T>) -> Self
fn from(v: GenericListArray<T>) -> Self
Converts to this type from the input type.
sourceimpl<OffsetSize: OffsetSizeTrait> JsonEqual for GenericListArray<OffsetSize>
impl<OffsetSize: OffsetSizeTrait> JsonEqual for GenericListArray<OffsetSize>
sourceimpl<OffsetSize: OffsetSizeTrait> PartialEq<GenericListArray<OffsetSize>> for GenericListArray<OffsetSize>
impl<OffsetSize: OffsetSizeTrait> PartialEq<GenericListArray<OffsetSize>> for GenericListArray<OffsetSize>
sourceimpl<OffsetSize: OffsetSizeTrait> PartialEq<GenericListArray<OffsetSize>> for Value
impl<OffsetSize: OffsetSizeTrait> PartialEq<GenericListArray<OffsetSize>> for Value
Auto Trait Implementations
impl<OffsetSize> !RefUnwindSafe for GenericListArray<OffsetSize>
impl<OffsetSize> Send for GenericListArray<OffsetSize>
impl<OffsetSize> Sync for GenericListArray<OffsetSize>
impl<OffsetSize> Unpin for GenericListArray<OffsetSize>
impl<OffsetSize> !UnwindSafe for GenericListArray<OffsetSize>
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