Struct StructArray

pub struct StructArray { /* private fields */ }

Implementations

impl StructArray

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

pub fn field_by_name(&self, name: impl AsRef<str>) -> VortexResult<&ArrayRef>

pub fn field_by_name_opt(&self, name: impl AsRef<str>) -> Option<&ArrayRef>

pub fn names(&self) -> &FieldNames

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>

Methods from Deref<Target = dyn Array>

pub fn is_constant(&self) -> bool

pub fn is_constant_opts(&self, cost: Cost) -> bool

pub fn as_constant(&self) -> Option<Scalar>

pub fn as_<V: VTable>(&self) -> &V::Array

Returns the array downcast to the given A.

pub fn as_opt<V: VTable>(&self) -> Option<&V::Array>

Returns the array downcast to the given A.

pub fn is<V: VTable>(&self) -> bool

Is self an array with encoding from vtable V.

pub fn nbytes(&self) -> usize

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

pub fn to_array_iterator(&self) -> impl ArrayIterator + 'static

Create an ArrayIterator over the array.

pub fn serialize( &self, ctx: &ArrayContext, options: &SerializeOptions, ) -> VortexResult<Vec<ByteBuffer>>

Serialize the array into a sequence of byte buffers that should be written contiguously. This function returns a vec to avoid copying data buffers.

Optionally, padding can be included to guarantee buffer alignment and ensure zero-copy reads within the context of an external file or stream. In this case, the alignment of the first byte buffer should be respected when writing the buffers to the stream or file.

The format of this blob is a sequence of data buffers, possible with prefixed padding, followed by a flatbuffer containing an fba::Array message, and ending with a little-endian u32 describing the length of the flatbuffer message.

pub fn to_array_stream(&self) -> impl ArrayStream + 'static

Create an ArrayStream over the array.

pub fn tree_display(&self) -> impl Display

pub fn as_null_typed(&self) -> NullTyped<'_>

Downcasts the array for null-specific behavior.

pub fn as_bool_typed(&self) -> BoolTyped<'_>

Downcasts the array for bool-specific behavior.

pub fn as_primitive_typed(&self) -> PrimitiveTyped<'_>

Downcasts the array for primitive-specific behavior.

pub fn as_decimal_typed(&self) -> DecimalTyped<'_>

Downcasts the array for decimal-specific behavior.

pub fn as_utf8_typed(&self) -> Utf8Typed<'_>

Downcasts the array for utf8-specific behavior.

pub fn as_binary_typed(&self) -> BinaryTyped<'_>

Downcasts the array for binary-specific behavior.

pub fn as_struct_typed(&self) -> StructTyped<'_>

Downcasts the array for struct-specific behavior.

pub fn as_list_typed(&self) -> ListTyped<'_>

Downcasts the array for list-specific behavior.

pub fn as_extension_typed(&self) -> ExtensionTyped<'_>

Downcasts the array for extension-specific behavior.

Trait Implementations

impl AsRef<dyn Array> for StructArray

fn as_ref(&self) -> &dyn 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 Deref for StructArray

type Target = dyn Array

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl IntoArray for StructArray

fn into_array(self) -> ArrayRef

impl ValidityHelper for StructArray

fn validity(&self) -> &Validity