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) -> Vec<FFI_ExecutionPlan>,
    pub with_new_children: unsafe extern "C" fn(plan: &Self, children: Vec<Self>) -> FFI_Result<Self>,
    pub name: unsafe extern "C" fn(plan: &Self) -> String,
    pub execute: unsafe extern "C" fn(plan: &Self, partition: usize, context: FFI_TaskContext) -> FFI_Result<FFI_RecordBatchStream>,
    pub repartitioned: unsafe extern "C" fn(plan: &Self, target_partitions: usize, config: FFI_ConfigOptions) -> FFI_Result<FFI_Option<FFI_ExecutionPlan>>,
    pub metrics: unsafe extern "C" fn(plan: &Self) -> FFI_Option<FFI_MetricsSet>,
    pub partition_statistics: unsafe extern "C" fn(plan: &Self, partition: FFI_Option<usize>) -> FFI_Result<Vec<u8>>,
    pub clone: unsafe extern "C" fn(plan: &Self) -> Self,
    pub release: unsafe extern "C" fn(arg: &mut Self),
    pub private_data: *mut c_void,
    pub library_marker_id: extern "C" fn() -> usize,
}

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) -> Vec<FFI_ExecutionPlan>

Return a vector of children plans

with_new_children: unsafe extern "C" fn(plan: &Self, children: Vec<Self>) -> FFI_Result<Self>

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

Return the plan name.

execute: unsafe extern "C" fn(plan: &Self, partition: usize, context: FFI_TaskContext) -> FFI_Result<FFI_RecordBatchStream>

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

repartitioned: unsafe extern "C" fn(plan: &Self, target_partitions: usize, config: FFI_ConfigOptions) -> FFI_Result<FFI_Option<FFI_ExecutionPlan>>

metrics: unsafe extern "C" fn(plan: &Self) -> FFI_Option<FFI_MetricsSet>

Snapshot the plan’s execution metrics. Returns None when the underlying ExecutionPlan::metrics returned None.

partition_statistics: unsafe extern "C" fn(plan: &Self, partition: FFI_Option<usize>) -> FFI_Result<Vec<u8>>

Snapshot partition statistics. partition == None corresponds to statistics over all partitions; Some(idx) corresponds to a specific partition. The returned bytes are a prost-encoded datafusion_proto_common::Statistics.

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.

library_marker_id: extern "C" fn() -> usize

Utility to identify when FFI objects are accessed locally through the foreign interface. See crate::get_library_marker_id and the crate’s README.md for more information.

Implementations

impl FFI_ExecutionPlan

pub fn new(plan: Arc<dyn ExecutionPlan>, runtime: Option<Handle>) -> Self

This function is called on the provider’s side.

Trait Implementations

impl Clone for FFI_ExecutionPlan

fn clone(&self) -> Self

Returns a duplicate 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.

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_ExecutionPlan

impl Sync for FFI_ExecutionPlan

impl TryFrom<&FFI_ExecutionPlan> for Arc<dyn ExecutionPlan>

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