Struct StructArray

pub struct StructArray { /* private fields */ }

Implementations

impl StructArray

pub fn validity(&self) -> &Validity

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

pub fn struct_dtype(&self) -> &Arc<StructDType>

pub fn try_new( names: FieldNames, fields: Vec<ArrayRef>, length: usize, validity: Validity, ) -> VortexResult<Self>

pub fn try_new_with_dtype( fields: Vec<ArrayRef>, dtype: Arc<StructDType>, length: usize, validity: Validity, ) -> VortexResult<Self>

pub fn from_fields<N: AsRef<str>>(items: &[(N, ArrayRef)]) -> VortexResult<Self>

pub fn project(&self, projection: &[FieldName]) -> VortexResult<Self>

Return a new StructArray with the given projection applied.

Projection does not copy data arrays. Projection is defined by an ordinal array slice which specifies the new ordering of columns in the struct. The projection can be used to perform column re-ordering, deletion, or duplication at a logical level, without any data copying.

impl StructArray

pub fn into_record_batch(self) -> VortexResult<RecordBatch>

pub fn into_record_batch_with_schema( self, schema: &Schema, ) -> VortexResult<RecordBatch>

Trait Implementations

impl ArrayCanonicalImpl for StructArray

fn _to_canonical(&self) -> VortexResult<Canonical>

Returns the canonical representation of the array.

fn _append_to_builder(&self, builder: &mut dyn ArrayBuilder) -> VortexResult<()>

Writes the array into the canonical builder.

impl ArrayComputeImpl for StructArray

const FILTER: Option<KernelRef>

fn _find_kernel(&self, _compute_fn: &dyn ComputeFn) -> Option<KernelRef>

Fallback implementation to lookup compute kernels at runtime.

impl ArrayImpl for StructArray

type Encoding = StructEncoding

fn _len(&self) -> usize

fn _dtype(&self) -> &DType

fn _vtable(&self) -> VTableRef

fn _with_children(&self, children: &[ArrayRef]) -> VortexResult<Self>

Replace the children of this array with the given arrays.

impl ArrayStatisticsImpl for StructArray

fn _stats_ref(&self) -> StatsSetRef<'_>

impl ArrayValidityImpl for StructArray

fn _is_valid(&self, index: usize) -> VortexResult<bool>

Returns whether the index item is valid.

fn _all_valid(&self) -> VortexResult<bool>

Returns whether the array is all valid.

fn _all_invalid(&self) -> VortexResult<bool>

Returns whether the array is all invalid.

fn _validity_mask(&self) -> VortexResult<Mask>

Returns the canonical validity mask for the array.

fn _valid_count(&self) -> VortexResult<usize>

Returns the number of valid elements in the array.

fn _invalid_count(&self) -> VortexResult<usize>

Returns the number of invalid elements in the array.

impl ArrayVariantsImpl for StructArray

fn _as_struct_typed(&self) -> Option<&dyn StructArrayTrait>

Downcasts the array for struct-specific behavior.

fn _as_null_typed(&self) -> Option<&dyn NullArrayTrait>

Downcasts the array for null-specific behavior.

fn _as_bool_typed(&self) -> Option<&dyn BoolArrayTrait>

Downcasts the array for bool-specific behavior.

fn _as_primitive_typed(&self) -> Option<&dyn PrimitiveArrayTrait>

Downcasts the array for primitive-specific behavior.

fn _as_utf8_typed(&self) -> Option<&dyn Utf8ArrayTrait>

Downcasts the array for utf8-specific behavior.

fn _as_binary_typed(&self) -> Option<&dyn BinaryArrayTrait>

Downcasts the array for binary-specific behavior.

fn _as_list_typed(&self) -> Option<&dyn ListArrayTrait>

Downcasts the array for list-specific behavior.

fn _as_extension_typed(&self) -> Option<&dyn ExtensionArrayTrait>

Downcasts the array for extension-specific behavior.

impl ArrayVisitorImpl for StructArray

fn _visit_children(&self, visitor: &mut dyn ArrayChildVisitor)

fn _metadata(&self) -> EmptyMetadata

fn _visit_buffers(&self, _visitor: &mut dyn ArrayBufferVisitor)

fn _nbuffers(&self) -> usize

fn _nchildren(&self) -> usize

impl CastFn<&StructArray> for StructEncoding

fn cast(&self, array: &StructArray, dtype: &DType) -> VortexResult<ArrayRef>

impl Clone for StructArray

fn clone(&self) -> StructArray

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StructArray

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

Formats the value using the given formatter.

impl IsConstantFn<&StructArray> for StructEncoding

fn is_constant( &self, array: &StructArray, opts: &IsConstantOpts, ) -> VortexResult<Option<bool>>

Preconditions

impl MaskFn<&StructArray> for StructEncoding

fn mask(&self, array: &StructArray, filter_mask: Mask) -> VortexResult<ArrayRef>

Replace masked values with null in array.

impl MinMaxFn<&StructArray> for StructEncoding

fn min_max(&self, _array: &StructArray) -> VortexResult<Option<MinMaxResult>>

impl ScalarAtFn<&StructArray> for StructEncoding

fn scalar_at(&self, array: &StructArray, index: usize) -> VortexResult<Scalar>

impl SliceFn<&StructArray> for StructEncoding

fn slice( &self, array: &StructArray, start: usize, stop: usize, ) -> VortexResult<ArrayRef>

Return a zero-copy slice of an array, between start (inclusive) and end (exclusive). If start >= stop, returns an empty array of the same type as self. Assumes that start or stop are out of bounds, may panic otherwise.

impl StructArrayTrait for StructArray

fn maybe_null_field_by_idx(&self, idx: usize) -> VortexResult<ArrayRef>

Return a field’s array by index, ignoring struct nullability

fn project(&self, projection: &[FieldName]) -> VortexResult<ArrayRef>

fn names(&self) -> &FieldNames

fn dtypes(&self) -> Vec<DType>

fn nfields(&self) -> usize

fn maybe_null_field_by_name(&self, name: &str) -> VortexResult<ArrayRef>

Return a field’s array by name, ignoring struct nullability

impl TakeFn<&StructArray> for StructEncoding

fn take( &self, array: &StructArray, indices: &dyn Array, ) -> VortexResult<ArrayRef>

Create a new array by taking the values from the array at the given indices.

fn take_into( &self, array: A, indices: &dyn Array, builder: &mut dyn ArrayBuilder, ) -> VortexResult<()>

Has the same semantics as Self::take but materializes the result into the provided builder.

impl ToArrowFn<&StructArray> for StructEncoding

fn to_arrow( &self, array: &StructArray, data_type: &DataType, ) -> VortexResult<Option<ArrayRef>>

Convert the array to an Arrow array of the given type.

fn preferred_arrow_data_type(&self, _array: A) -> VortexResult<Option<DataType>>

Return the preferred Arrow DataType of the encoding, or None of the canonical DataType for the array’s Vortex vortex_dtype::DType should be used.

impl UncompressedSizeFn<&StructArray> for StructEncoding

fn uncompressed_size(&self, array: &StructArray) -> VortexResult<usize>

Compute the approximated uncompressed size of the array, in bytes.