arrow::ffi_stream

Struct FFI_ArrowArrayStream

#[repr(C)]
pub struct FFI_ArrowArrayStream { pub get_schema: Option<unsafe extern "C" fn(_: *mut FFI_ArrowArrayStream, _: *mut FFI_ArrowSchema) -> i32>, pub get_next: Option<unsafe extern "C" fn(_: *mut FFI_ArrowArrayStream, _: *mut FFI_ArrowArray) -> i32>, pub get_last_error: Option<unsafe extern "C" fn(_: *mut FFI_ArrowArrayStream) -> *const i8>, pub release: Option<unsafe extern "C" fn(_: *mut FFI_ArrowArrayStream)>, pub private_data: *mut c_void, }
Expand description

ABI-compatible struct for ArrayStream from C Stream Interface See https://arrow.apache.org/docs/format/CStreamInterface.html#structure-definitions This was created by bindgen

Fields§

§get_schema: Option<unsafe extern "C" fn(_: *mut FFI_ArrowArrayStream, _: *mut FFI_ArrowSchema) -> i32>

C function to get schema from the stream

§get_next: Option<unsafe extern "C" fn(_: *mut FFI_ArrowArrayStream, _: *mut FFI_ArrowArray) -> i32>

C function to get next array from the stream

§get_last_error: Option<unsafe extern "C" fn(_: *mut FFI_ArrowArrayStream) -> *const i8>

C function to get the error from last operation on the stream

§release: Option<unsafe extern "C" fn(_: *mut FFI_ArrowArrayStream)>

C function to release the stream

§private_data: *mut c_void

Private data used by the stream

Implementations§

§

impl FFI_ArrowArrayStream

pub fn new( batch_reader: Box<dyn RecordBatchReader<Item = Result<RecordBatch, ArrowError>> + Send>, ) -> FFI_ArrowArrayStream

Creates a new FFI_ArrowArrayStream.

pub unsafe fn from_raw( raw_stream: *mut FFI_ArrowArrayStream, ) -> FFI_ArrowArrayStream

Takes ownership of the pointed to FFI_ArrowArrayStream

This acts to move the data out of raw_stream, setting the release callback to NULL

§Safety
  • raw_stream must be valid for reads and writes
  • raw_stream must be properly aligned
  • raw_stream must point to a properly initialized value of FFI_ArrowArrayStream

pub fn empty() -> FFI_ArrowArrayStream

Creates a new empty FFI_ArrowArrayStream. Used to import from the C Stream Interface.

Trait Implementations§

§

impl Debug for FFI_ArrowArrayStream

§

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

Formats the value using the given formatter. Read more
§

impl Drop for FFI_ArrowArrayStream

§

fn drop(&mut self)

Executes the destructor for this type. Read more
§

impl Send for FFI_ArrowArrayStream

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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> Ungil for T
where T: Send,