Struct vortex_array::array::StructArray

pub struct StructArray(/* private fields */);

Implementations

impl StructArray

pub fn maybe_from(data: impl AsRef<ArrayData>) -> Option<Self>

Optionally downcast an ArrayData instance to a specific encoding.

Preferred in cases where a backtrace isn’t needed, like when trying multiple encoding to go down different code paths.

impl StructArray

pub fn validity(&self) -> Validity

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

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

pub fn from_fields<N: AsRef<str>>( items: &[(N, ArrayData)], ) -> 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 AsRef<ArrayData> for StructArray

fn as_ref(&self) -> &ArrayData

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

fn filter( &self, array: &StructArray, mask: FilterMask, ) -> VortexResult<ArrayData>

Filter an array by the provided predicate.

impl IntoArrayData for StructArray

fn into_array(self) -> ArrayData

impl IntoCanonical for StructArray

fn into_canonical(self) -> VortexResult<Canonical>

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

fn into_arrow(self) -> VortexResult<ArrayRef>

where Self: Sized,

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<ArrayData>

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 StatisticsVTable<StructArray> for StructEncoding

fn compute_statistics( &self, array: &StructArray, stat: Stat, ) -> VortexResult<StatsSet>

Compute the requested statistic. Can return additional stats.

impl StructArrayTrait for StructArray

fn field(&self, idx: usize) -> Option<ArrayData>

Return a field’s array by index

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

fn names(&self) -> &FieldNames

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

fn nfields(&self) -> usize

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

Return a field’s array by name

impl TakeFn<StructArray> for StructEncoding

fn take( &self, array: &StructArray, indices: &ArrayData, ) -> VortexResult<ArrayData>

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

unsafe fn take_unchecked( &self, array: &Array, indices: &ArrayData, ) -> VortexResult<ArrayData>

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

impl<'a> TryFrom<&'a ArrayData> for &'a StructArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: &'a ArrayData) -> VortexResult<Self>

Performs the conversion.

impl TryFrom<ArrayData> for StructArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: ArrayData) -> VortexResult<Self>

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.

impl ValidityVTable<StructArray> for StructEncoding

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

fn logical_validity(&self, array: &StructArray) -> LogicalValidity

impl VariantsVTable<StructArray> for StructEncoding

fn as_struct_array<'a>( &self, array: &'a StructArray, ) -> Option<&'a dyn StructArrayTrait>

fn as_null_array<'a>(&self, _array: &'a Array) -> Option<&'a dyn NullArrayTrait>

fn as_bool_array<'a>(&self, _array: &'a Array) -> Option<&'a dyn BoolArrayTrait>

fn as_primitive_array<'a>( &self, _array: &'a Array, ) -> Option<&'a dyn PrimitiveArrayTrait>

fn as_utf8_array<'a>(&self, _array: &'a Array) -> Option<&'a dyn Utf8ArrayTrait>

fn as_binary_array<'a>( &self, _array: &'a Array, ) -> Option<&'a dyn BinaryArrayTrait>

fn as_list_array<'a>(&self, _array: &'a Array) -> Option<&'a dyn ListArrayTrait>

fn as_extension_array<'a>( &self, _array: &'a Array, ) -> Option<&'a dyn ExtensionArrayTrait>

impl VisitorVTable<StructArray> for StructEncoding

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

impl ArrayTrait for StructArray