Struct ListViewVectorMut 

pub struct ListViewVectorMut { /* private fields */ }

A mutable 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 a Box<VectorMut>.
• offsets: A PrimitiveVectorMut containing the starting offset of each list in the elements vector.
• sizes: A PrimitiveVectorMut containing the size (number of elements) of each list.
• validity: A MaskMut indicating which lists are null.

Implementations

impl ListViewVectorMut

pub fn new( elements: Box<VectorMut>, offsets: PrimitiveVectorMut, sizes: PrimitiveVectorMut, validity: MaskMut, ) -> Self

Creates a new ListViewVectorMut 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: Box<VectorMut>, offsets: PrimitiveVectorMut, sizes: PrimitiveVectorMut, validity: MaskMut, ) -> VortexResult<Self>

Attempts to create a new ListViewVectorMut 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: Box<VectorMut>, offsets: PrimitiveVectorMut, sizes: PrimitiveVectorMut, validity: MaskMut, ) -> Self

Creates a new ListViewVectorMut 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 with_capacity(element_dtype: &DType, capacity: usize) -> Self

Creates a new ListViewVectorMut with the specified capacity.

pub fn into_parts( self, ) -> (Box<VectorMut>, PrimitiveVectorMut, PrimitiveVectorMut, MaskMut)

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

pub fn elements(&self) -> &VectorMut

Returns a reference to the elements vector.

pub fn offsets(&self) -> &PrimitiveVectorMut

Returns a reference to the offsets vector.

pub unsafe fn offsets_mut(&mut self) -> &mut PrimitiveVectorMut

Returns a mutable handle to the offsets vector.

Safety

Caller must ensure that any offsets must be valid offsets within the elements.

Caller must also ensure that offsets and sizes continue to be of same length.

pub fn sizes(&self) -> &PrimitiveVectorMut

Returns a reference to the sizes vector.

pub unsafe fn sizes_mut(&mut self) -> &mut PrimitiveVectorMut

Returns a mutable handle to the sizes vector.

Safety

Caller must ensure that any sizes, coupled with the corresponding offset, address valid ranges of elements.

Caller must also ensure that offsets and sizes continue to be of same length.

pub unsafe fn validity_mut(&mut self) -> &mut MaskMut

Returns a mutable handle to the validity mask of the vector.

Safety

Callers must ensure modifying the length of the validity mask is only done with corresponding updates to length of the offsets and sizes.

Trait Implementations

impl Clone for ListViewVectorMut

fn clone(&self) -> ListViewVectorMut

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListViewVectorMut

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

Formats the value using the given formatter.

impl From<ListViewVectorMut> for VectorMut

fn from(v: ListViewVectorMut) -> Self

Converts to this type from the input type.

impl VectorMutOps for ListViewVectorMut

fn extend_from_vector(&mut self, other: &ListViewVector)

This will also panic if we try to extend the ListViewVector beyond the maximum offset representable by the type of the offsets primitive vector.

type Immutable = ListViewVector

The immutable equivalent of this mutable vector.

fn len(&self) -> usize

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

fn validity(&self) -> &MaskMut

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

fn capacity(&self) -> usize

Returns the total number of elements the vector can hold without reallocating.

fn reserve(&mut self, additional: usize)

Reserves capacity for at least additional more elements to be inserted in the given vector.

fn clear(&mut self)

Clears the buffer, removing all data. Existing capacity is preserved.

fn truncate(&mut self, len: usize)

Shortens the buffer, keeping the first len bytes and dropping the rest.

fn append_nulls(&mut self, n: usize)

Appends n null elements to the vector.

fn freeze(self) -> ListViewVector

Converts self into an immutable vector.

fn split_off(&mut self, _at: usize) -> Self

Splits the vector into two at the given index.

fn unsplit(&mut self, other: Self)

Absorbs a mutable vector that was previously split off.

fn is_empty(&self) -> bool

Returns true if the vector contains no elements.