Struct arrow_array::array::GenericListArray

pub struct GenericListArray<OffsetSize: OffsetSizeTrait> { /* private fields */ }

An array of variable length arrays

See ListArray and LargeListArray`

See GenericListBuilder for how to construct a GenericListArray

Implementations

impl<OffsetSize: OffsetSizeTrait> GenericListArray<OffsetSize>

pub const DATA_TYPE_CONSTRUCTOR: fn(_: FieldRef) -> DataType = _

The data type constructor of list array. The input is the schema of the child array and the output is the DataType, List or LargeList.

pub fn try_new( field: FieldRef, offsets: OffsetBuffer<OffsetSize>, values: ArrayRef, nulls: Option<NullBuffer> ) -> Result<Self, ArrowError>

Create a new GenericListArray from the provided parts

Errors

Errors if

• offsets.len() - 1 != nulls.len()
• offsets.last() > values.len()
• !field.is_nullable() && values.null_count() != 0
• field.data_type() != values.data_type()

pub fn new( field: FieldRef, offsets: OffsetBuffer<OffsetSize>, values: ArrayRef, nulls: Option<NullBuffer> ) -> Self

Create a new GenericListArray from the provided parts

Panics

Panics if Self::try_new returns an error

pub fn new_null(field: FieldRef, len: usize) -> Self

Create a new GenericListArray of length len where all values are null

pub fn into_parts( self ) -> (FieldRef, OffsetBuffer<OffsetSize>, ArrayRef, Option<NullBuffer>)

Deconstruct this array into its constituent parts

pub fn offsets(&self) -> &OffsetBuffer<OffsetSize>

Returns a reference to the offsets of this list

Unlike Self::value_offsets this returns the OffsetBuffer allowing for zero-copy cloning

pub fn values(&self) -> &ArrayRef

Returns a reference to the values of this list

pub fn value_type(&self) -> DataType

Returns a clone of the value type of this list.

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

pub fn value(&self, i: usize) -> ArrayRef

Returns ith value of this list array.

pub fn value_offsets(&self) -> &[OffsetSize]

Returns the offset values in the offsets buffer

pub fn value_length(&self, i: usize) -> OffsetSize

Returns the length for value at index i.

pub fn iter<'a>(&'a self) -> GenericListArrayIter<'a, OffsetSize>

constructs a new iterator

pub fn slice(&self, offset: usize, length: usize) -> Self

Returns a zero-copy slice of this array with the indicated offset and length.

pub fn from_iter_primitive<T, P, I>(iter: I) -> Selfwhere T: ArrowPrimitiveType, P: 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

impl<OffsetSize: OffsetSizeTrait> Array for GenericListArray<OffsetSize>

fn as_any(&self) -> &dyn Any

Returns the array as Any so that it can be downcasted to a specific implementation.

fn to_data(&self) -> ArrayData

Returns the underlying data of this array

fn into_data(self) -> ArrayData

Returns the underlying data of this array

fn data_type(&self) -> &DataType

Returns a reference to the DataType of this array.

fn slice(&self, offset: usize, length: usize) -> ArrayRef

Returns a zero-copy slice of this array with the indicated offset and length.

fn len(&self) -> usize

Returns the length (i.e., number of elements) of this array.

fn is_empty(&self) -> bool

Returns whether this array is empty.

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.

fn nulls(&self) -> Option<&NullBuffer>

Returns the null buffers of this array if any

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.

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.

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.

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.

fn null_count(&self) -> usize

Returns the total number of null values in this array.

impl<'a, OffsetSize: OffsetSizeTrait> ArrayAccessor for &'a GenericListArray<OffsetSize>

type Item = Arc<dyn Array>

The Arrow type of the element being accessed.

fn value(&self, index: usize) -> Self::Item

Returns the element at index i

unsafe fn value_unchecked(&self, index: usize) -> Self::Item

Returns the element at index i

impl<OffsetSize: OffsetSizeTrait> Clone for GenericListArray<OffsetSize>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<OffsetSize: OffsetSizeTrait> Debug for GenericListArray<OffsetSize>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<OffsetSize: OffsetSizeTrait> From<ArrayData> for GenericListArray<OffsetSize>

fn from(data: ArrayData) -> Self

Converts to this type from the input type.

impl<OffsetSize: OffsetSizeTrait> From<FixedSizeListArray> for GenericListArray<OffsetSize>

fn from(value: FixedSizeListArray) -> Self

Converts to this type from the input type.

impl<OffsetSize: OffsetSizeTrait> From<GenericListArray<OffsetSize>> for ArrayData

fn from(array: GenericListArray<OffsetSize>) -> Self

Converts to this type from the input type.

impl<OffsetSize: OffsetSizeTrait> From<GenericListArray<OffsetSize>> for GenericStringArray<OffsetSize>

fn from(v: GenericListArray<OffsetSize>) -> Self

Converts to this type from the input type.

impl<T: OffsetSizeTrait> From<GenericListArray<T>> for GenericBinaryArray<T>

fn from(v: GenericListArray<T>) -> Self

Converts to this type from the input type.

impl<OffsetSize: OffsetSizeTrait> PartialEq<GenericListArray<OffsetSize>> for GenericListArray<OffsetSize>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.