Struct arrow::array::StructArray
source · pub struct StructArray { /* private fields */ }
Expand description
A nested array type where each child (called field) is represented by a separate array.
Example: Create an array from a vector of fields
use std::sync::Arc;
use arrow_array::{Array, ArrayRef, BooleanArray, Int32Array, StructArray};
use arrow_schema::{DataType, Field};
let boolean = Arc::new(BooleanArray::from(vec![false, false, true, true]));
let int = Arc::new(Int32Array::from(vec![42, 28, 19, 31]));
let struct_array = StructArray::from(vec![
(
Field::new("b", DataType::Boolean, false),
boolean.clone() as ArrayRef,
),
(
Field::new("c", DataType::Int32, false),
int.clone() as ArrayRef,
),
]);
assert_eq!(struct_array.column(0).as_ref(), boolean.as_ref());
assert_eq!(struct_array.column(1).as_ref(), int.as_ref());
assert_eq!(4, struct_array.len());
assert_eq!(0, struct_array.null_count());
assert_eq!(0, struct_array.offset());
Implementations§
source§impl StructArray
impl StructArray
sourcepub fn num_columns(&self) -> usize
pub fn num_columns(&self) -> usize
Return the number of fields in this struct array
sourcepub fn columns_ref(&self) -> Vec<Arc<dyn Array + 'static>, Global> ⓘ
👎Deprecated: Use columns().to_vec()
pub fn columns_ref(&self) -> Vec<Arc<dyn Array + 'static>, Global> ⓘ
Returns child array refs of the struct array
sourcepub fn column_by_name(
&self,
column_name: &str
) -> Option<&Arc<dyn Array + 'static>>
pub fn column_by_name(
&self,
column_name: &str
) -> Option<&Arc<dyn Array + 'static>>
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§
source§impl Array for StructArray
impl Array for StructArray
source§fn data_ref(&self) -> &ArrayData
fn data_ref(&self) -> &ArrayData
Returns a reference-counted pointer to the underlying data of this array.
source§fn slice(&self, offset: usize, length: usize) -> Arc<dyn Array + 'static>
fn slice(&self, offset: usize, length: usize) -> Arc<dyn Array + 'static>
Returns a zero-copy slice of this array with the indicated offset and length. Read more
source§fn offset(&self) -> usize
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
. Read moresource§fn is_null(&self, index: usize) -> bool
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. Read moresource§fn is_valid(&self, index: usize) -> bool
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. Read moresource§fn null_count(&self) -> usize
fn null_count(&self) -> usize
Returns the total number of null values in this array. Read more
source§fn get_buffer_memory_size(&self) -> usize
fn get_buffer_memory_size(&self) -> usize
Returns the total number of bytes of memory pointed to by this array.
The buffers store bytes in the Arrow memory format, and include the data as well as the validity map. Read more
source§fn get_array_memory_size(&self) -> usize
fn get_array_memory_size(&self) -> usize
Returns the total number of bytes of memory occupied physically by this array.
This value will always be greater than returned by
get_buffer_memory_size()
and
includes the overhead of the data structures that contain the pointers to the various buffers. Read moresource§impl Clone for StructArray
impl Clone for StructArray
source§fn clone(&self) -> StructArray
fn clone(&self) -> StructArray
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for StructArray
impl Debug for StructArray
source§impl From<&StructArray> for RecordBatch
impl From<&StructArray> for RecordBatch
source§fn from(struct_array: &StructArray) -> RecordBatch
fn from(struct_array: &StructArray) -> RecordBatch
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
source§impl From<ArrayData> for StructArray
impl From<ArrayData> for StructArray
source§fn from(data: ArrayData) -> StructArray
fn from(data: ArrayData) -> StructArray
Converts to this type from the input type.
source§impl From<RecordBatch> for StructArray
impl From<RecordBatch> for StructArray
source§fn from(batch: RecordBatch) -> StructArray
fn from(batch: RecordBatch) -> StructArray
Converts to this type from the input type.
source§impl From<StructArray> for ArrayData
impl From<StructArray> for ArrayData
source§fn from(array: StructArray) -> ArrayData
fn from(array: StructArray) -> ArrayData
Converts to this type from the input type.
source§impl PartialEq<StructArray> for StructArray
impl PartialEq<StructArray> for StructArray
source§fn eq(&self, other: &StructArray) -> bool
fn eq(&self, other: &StructArray) -> bool
source§impl TryFrom<Vec<(&str, Arc<dyn Array + 'static>), Global>> for StructArray
impl TryFrom<Vec<(&str, Arc<dyn Array + 'static>), Global>> for StructArray
source§fn try_from(
values: Vec<(&str, Arc<dyn Array + 'static>), Global>
) -> Result<StructArray, ArrowError>
fn try_from(
values: Vec<(&str, Arc<dyn Array + 'static>), Global>
) -> Result<StructArray, ArrowError>
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
type Error = ArrowError
The type returned in the event of a conversion error.