Struct StructVector 

pub struct StructVector { /* private fields */ }

An immutable vector of struct values.

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 StructVector

pub fn new(fields: Arc<Box<[Vector]>>, validity: Mask) -> Self

Creates a new StructVector from the given fields and validity mask.

Note that we take [Arc<Box<[_]>>] in order to enable easier conversion to StructVectorMut via try_into_mut().

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: Arc<Box<[Vector]>>, validity: Mask) -> VortexResult<Self>

Tries to create a new StructVector from the given fields and validity mask.

Note that we take [Arc<Box<[_]>>] in order to enable easier conversion to StructVectorMut via try_into_mut().

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: Arc<Box<[Vector]>>, validity: Mask) -> Self

Creates a new StructVector from the given fields and validity mask without validation.

Note that we take [Arc<Box<[_]>>] in order to enable easier conversion to StructVectorMut via try_into_mut().

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 into_parts(self) -> (Arc<Box<[Vector]>>, Mask)

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

pub fn fields(&self) -> &Arc<Box<[Vector]>>

Returns the fields of the StructVector, each stored column-wise as a Vector.

Trait Implementations

impl Clone for StructVector

fn clone(&self) -> StructVector

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StructVector

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

Formats the value using the given formatter.

impl From<StructVector> for Vector

fn from(v: StructVector) -> Self

Converts to this type from the input type.

impl VectorOps for StructVector

type Mutable = StructVectorMut

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<StructVectorMut, Self>

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

fn into_mut(self) -> StructVectorMut

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.