Struct FFI_QueryPlanner 

pub struct FFI_QueryPlanner {
    pub version: unsafe extern "C" fn() -> u64,
    pub library_marker_id: extern "C" fn() -> usize,
    /* private fields */
}

An ABI-stable handle to a QueryPlanner owned by another library.

The Rust-facing adapters serialize the input LogicalPlan and resulting ExecutionPlan; callers do not invoke the byte-oriented function pointer directly.

Fields

version: unsafe extern "C" fn() -> u64

Return the major DataFusion version number of this planner.

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.

Implementations

impl FFI_QueryPlanner

pub fn new( planner: Arc<dyn QueryPlanner + Send + Sync>, runtime: Option<Handle>, task_ctx_provider: impl Into<FFI_TaskContextProvider>, logical_codec: Arc<dyn LogicalExtensionCodec>, physical_codec: Arc<dyn PhysicalExtensionCodec>, ) -> Self

Creates an FFI_QueryPlanner with native extension codecs.

Both codecs are required so that the caller states which extension nodes survive the boundary. Pass DefaultLogicalExtensionCodec and DefaultPhysicalExtensionCodec when no custom nodes are involved. runtime and task_ctx_provider support codec callbacks across the FFI boundary.

pub fn new_with_ffi_codecs( planner: Arc<dyn QueryPlanner + Send + Sync>, logical_codec: FFI_LogicalExtensionCodec, physical_codec: FFI_PhysicalExtensionCodec, ) -> Self

Creates an FFI_QueryPlanner using prebuilt FFI extension codecs.

If planner is already foreign, this re-exports its original FFI handle rather than adding another wrapper layer. The handle still adopts the codecs supplied here, so they are never silently discarded.

pub async fn create_physical_plan_with_session_runtime( &self, logical_plan: &LogicalPlan, session: &dyn Session, session_runtime: Option<Handle>, ) -> Result<Arc<dyn ExecutionPlan>>

Creates a physical plan through this planner’s FFI interface.

This serializes logical_plan, exports session as an FFI_SessionRef, invokes the planner’s owning library, and deserializes its physical-plan response. session_runtime is attached to the exported session for callbacks that need its Tokio runtime.

The QueryPlanner implementation for ForeignQueryPlanner cannot obtain the session owner’s runtime from the trait API, so it calls this method with None. Embedders that own the runtime and need session callbacks to enter it must call this method directly with Some(handle).

Trait Implementations

impl Clone for FFI_QueryPlanner

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_QueryPlanner

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

Formats the value using the given formatter.

impl Drop for FFI_QueryPlanner

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 From<&FFI_QueryPlanner> for Arc<dyn QueryPlanner + Send + Sync>

fn from(planner: &FFI_QueryPlanner) -> Self

Converts to this type from the input type.

impl Send for FFI_QueryPlanner

impl Sync for FFI_QueryPlanner