Struct ListViewVector 

pub struct ListViewVector { /* private fields */ }

A vector of variable-width lists.

Each list is defined by 2 integers: an offset and a size (a “list view”), which point into a child elements vector.

Note that the list views do not need to be sorted, nor do they have to be contiguous or fully cover the elements vector. This means that multiple views can be pointing to the same elements.

Structure

• elements: The child vector of all list elements, stored as an Arc<Vector>.
• offsets: A PrimitiveVector containing the starting offset of each list in the elements vector.
• sizes: A PrimitiveVector containing the size (number of elements) of each list.
• validity: A Mask indicating which lists are null.

Implementations

impl ListViewVector

pub fn new( elements: Arc<Vector>, offsets: PrimitiveVector, sizes: PrimitiveVector, validity: Mask, ) -> Self

Creates a new ListViewVector from its components.

Panics

Panics if:

• offsets or sizes contain nulls values.
• offsets, sizes, and validity do not all have the same length
• The sizes integer width is not less than or equal to the offsets integer width (this would cause overflow)
• For any i, offsets[i] + sizes[i] causes an overflow or is greater than elements.len() (even if the corresponding view is defined as null by the validity array).

pub fn try_new( elements: Arc<Vector>, offsets: PrimitiveVector, sizes: PrimitiveVector, validity: Mask, ) -> VortexResult<Self>

Attempts to create a new ListViewVector from its components.

Errors

Returns an error if:

• offsets or sizes contain nulls values.
• offsets, sizes, and validity do not all have the same length
• The sizes integer width is not less than or equal to the offsets integer width (this would cause overflow)
• For any i, offsets[i] + sizes[i] causes an overflow or is greater than elements.len() (even if the corresponding view is defined as null by the validity array).

pub unsafe fn new_unchecked( elements: Arc<Vector>, offsets: PrimitiveVector, sizes: PrimitiveVector, validity: Mask, ) -> Self

Creates a new ListViewVector without validation.

Safety

The caller must ensure all of the following invariants are satisfied:

• offsets and sizes must be non-nullable integer vectors.
• offsets, sizes, and validity must have the same length.
• Size integer width must be smaller than or equal to offset type (to prevent overflow).
• For each i, offsets[i] + sizes[i] must not overflow and must be <= elements.len() (even if the corresponding view is defined as null by the validity array).

pub fn into_parts(self) -> (Arc<Vector>, PrimitiveVector, PrimitiveVector, Mask)

Decomposes the ListViewVector into its constituent parts (child elements, offsets, sizes, and validity).

pub fn elements(&self) -> &Arc<Vector>

Returns a reference to the elements vector.

pub fn offsets(&self) -> &PrimitiveVector

Returns a reference to the integer offsets vector.

pub fn sizes(&self) -> &PrimitiveVector

Returns a reference to the integer sizes vector.

Trait Implementations

impl Clone for ListViewVector

fn clone(&self) -> ListViewVector

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListViewVector

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

Formats the value using the given formatter.

impl From<ListViewVector> for Vector

fn from(v: ListViewVector) -> Self

Converts to this type from the input type.

impl VectorOps for ListViewVector

type Mutable = ListViewVectorMut

The mutable equivalent of this immutable vector.

fn len(&self) -> usize

Returns the number of elements in the vector, also referred to as its “length”.

fn validity(&self) -> &Mask

Returns the validity mask of the vector, where true represents a valid element and false represents a null element.

fn scalar_at(&self, index: usize) -> Scalar

Return the scalar at the given index.

fn slice(&self, _range: impl RangeBounds<usize> + Clone + Debug) -> Self

Slice the vector from start to end (exclusive).

fn try_into_mut(self) -> Result<ListViewVectorMut, Self>

Tries to convert self into a mutable vector (implementing VectorMutOps).

fn into_mut(self) -> ListViewVectorMut

Converts self into a mutable vector (implementing VectorMutOps).

fn is_empty(&self) -> bool

Returns true if the vector contains no elements.

fn null_count(&self) -> usize

Returns the null count of the vector.