Struct arrow::array::StructArray [−][src]
pub struct StructArray { /* fields omitted */ }
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::datatypes::{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
Return the number of fields in this struct array
Returns child array refs of the struct array
Return field names in this struct array
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
Returns a reference-counted pointer to the underlying data of this array.
Returns a zero-copy slice of this array with the indicated offset and length. Read more
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 more
Returns whether the element at index
is null.
When using this function on a slice, the index is relative to the slice. Read more
Returns whether the element at index
is not null.
When using this function on a slice, the index is relative to the slice. Read more
Returns the total number of null values in this array. Read more
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
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 more
returns two pointers that represent this array in the C Data Interface (FFI)
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
Performs the conversion.