Struct arrow::array::GenericListArray

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

Generic struct for a primitive Array

For non generic lists, you may wish to consider using ListArray or LargeListArray`

Implementations

impl<OffsetSize: OffsetSizeTrait> GenericListArray<OffsetSize>

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

impl<OffsetSize: 'static + OffsetSizeTrait> Array for GenericListArray<OffsetSize>

fn get_buffer_memory_size(&self) -> usize

Returns the total number of bytes of memory occupied by the buffers owned by this ListArray.

fn get_array_memory_size(&self) -> usize

Returns the total number of bytes of memory occupied physically by this ListArray.

fn as_any(&self) -> &dyn Any

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 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) -> 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 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 to_raw(&self) -> Result<(*const FFI_ArrowArray, *const FFI_ArrowSchema)>

returns two pointers that represent this array in the C Data Interface (FFI)

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

Performs the conversion.

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

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

Performs the conversion.

impl<T: StringOffsetSizeTrait> From<GenericListArray<T>> for GenericStringArray<T>

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

Performs the conversion.

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

fn equals_json(&self, json: &[&Value]) -> bool

Checks whether arrow array equals to json array.

fn equals_json_values(&self, json: &[Value]) -> bool

Checks whether arrow array equals to json array.

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

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

fn eq(&self, arrow: &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 !=.

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

fn eq(&self, json: &Value) -> 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 !=.