Struct arrow_data::ffi::FFI_ArrowArray

#[repr(C)]
pub struct FFI_ArrowArray { /* private fields */ }

ABI-compatible struct for ArrowArray from C Data Interface See https://arrow.apache.org/docs/format/CDataInterface.html#structure-definitions

fn export_array(array: &ArrayData) -> FFI_ArrowArray {
    FFI_ArrowArray::new(array)
}

Implementations

impl FFI_ArrowArray

pub fn new(data: &ArrayData) -> Self

creates a new FFI_ArrowArray from existing data.

Memory Leaks

This method releases buffers. Consumers of this struct must call release before releasing this struct, or contents in buffers leak.

pub fn empty() -> Self

create an empty FFI_ArrowArray, which can be used to import data into

pub fn len(&self) -> usize

the length of the array

pub fn is_empty(&self) -> bool

whether the array is empty

pub fn is_released(&self) -> bool

Whether the array has been released

pub fn offset(&self) -> usize

the offset of the array

pub fn null_count(&self) -> usize

the null count of the array

pub fn buffer(&self, index: usize) -> *const u8

Returns the buffer at the provided index

Panic

Panics if index exceeds the number of buffers or the buffer is not correctly aligned

pub fn num_buffers(&self) -> usize

Returns the number of buffers

pub fn child(&self, index: usize) -> &FFI_ArrowArray

Returns the child at the provided index

pub fn num_children(&self) -> usize

Returns the number of children

pub fn dictionary(&self) -> Option<&Self>

Returns the dictionary if any

Trait Implementations

impl Debug for FFI_ArrowArray

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

Formats the value using the given formatter.

impl Drop for FFI_ArrowArray

fn drop(&mut self)

Executes the destructor for this type.

impl Send for FFI_ArrowArray

impl Sync for FFI_ArrowArray