Struct StructVectorMut 

pub struct StructVectorMut { /* private fields */ }

A mutable vector of struct values (values with named fields).

Struct values are stored column-wise in the vector, so values in the same field are stored next to each other (rather than values in the same struct stored next to each other).

Implementations

impl StructVectorMut

pub fn new(fields: Box<[VectorMut]>, validity: MaskMut) -> Self

Creates a new StructVectorMut with the given fields and validity mask.

Panics

Panics if:

• Any field vector has a length that does not match the length of other fields.
• The validity mask length does not match the field length.

pub fn try_new( fields: Box<[VectorMut]>, validity: MaskMut, ) -> VortexResult<Self>

Tries to create a new StructVectorMut with the given fields and validity mask.

Errors

Returns an error if:

• Any field vector has a length that does not match the length of other fields.
• The validity mask length does not match the field length.

pub unsafe fn new_unchecked(fields: Box<[VectorMut]>, validity: MaskMut) -> Self

Creates a new StructVectorMut with the given fields and validity mask without validation.

Safety

The caller must ensure that:

• All field vectors have the same length.
• The validity mask has a length equal to the field length.

pub fn with_capacity(struct_fields: &StructFields, capacity: usize) -> Self

Creates a new StructVectorMut with the given fields and capacity.

pub fn into_parts(self) -> (Box<[VectorMut]>, MaskMut, usize)

Decomposes the struct vector into its constituent parts (fields, validity, and length).

pub fn fields(&self) -> &[VectorMut]

Returns the fields of the StructVectorMut, each stored column-wise as a VectorMut.

pub unsafe fn fields_mut(&mut self) -> &mut [VectorMut]

Returns a mutable handle to the field vectors.

Safety

Callers must ensure that any modifications to the field vectors do not violate the invariants of this type, namely that all field vectors are of the same length and equal to the length of the validity.

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

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

Safety

Callers must ensure that if the length of the mask is modified, the lengths of all of the field vectors should be updated accordingly to continue meeting the invariants of the type.

pub fn minimum_capacity(&self) -> usize

Finds the minimum capacity of all field vectors.

This is equal to the maximum amount of scalars we can add before we need to reallocate at least one of the child field vectors.

If there are no fields, this returns the length of the vector.

Note that this takes time in O(f), where f is the number of fields.

Trait Implementations

impl Clone for StructVectorMut

fn clone(&self) -> StructVectorMut

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StructVectorMut

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

Formats the value using the given formatter.

impl From<StructVectorMut> for VectorMut

fn from(v: StructVectorMut) -> Self

Converts to this type from the input type.

impl VectorMutOps for StructVectorMut

type Immutable = StructVector

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 extend_from_vector(&mut self, other: &StructVector)

Extends the vector by appending elements from another vector.

fn append_nulls(&mut self, n: usize)

Appends n null elements to the vector.

fn freeze(self) -> StructVector

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.