Struct FFI_ArrowArrayStream 

#[repr(C)]
pub struct FFI_ArrowArrayStream {
    get_schema: Option<unsafe extern "C" fn(arg1: *mut Self, out: *mut FFI_ArrowSchema) -> c_int>,
    get_next: Option<unsafe extern "C" fn(arg1: *mut Self, out: *mut FFI_ArrowArray) -> c_int>,
    get_last_error: Option<unsafe extern "C" fn(arg1: *mut Self) -> *const c_char>,
    release: Option<unsafe extern "C" fn(arg1: *mut Self)>,
    private_data: *mut c_void,
}

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(arg1: *mut Self, out: *mut FFI_ArrowSchema) -> c_int>

C function to get schema from the stream

get_next: Option<unsafe extern "C" fn(arg1: *mut Self, out: *mut FFI_ArrowArray) -> c_int>

C function to get next array from the stream

get_last_error: Option<unsafe extern "C" fn(arg1: *mut Self) -> *const c_char>

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

release: Option<unsafe extern "C" fn(arg1: *mut Self)>

C function to release the stream

private_data: *mut c_void

Private data used by the stream, owned by the release callback.

Implementations

impl FFI_ArrowArrayStream

pub fn new(batch_reader: Box<dyn RecordBatchReader + Send>) -> Self

Creates a new FFI_ArrowArrayStream.

pub unsafe fn new_unchecked( get_schema: Option<unsafe extern "C" fn(arg1: *mut Self, out: *mut FFI_ArrowSchema) -> c_int>, get_next: Option<unsafe extern "C" fn(arg1: *mut Self, out: *mut FFI_ArrowArray) -> c_int>, get_last_error: Option<unsafe extern "C" fn(arg1: *mut Self) -> *const c_char>, release: Option<unsafe extern "C" fn(arg1: *mut Self)>, private_data: *mut c_void, ) -> Self

Creates a new FFI_ArrowArrayStream from its raw parts.

Safety

The caller takes responsibility for the C stream interface contract:

• Each callback that is Some must be sound to invoke with a pointer to this struct, and must implement the semantics the C stream interface specifies for it.
• private_data must own everything the callbacks rely on, and must remain valid until release is called.
• release, if Some, is invoked by Drop with a pointer to this struct. It must free private_data exactly once and then set the release callback to None to mark the stream released.
• If release is None the stream is already released, so dropping it must not leak: nothing may be left for the callback to free.

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

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() -> Self

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

pub fn get_schema( &self, ) -> Option<unsafe extern "C" fn(arg1: *mut Self, out: *mut FFI_ArrowSchema) -> c_int>

Returns the producer-provided callback that writes this stream’s schema, if any.

Safety

The callback must be invoked with a pointer to the stream it was read from.

pub fn get_next( &self, ) -> Option<unsafe extern "C" fn(arg1: *mut Self, out: *mut FFI_ArrowArray) -> c_int>

Returns the producer-provided callback that yields the next array, if any.

Safety

The callback must be invoked with a pointer to the stream it was read from.

pub fn get_last_error( &self, ) -> Option<unsafe extern "C" fn(arg1: *mut Self) -> *const c_char>

Returns the producer-provided callback that describes the last error, if any.

Safety

The callback must be invoked with a pointer to the stream it was read from. The string it returns is owned by the producer and valid only until the next call on the stream.

pub fn release(&self) -> Option<unsafe extern "C" fn(arg1: *mut Self)>

Returns the producer-provided release callback, if any.

pub fn private_data(&self) -> *mut c_void

Returns the opaque producer-provided private data pointer.

pub unsafe fn set_release( &mut self, release: Option<unsafe extern "C" fn(arg1: *mut Self)>, ) -> Option<unsafe extern "C" fn(arg1: *mut Self)>

Replaces the release callback, returning the previous one.

Lets a consumer wrap release: save the old callback, install its own, and chain back on drop. See https://github.com/apache/arrow-rs/issues/9771.

Safety

Drop calls this callback with a pointer to self. The new callback must correctly release this stream (usually by chaining to the returned one) and must match the FFI_ArrowArrayStream::private_data it reads. A wrong callback is undefined behavior on drop.

pub unsafe fn set_private_data( &mut self, private_data: *mut c_void, ) -> *mut c_void

Replaces the private data pointer, returning the previous one.

Safety

The old pointer is returned without being freed; the caller owns it from here. The new pointer must match what the current FFI_ArrowArrayStream::release callback expects.

Trait Implementations

impl Debug for FFI_ArrowArrayStream

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

Formats the value using the given formatter.

impl Drop for FFI_ArrowArrayStream

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Send for FFI_ArrowArrayStream