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.
Implementations
impl StructArray
[src]
impl StructArray
[src]pub fn num_columns(&self) -> usize
[src]
pub fn num_columns(&self) -> usize
[src]Return the number of fields in this struct array
pub fn columns_ref(&self) -> Vec<ArrayRef>
[src]
pub fn columns_ref(&self) -> Vec<ArrayRef>
[src]Returns child array refs of the struct array
pub fn column_names(&self) -> Vec<&str>
[src]
pub fn column_names(&self) -> Vec<&str>
[src]Return field names in this struct array
pub fn column_by_name(&self, column_name: &str) -> Option<&ArrayRef>
[src]
pub fn column_by_name(&self, column_name: &str) -> Option<&ArrayRef>
[src]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
[src]
impl Array for StructArray
[src]fn get_buffer_memory_size(&self) -> usize
[src]
fn get_buffer_memory_size(&self) -> usize
[src]Returns the total number of bytes of memory occupied by the buffers owned by this StructArray.
fn get_array_memory_size(&self) -> usize
[src]
fn get_array_memory_size(&self) -> usize
[src]Returns the total number of bytes of memory occupied physically by this StructArray.
fn data_ref(&self) -> &ArrayData
[src]
fn data_ref(&self) -> &ArrayData
[src]Returns a reference-counted pointer to the underlying data of this array.
fn slice(&self, offset: usize, length: usize) -> ArrayRef
[src]
fn slice(&self, offset: usize, length: usize) -> ArrayRef
[src]Returns a zero-copy slice of this array with the indicated offset and length. Read more
fn offset(&self) -> usize
[src]
fn offset(&self) -> usize
[src]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
fn is_null(&self, index: usize) -> bool
[src]
fn is_null(&self, index: usize) -> bool
[src]Returns whether the element at index
is null.
When using this function on a slice, the index is relative to the slice. Read more
fn is_valid(&self, index: usize) -> bool
[src]
fn is_valid(&self, index: usize) -> bool
[src]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
fn null_count(&self) -> usize
[src]
fn null_count(&self) -> usize
[src]Returns the total number of null values in this array. Read more
fn to_raw(&self) -> Result<(*const FFI_ArrowArray, *const FFI_ArrowSchema)>
[src]
fn to_raw(&self) -> Result<(*const FFI_ArrowArray, *const FFI_ArrowSchema)>
[src]returns two pointers that represent this array in the C Data Interface (FFI)
impl Debug for StructArray
[src]
impl Debug for StructArray
[src]impl From<&'_ StructArray> for RecordBatch
[src]
impl From<&'_ StructArray> for RecordBatch
[src]fn from(struct_array: &StructArray) -> Self
[src]
fn from(struct_array: &StructArray) -> Self
[src]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<ArrayData> for StructArray
[src]
impl From<ArrayData> for StructArray
[src]impl From<RecordBatch> for StructArray
[src]
impl From<RecordBatch> for StructArray
[src]fn from(batch: RecordBatch) -> Self
[src]
fn from(batch: RecordBatch) -> Self
[src]Performs the conversion.
impl JsonEqual for StructArray
[src]
impl JsonEqual for StructArray
[src]impl PartialEq<StructArray> for StructArray
[src]
impl PartialEq<StructArray> for StructArray
[src]impl PartialEq<Value> for StructArray
[src]
impl PartialEq<Value> for StructArray
[src]Auto Trait Implementations
impl !RefUnwindSafe for StructArray
impl Send for StructArray
impl Sync for StructArray
impl Unpin for StructArray
impl !UnwindSafe for StructArray
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,