Skip to main content

ListArray

Struct ListArray 

Source
pub struct ListArray { /* private fields */ }
Expand description

A column of variable-length lists over a shared child array.

Implementations§

Source§

impl ListArray

Source

pub fn try_new( field: Field, offsets: ScalarBuffer<i32>, values: ArrayRef, validity: Option<Bitmap>, ) -> Result<Self>

Builds a list array from its child, offsets and validity.

§Errors
Source

pub fn try_from_lengths( field: Field, lengths: impl IntoIterator<Item = usize>, values: ArrayRef, ) -> Result<Self>

Builds a list array from a child and per-list lengths.

The lengths must sum to the child’s length.

§Errors
use astrs_data::array::{Array, Int32Array, IntoArrayRef, ListArray};
use astrs_data::{DataType, Field};

let child = Int32Array::from_values([1, 2, 3]).into_array_ref();
let lists = ListArray::try_from_lengths(
    Field::new("item", DataType::Int32, false),
    [2, 1],
    child,
)?;
assert_eq!(lists.len(), 2);
Source

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

An all-null list array of len slots over an empty child.

The child type comes from field; a field whose type cannot be instantiated empty falls back to a Null child, which keeps the constructor infallible.

Source

pub fn field(&self) -> Option<&Field>

The child field describing one element.

Source

pub const fn values(&self) -> &ArrayRef

The flat child array every list points into.

Source

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

The offset buffer, len + 1 entries.

Source

pub const fn offsets_buffer(&self) -> &ScalarBuffer<i32>

The offset buffer as a shareable typed window.

See crate::array::GenericBinaryArray::offsets_buffer: the IPC encoder clones this window rather than copying the offsets out of a slice.

use astrs_data::array::{Int32Array, IntoArrayRef, ListArray};
use astrs_data::{DataType, Field};

let child = Int32Array::from_values([1, 2, 3]).into_array_ref();
let lists =
    ListArray::try_from_lengths(Field::new("item", DataType::Int32, false), [2, 1], child)?;
assert_eq!(lists.offsets_buffer().as_slice(), &[0, 2, 3]);
Source

pub fn value(&self, index: usize) -> Option<ArrayRef>

The list at index as a zero-copy slice of the child, ignoring validity.

Returns None only when index is out of range.

Source

pub fn get(&self, index: usize) -> Option<ArrayRef>

The logical list at index: None when the slot is null or out of range.

A null list and an empty list are different: the first returns None, the second a zero-length array.

Source

pub fn value_length(&self, index: usize) -> Option<usize>

Number of child values in list index, ignoring validity.

Source

pub fn iter(&self) -> ArrayIter<&Self> ⓘ

Iterates over the logical lists, None for nulls.

Source

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

A zero-copy sub-range, clamped to the array (the crate-wide slicing convention).

Only the offset buffer and validity are narrowed; the child array is shared unchanged, exactly as for crate::array::GenericBinaryArray.

Source

pub fn try_slice(&self, offset: usize, len: usize) -> Result<Self>

Checked ListArray::slice.

§Errors

DataError::SliceOutOfBounds when the window leaves the array.

Source

pub fn with_validity(&self, validity: Option<Bitmap>) -> Result<Self>

Returns a copy with a different validity bitmap.

§Errors

DataError::ValidityLengthMismatch when the bitmap length is wrong.

Trait Implementations§

Source§

impl Array for ListArray

Source§

fn as_any(&self) -> &dyn Any

Erased self, for ArrayExt::downcast.
Source§

fn data_type(&self) -> &DataType

The array’s layout.
Source§

fn len(&self) -> usize

Number of logical slots.
Source§

fn validity(&self) -> Option<&Bitmap>

The validity bitmap, or None when every slot is valid. Read more
Source§

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

A zero-copy sub-range. Read more
Source§

fn buffer_memory_size(&self) -> usize

Bytes of buffer memory this array pins, including shared allocations it only partly covers. Read more
Source§

fn children(&self) -> Vec<&ArrayRef> ⓘ

The child arrays this array owns, in field order. Empty for leaf types.
Source§

fn equals(&self, other: &dyn Array) -> bool

Structural equality against another array, used by the PartialEq implementation on dyn Array. Read more
Source§

fn is_empty(&self) -> bool

Returns true when the array has no slots.
Source§

fn null_count(&self) -> usize

Number of null slots.
Source§

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

Returns true when slot index is null. Out-of-range indices are reported as null.
Source§

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

Returns true when slot index holds a value.
Source§

impl ArrayAccessor for &ListArray

Source§

type Item = Arc<dyn Array>

The logical value type, e.g. i32, &'a str or &'a [u8].
Source§

fn accessor_len(&self) -> usize

Number of logical slots.
Source§

fn accessor_get(&self, index: usize) -> Option<ArrayRef>

The value at index, or None when the slot is null or out of range.
Source§

impl Clone for ListArray

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ListArray

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> IntoIterator for &'a ListArray

Source§

type Item = Option<Arc<dyn Array>>

The type of the elements being iterated over.
Source§

type IntoIter = ArrayIter<&'a ListArray>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl PartialEq for ListArray

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<A> IntoArrayRef for A
where A: Array,

Source§

fn into_array_ref(self) -> ArrayRef

Moves self into a shared, dynamically typed column.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.