Struct StructArray

pub struct StructArray { /* private fields */ }

Implementations

impl StructArray

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

impl StructArray

pub fn validity(&self) -> Validity

pub fn children(&self) -> impl Iterator<Item = Array> + '_

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

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

pub fn project(&self, projection: &[Field]) -> 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.

Trait Implementations

impl AcceptArrayVisitor for StructArray

fn accept(&self, visitor: &mut dyn ArrayVisitor) -> VortexResult<()>

impl ArrayCompute for StructArray

fn filter(&self) -> Option<&dyn FilterFn>

Filtering function on arrays of predicates.

fn scalar_at(&self) -> Option<&dyn ScalarAtFn>

Single item indexing on Vortex arrays.

fn slice(&self) -> Option<&dyn SliceFn>

Perform zero-copy slicing of an array.

fn take(&self) -> Option<&dyn TakeFn>

Take a set of indices from an array. This often forces allocations and decoding of the receiver.

fn cast(&self) -> Option<&dyn CastFn>

Implemented for arrays that can be casted to different types.

fn compare( &self, _other: &Array, _operator: Operator, ) -> Option<VortexResult<Array>>

Binary operator implementation for arrays against other arrays.

fn fill_forward(&self) -> Option<&dyn FillForwardFn>

Array function that returns new arrays a non-null value is repeated across runs of nulls.

fn subtract_scalar(&self) -> Option<&dyn SubtractScalarFn>

Broadcast subtraction of scalar from Vortex array.

fn search_sorted(&self) -> Option<&dyn SearchSortedFn>

Perform a search over an ordered array.

fn and(&self) -> Option<&dyn AndFn>

Perform an Arrow-style boolean AND operation over two arrays

fn and_kleene(&self) -> Option<&dyn AndFn>

Perform a Kleene-style boolean AND operation over two arrays

fn or(&self) -> Option<&dyn OrFn>

Perform an Arrow-style boolean OR operation over two arrays

fn or_kleene(&self) -> Option<&dyn OrFn>

Perform a Kleene-style boolean OR operation over two arrays

impl ArrayStatisticsCompute for StructArray

fn compute_statistics(&self, _stat: Stat) -> VortexResult<StatsSet>

Compute the requested statistic. Can return additional stats.

impl ArrayTrait for StructArray

fn nbytes(&self) -> usize

Total size of the array in bytes, including all children and buffers.

impl ArrayValidity for StructArray

fn is_valid(&self, index: usize) -> bool

fn logical_validity(&self) -> LogicalValidity

impl ArrayVariants for StructArray

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

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

fn as_null_array_unchecked(&self) -> &dyn NullArrayTrait

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

fn as_bool_array_unchecked(&self) -> &dyn BoolArrayTrait

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

fn as_primitive_array_unchecked(&self) -> &dyn PrimitiveArrayTrait

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

fn as_utf8_array_unchecked(&self) -> &dyn Utf8ArrayTrait

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

fn as_binary_array_unchecked(&self) -> &dyn BinaryArrayTrait

fn as_struct_array_unchecked(&self) -> &dyn StructArrayTrait

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

fn as_list_array_unchecked(&self) -> &dyn ListArrayTrait

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

fn as_extension_array_unchecked(&self) -> &dyn ExtensionArrayTrait

impl AsRef<Array> for StructArray

fn as_ref(&self) -> &Array

Converts this type into a shared reference of the (usually inferred) input type.

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 FilterFn for StructArray

fn filter(&self, predicate: &Array) -> VortexResult<Array>

Filter an array by the provided predicate.

impl From<StructArray> for Array

fn from(value: StructArray) -> Array

Converts to this type from the input type.

impl From<TypedArray<Struct>> for StructArray

fn from(typed: TypedArray<Struct>) -> Self

Converts to this type from the input type.

impl GetArrayMetadata for StructArray

fn metadata(&self) -> Arc<dyn ArrayMetadata>

impl IntoArray for StructArray

fn into_array(self) -> Array

impl IntoCanonical for StructArray

fn into_canonical(self) -> VortexResult<Canonical>

StructEncoding is the canonical form for a DType::Struct array, so return self.

impl ScalarAtFn for StructArray

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

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

impl SliceFn for StructArray

fn slice(&self, start: usize, stop: usize) -> VortexResult<Array>

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 field(&self, idx: usize) -> Option<Array>

Return a field’s array by index

fn project(&self, projection: &[Field]) -> VortexResult<Array>

fn names(&self) -> &FieldNames

fn dtypes(&self) -> &[DType]

fn nfields(&self) -> usize

fn field_by_name(&self, name: &str) -> Option<Array>

Return a field’s array by name

impl TakeFn for StructArray

fn take(&self, indices: &Array) -> VortexResult<Array>

impl ToArray for StructArray

fn to_array(&self) -> Array

impl TryFrom<&Array> for StructArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(array: &Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Array> for StructArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(array: Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<StructArray> for RecordBatch

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: StructArray) -> VortexResult<Self>

Performs the conversion.