Struct arrow::array::GenericListArray

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

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

impl<OffsetSize> GenericListArray<OffsetSize>where
    OffsetSize: OffsetSizeTrait,

pub const DATA_TYPE_CONSTRUCTOR: fn(_: Box<Field, Global>) -> 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 values(&self) -> &Arc<dyn Array + 'static>

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) -> Arc<dyn Array + 'static>

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) -> Arc<dyn Array + 'static>

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) -> ArrayIter<&'a GenericListArray<OffsetSize>>

constructs a new iterator

pub fn from_iter_primitive<T, P, I>(iter: I) -> GenericListArray<OffsetSize>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);

Trait Implementations

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

fn as_any(&self) -> &(dyn Any + 'static)

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

fn data(&self) -> &ArrayData

Returns a reference to the underlying data of this array.

fn into_data(self) -> ArrayData

Returns the underlying data of this array.

fn data_ref(&self) -> &ArrayData

Returns a reference-counted pointer to 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) -> Arc<dyn Array + 'static>

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 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.

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.

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

type Item = Arc<dyn Array + 'static>

The Arrow type of the element being accessed.

fn value(
    &self,
    index: usize
) -> <&'a GenericListArray<OffsetSize> as ArrayAccessor>::Item

Returns the element at index i

unsafe fn value_unchecked(
    &self,
    index: usize
) -> <&'a GenericListArray<OffsetSize> as ArrayAccessor>::Item

Returns the element at index i

impl<OffsetSize> Clone for GenericListArray<OffsetSize>

fn clone(&self) -> GenericListArray<OffsetSize>

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

fn from(data: ArrayData) -> GenericListArray<OffsetSize>

Converts to this type from the input type.

impl<OffsetSize> From<GenericListArray<OffsetSize>> for ArrayDatawhere
    OffsetSize: 'static + OffsetSizeTrait,

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

Converts to this type from the input type.

impl<OffsetSize> From<GenericListArray<OffsetSize>> for GenericByteArray<GenericStringType<OffsetSize>>where
    OffsetSize: OffsetSizeTrait,

fn from(
    v: GenericListArray<OffsetSize>
) -> GenericByteArray<GenericStringType<OffsetSize>>

Converts to this type from the input type.

impl<T> From<GenericListArray<T>> for GenericByteArray<GenericBinaryType<T>>where
    T: OffsetSizeTrait,

fn from(v: GenericListArray<T>) -> GenericByteArray<GenericBinaryType<T>>

Converts to this type from the input type.

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

fn eq(&self, other: &GenericListArray<OffsetSize>) -> 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.