Struct GenericListArray

pub struct GenericListArray<OffsetSize: OffsetSizeTrait> {
    data_type: DataType,
    nulls: Option<NullBuffer>,
    values: ArrayRef,
    value_offsets: OffsetBuffer<OffsetSize>,
}

An array of variable length lists, similar to JSON arrays (e.g. ["A", "B", "C"]).

Lists are represented using offsets into a values child array. Offsets are stored in two adjacent entries of an [OffsetBuffer].

Arrow defines ListArray with i32 offsets and LargeListArray with i64 offsets.

Use GenericListBuilder to construct a GenericListArray.

Representation

A ListArray can represent a list of values of any other supported Arrow type. Each element of the ListArray itself is a list which may be empty, may contain NULL and non-null values, or may itself be NULL.

For example, the ListArray shown in the following diagram stores lists of strings. Note that [] represents an empty (length 0), but non NULL list.

┌─────────────┐
│   [A,B,C]   │
├─────────────┤
│     []      │
├─────────────┤
│    NULL     │
├─────────────┤
│     [D]     │
├─────────────┤
│  [NULL, F]  │
└─────────────┘

The values are stored in a child StringArray and the offsets are stored in an [OffsetBuffer] as shown in the following diagram. The logical values and offsets are shown on the left, and the actual ListArray encoding on the right.

                                        ┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─
                                                                ┌ ─ ─ ─ ─ ─ ─ ┐    │
 ┌─────────────┐  ┌───────┐             │     ┌───┐   ┌───┐       ┌───┐ ┌───┐
 │   [A,B,C]   │  │ (0,3) │                   │ 1 │   │ 0 │     │ │ 1 │ │ A │ │ 0  │
 ├─────────────┤  ├───────┤             │     ├───┤   ├───┤       ├───┤ ├───┤
 │      []     │  │ (3,3) │                   │ 1 │   │ 3 │     │ │ 1 │ │ B │ │ 1  │
 ├─────────────┤  ├───────┤             │     ├───┤   ├───┤       ├───┤ ├───┤
 │    NULL     │  │ (3,4) │                   │ 0 │   │ 3 │     │ │ 1 │ │ C │ │ 2  │
 ├─────────────┤  ├───────┤             │     ├───┤   ├───┤       ├───┤ ├───┤
 │     [D]     │  │ (4,5) │                   │ 1 │   │ 4 │     │ │ ? │ │ ? │ │ 3  │
 ├─────────────┤  ├───────┤             │     ├───┤   ├───┤       ├───┤ ├───┤
 │  [NULL, F]  │  │ (5,7) │                   │ 1 │   │ 5 │     │ │ 1 │ │ D │ │ 4  │
 └─────────────┘  └───────┘             │     └───┘   ├───┤       ├───┤ ├───┤
                                                      │ 7 │     │ │ 0 │ │ ? │ │ 5  │
                                        │  Validity   └───┘       ├───┤ ├───┤
    Logical       Logical                  (nulls)   Offsets    │ │ 1 │ │ F │ │ 6  │
     Values       Offsets               │                         └───┘ └───┘
                                                                │    Values   │    │
                (offsets[i],            │   ListArray               (Array)
               offsets[i+1])                                    └ ─ ─ ─ ─ ─ ─ ┘    │
                                        └ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─

Fields

data_type: DataType

nulls: Option<NullBuffer>

values: ArrayRef

value_offsets: OffsetBuffer<OffsetSize>

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.is_nullable()
• 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

fn get_type(data_type: &DataType) -> Option<&DataType>

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) -> Self

where 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);

impl<OffsetSize: OffsetSizeTrait> GenericListArray<OffsetSize>

fn try_new_from_array_data(data: ArrayData) -> Result<Self, ArrowError>

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 buffer 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. Note that this does not always correspond to the exact memory usage of an array, since multiple arrays can share the same buffers or slices thereof.

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 logical_nulls(&self) -> Option<NullBuffer>

Returns a potentially computed [NullBuffer] that represents the logical null values of this array, if any.

fn is_null(&self, index: usize) -> bool

Returns whether the element at index is null according to Array::nulls

fn is_valid(&self, index: usize) -> bool

Returns whether the element at index is not null, the opposite of Self::is_null.

fn null_count(&self) -> usize

Returns the total number of physical null values in this array.

fn logical_null_count(&self) -> usize

Returns the total number of logical null values in this array.

fn is_nullable(&self) -> bool

Returns false if the array is guaranteed to not contain any logical nulls

impl<OffsetSize: OffsetSizeTrait> ArrayAccessor for &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 for GenericListArray<OffsetSize>

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

Tests for self and other values to be equal, and is used by ==.

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

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