Skip to main content

ArrowArray

Struct ArrowArray 

Source
#[repr(C)]
pub struct ArrowArray { pub length: i64, pub null_count: i64, pub offset: i64, pub n_buffers: i64, pub n_children: i64, pub buffers: *mut *const c_void, pub children: *mut *mut ArrowArray, pub dictionary: *mut ArrowArray, pub release: Option<unsafe extern "C" fn(array: *mut ArrowArray)>, pub private_data: *mut c_void, }
Expand description

ArrowArray C Data Interface: array (columnar data).

See: https://arrow.apache.org/docs/format/CDataInterface.html#the-arrowarray-structure

Ownership: This type has no Drop impl. Callers must invoke the release callback (if Some) before dropping to free resources.

Fields§

§length: i64§null_count: i64§offset: i64§n_buffers: i64§n_children: i64§buffers: *mut *const c_void§children: *mut *mut ArrowArray§dictionary: *mut ArrowArray§release: Option<unsafe extern "C" fn(array: *mut ArrowArray)>§private_data: *mut c_void

Implementations§

Source§

impl ArrowArray

Source

pub fn empty() -> Self

Create an empty (released) array.

Source

pub fn is_released(&self) -> bool

Whether this array has been released (release callback is None).

Source

pub unsafe fn from_raw<T>(ptr: &T) -> &Self

Borrow a foreign C Data Interface array as ours (zero-copy).

§Safety

T must have the Arrow C Data Interface ArrowArray memory layout.

Source

pub unsafe fn from_raw_mut<T>(ptr: &mut T) -> &mut Self

Mutably borrow a foreign C Data Interface array as ours (zero-copy).

§Safety

T must have the Arrow C Data Interface ArrowArray memory layout.

Source

pub unsafe fn as_raw<T>(&self) -> &T

Borrow ours as a foreign C Data Interface array type (zero-copy).

§Safety

T must have the Arrow C Data Interface ArrowArray memory layout.

Source

pub unsafe fn from_owned<T>(val: T) -> Self

Take ownership of a foreign C Data Interface array.

§Safety
  • T must have the Arrow C Data Interface ArrowArray memory layout.
  • Ownership transfers — the caller must not use or drop the original.
Source

pub unsafe fn into_owned<T>(self) -> T

Convert into a foreign C Data Interface array type.

§Safety
  • T must have the Arrow C Data Interface ArrowArray memory layout.
  • Ownership transfers — the caller must not use or drop the original.

Trait Implementations§

Source§

impl Debug for ArrowArray

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Send for ArrowArray

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.