Struct arrow::array::StructArray

pub struct StructArray { /* fields omitted */ }

A nested array type where each child (called field) is represented by a separate array.

Implementations

impl StructArray

pub fn column(&self, pos: usize) -> &ArrayRef

Returns the field at pos.

pub fn num_columns(&self) -> usize

Return the number of fields in this struct array

pub fn columns(&self) -> Vec<&ArrayRef>

Returns the fields of the struct array

pub fn columns_ref(&self) -> Vec<ArrayRef>

Returns child array refs of the struct array

pub fn column_names(&self) -> Vec<&str>

Return field names in this struct array

pub fn column_by_name(&self, column_name: &str) -> Option<&ArrayRef>

Return child array whose field name equals to column_name

Note: A schema can currently have duplicate field names, in which case the first field will always be selected. This issue will be addressed in ARROW-11178

Trait Implementations

impl Array for StructArray

fn len(&self) -> usize

Returns the length (i.e., number of elements) of this array

fn get_buffer_memory_size(&self) -> usize

Returns the total number of bytes of memory occupied by the buffers owned by this StructArray.

fn get_array_memory_size(&self) -> usize

Returns the total number of bytes of memory occupied physically by this StructArray.

fn as_any(&self) -> &dyn Any

Returns the array as Any so that it can be downcasted to a specific implementation.

fn data(&self) -> &ArrayData

Returns a reference to the underlying data of this array.

fn data_ref(&self) -> &ArrayData

Returns a reference-counted pointer to the underlying data of this array.

fn data_type(&self) -> &DataType

Returns a reference to the DataType of this array.

fn slice(&self, offset: usize, length: usize) -> ArrayRef

Returns a zero-copy slice of this array with the indicated offset and length.

fn is_empty(&self) -> bool

Returns whether this array is empty.

fn offset(&self) -> usize

Returns the offset into the underlying data used by this array(-slice). Note that the underlying data can be shared by many arrays. This defaults to 0.

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

Returns whether the element at index is null. When using this function on a slice, the index is relative to the slice.

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

Returns whether the element at index is not null. When using this function on a slice, the index is relative to the slice.

fn null_count(&self) -> usize

Returns the total number of null values in this array.

fn to_raw(&self) -> Result<(*const FFI_ArrowArray, *const FFI_ArrowSchema)>

returns two pointers that represent this array in the C Data Interface (FFI)

impl Debug for StructArray

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

Formats the value using the given formatter.

impl From<&'_ StructArray> for RecordBatch

fn from(struct_array: &StructArray) -> Self

Create a record batch from struct array, where each field of the StructArray becomes a Field in the schema.

This currently does not flatten and nested struct types

impl From<(Vec<(Field, Arc<dyn Array + 'static>), Global>, Buffer)> for StructArray

fn from(pair: (Vec<(Field, ArrayRef)>, Buffer)) -> Self

Performs the conversion.

impl From<ArrayData> for StructArray

fn from(data: ArrayData) -> Self

Performs the conversion.

impl From<RecordBatch> for StructArray

fn from(batch: RecordBatch) -> Self

Performs the conversion.

impl From<Vec<(Field, Arc<dyn Array + 'static>), Global>> for StructArray

fn from(v: Vec<(Field, ArrayRef)>) -> Self

Performs the conversion.

impl JsonEqual for StructArray

fn equals_json(&self, json: &[&Value]) -> bool

Checks whether arrow array equals to json array.

fn equals_json_values(&self, json: &[Value]) -> bool

Checks whether arrow array equals to json array.

impl PartialEq<StructArray> for StructArray

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Value> for StructArray

fn eq(&self, json: &Value) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl TryFrom<Vec<(&'_ str, Arc<dyn Array + 'static>), Global>> for StructArray

fn try_from(values: Vec<(&str, ArrayRef)>) -> Result<Self>

builds a StructArray from a vector of names and arrays. This errors if the values have a different length. An entry is set to Null when all values are null.

type Error = ArrowError

The type returned in the event of a conversion error.