Struct ListArray

pub struct ListArray {
    pub(super) bitmap: Bitmap,
    pub(super) offsets: Box<[u32]>,
    pub(super) value: Box<ArrayImpl>,
}

Each item of this ListArray is a List<T>, or called T[] (T array).

• As other arrays, there is a null bitmap, with 1 meaning nonnull and 0 meaning null.
• As super::BytesArray, there is an offsets Vec and a value Array. The value Array has all items concatenated, and the offsets Vec stores start and end indices into it for slicing. Effectively, the inner array is the flattened form, and offsets.len() == n + 1.

For example, values (array[1]), (array[]::int[]), (null), (array[2, 3]); stores an inner I32Array with [1, 2, 3], along with offsets [0, 1, 1, 1, 3] and null bitmap TTFT.

Fields

bitmap: Bitmap

offsets: Box<[u32]>

value: Box<ArrayImpl>

Implementations

impl ListArray

pub fn flatten(&self) -> ArrayImpl

Flatten the list array into a single array.

Example

[[1,2,3],NULL,[4,5]] => [1,2,3,4,5]
[[[1],[2]],[[3],[4]]] => [1,2,3,4]

pub fn values(&self) -> &ArrayImpl

Return the inner array of the list array.

pub fn from_protobuf(array: &PbArray) -> ArrayResult<ArrayImpl>

pub async fn map_inner<E, Fut, F>(self, f: F) -> Result<ListArray, E>

where F: FnOnce(ArrayImpl) -> Fut, Fut: Future<Output = Result<ArrayImpl, E>>,

Apply the function on the underlying elements. e.g. map_inner([[1,2,3],NULL,[4,5]], DOUBLE) = [[2,4,6],NULL,[8,10]]

pub fn offsets(&self) -> &[u32]

Returns the offsets of this list.

Example

list    = [[a, b, c], [], NULL, [d], [NULL, f]]
offsets = [0, 3, 3, 3, 4, 6]

Trait Implementations

impl Array for ListArray

type Builder = ListArrayBuilder

Corresponding builder of this array, which is reciprocal to Array.

type OwnedItem = ListValue

Owned type of item in array, which is reciprocal to Self::RefItem.

type RefItem<'a> = ListRef<'a>

A reference to item in array, as well as return type of value_at, which is reciprocal to Self::OwnedItem.

unsafe fn raw_value_at_unchecked(&self, idx: usize) -> Self::RefItem<'_>

Retrieve a reference to value regardless of whether it is null without checking the index boundary.

fn len(&self) -> usize

Number of items of array.

fn to_protobuf(&self) -> PbArray

Serialize to protobuf

fn null_bitmap(&self) -> &Bitmap

Get the null Bitmap from Array.

fn into_null_bitmap(self) -> Bitmap

Get the owned null Bitmap from Array.

fn set_bitmap(&mut self, bitmap: Bitmap)

fn data_type(&self) -> DataType

fn value_at(&self, idx: usize) -> Option<Self::RefItem<'_>>

Retrieve a reference to value.

unsafe fn value_at_unchecked(&self, idx: usize) -> Option<Self::RefItem<'_>>

Safety

fn iter(&self) -> ArrayIterator<'_, Self>

Get iterator of current array.

fn raw_iter(&self) -> impl ExactSizeIterator<Item = Self::RefItem<'_>>

Get raw iterator of current array.

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

Check if an element is null or not.

unsafe fn is_null_unchecked(&self, idx: usize) -> bool

Safety

fn hash_at<H: Hasher>(&self, idx: usize, state: &mut H)

Feed the value at idx into the given Hasher.

fn hash_vec<H: Hasher>(&self, hashers: &mut [H], vis: &Bitmap)

fn is_empty(&self) -> bool

fn create_builder(&self, capacity: usize) -> Self::Builder

fn into_ref(self) -> ArrayRef

Converts the array into an ArrayRef.

impl Clone for ListArray

fn clone(&self) -> ListArray

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListArray

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

Formats the value using the given formatter.

impl EstimateSize for ListArray

fn estimated_heap_size(&self) -> usize

The estimated heap size of the current struct in bytes.

fn estimated_size(&self) -> usize

where Self: Sized,

The estimated total size of the current struct in bytes, including the estimated_heap_size and the size of Self.

impl<'a> From<&'a ArrayImpl> for &'a ListArray

fn from(array: &'a ArrayImpl) -> Self

Converts to this type from the input type.

impl From<ArrayImpl> for ListArray

fn from(array: ArrayImpl) -> Self

Converts to this type from the input type.

impl From<ListArray> for ArrayImpl

fn from(arr: ListArray) -> Self

Converts to this type from the input type.

impl FromIterator<ListValue> for ListArray

fn from_iter<I: IntoIterator<Item = ListValue>>(iter: I) -> Self

Creates a value from an iterator.

impl<T, L> FromIterator<Option<L>> for ListArray

where T: PrimitiveArrayItemType, L: IntoIterator<Item = T>,

fn from_iter<I: IntoIterator<Item = Option<L>>>(iter: I) -> Self

Creates a value from an iterator.

impl PartialEq for ListArray

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

impl Eq for ListArray

impl StructuralPartialEq for ListArray