Struct FFI_ExecutionPlan

#[repr(C)]
pub struct FFI_ExecutionPlan {
    pub properties: unsafe extern "C" fn(plan: &Self) -> FFI_PlanProperties,
    pub children: unsafe extern "C" fn(plan: &Self) -> RVec<FFI_ExecutionPlan>,
    pub name: unsafe extern "C" fn(plan: &Self) -> RString,
    pub execute: unsafe extern "C" fn(plan: &Self, partition: usize) -> RResult<FFI_RecordBatchStream, RString>,
    pub clone: unsafe extern "C" fn(plan: &Self) -> Self,
    pub release: unsafe extern "C" fn(arg: &mut Self),
    pub private_data: *mut c_void,
}

A stable struct for sharing a ExecutionPlan across FFI boundaries.

Fields

properties: unsafe extern "C" fn(plan: &Self) -> FFI_PlanProperties

Return the plan properties

children: unsafe extern "C" fn(plan: &Self) -> RVec<FFI_ExecutionPlan>

Return a vector of children plans

name: unsafe extern "C" fn(plan: &Self) -> RString

Return the plan name.

execute: unsafe extern "C" fn(plan: &Self, partition: usize) -> RResult<FFI_RecordBatchStream, RString>

Execute the plan and return a record batch stream. Errors will be returned as a string.

clone: unsafe extern "C" fn(plan: &Self) -> Self

Used to create a clone on the provider of the execution plan. This should only need to be called by the receiver of the plan.

release: unsafe extern "C" fn(arg: &mut Self)

Release the memory of the private data when it is no longer being used.

private_data: *mut c_void

Internal data. This is only to be accessed by the provider of the plan. A ForeignExecutionPlan should never attempt to access this data.

Implementations

impl FFI_ExecutionPlan

pub fn new(plan: Arc<dyn ExecutionPlan>, context: Arc<TaskContext>) -> Self

This function is called on the provider’s side.

Trait Implementations

impl Clone for FFI_ExecutionPlan

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FFI_ExecutionPlan

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

Formats the value using the given formatter.

impl Drop for FFI_ExecutionPlan

fn drop(&mut self)

Executes the destructor for this type.

impl GetStaticEquivalent_ for FFI_ExecutionPlan

type StaticEquivalent = _static_FFI_ExecutionPlan

The 'static equivalent of Self

impl StableAbi for FFI_ExecutionPlan

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 TryFrom<&FFI_ExecutionPlan> for ForeignExecutionPlan

type Error = DataFusionError

The type returned in the event of a conversion error.

fn try_from(plan: &FFI_ExecutionPlan) -> Result<Self, Self::Error>

Performs the conversion.

impl Send for FFI_ExecutionPlan

impl Sync for FFI_ExecutionPlan