Struct FFI_RecordBatchStream

#[repr(C)]
pub struct FFI_RecordBatchStream {
    pub poll_next: unsafe extern "C" fn(stream: &Self, cx: &mut FfiContext<'_>) -> FfiPoll<ROption<RResult<WrappedArray, RString>>>,
    pub schema: unsafe extern "C" fn(stream: &Self) -> WrappedSchema,
    pub private_data: *mut c_void,
}

A stable struct for sharing RecordBatchStream across FFI boundaries. We use the async-ffi crate for handling async calls across libraries.

Fields

poll_next: unsafe extern "C" fn(stream: &Self, cx: &mut FfiContext<'_>) -> FfiPoll<ROption<RResult<WrappedArray, RString>>>

This mirrors the poll_next of RecordBatchStream but does so in a FFI safe manner.

schema: unsafe extern "C" fn(stream: &Self) -> WrappedSchema

Return the schema of the record batch

private_data: *mut c_void

Internal data. This is only to be accessed by the provider of the plan. The foreign library should never attempt to access this data.

Implementations

impl FFI_RecordBatchStream

pub fn new(stream: SendableRecordBatchStream, runtime: Option<Handle>) -> Self

Trait Implementations

impl Debug for FFI_RecordBatchStream

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

Formats the value using the given formatter.

impl From<Pin<Box<dyn RecordBatchStream<Item = Result<RecordBatch, DataFusionError>> + Send>>> for FFI_RecordBatchStream

fn from(stream: SendableRecordBatchStream) -> Self

Converts to this type from the input type.

impl GetStaticEquivalent_ for FFI_RecordBatchStream

type StaticEquivalent = _static_FFI_RecordBatchStream

The 'static equivalent of Self

impl RecordBatchStream for FFI_RecordBatchStream

fn schema(&self) -> SchemaRef

Returns the schema of this RecordBatchStream.

impl StableAbi for FFI_RecordBatchStream

const LAYOUT: &'static TypeLayout

The layout of the type provided by implementors.

type IsNonZeroType = False

Whether this type has a single invalid bit-pattern.

const ABI_CONSTS: AbiConsts = _

const-equivalents of the associated types.

impl Stream for FFI_RecordBatchStream

type Item = Result<RecordBatch, DataFusionError>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl Send for FFI_RecordBatchStream