Struct ExecutionPlanEncodeCtx 

pub struct ExecutionPlanEncodeCtx<'a> { /* private fields */ }

Available on crate feature proto only.

Context handed to ExecutionPlan::try_to_proto.

Provides the primitives a plan needs to serialize its children and expressions without naming datafusion-proto.

Implementations

impl<'a> ExecutionPlanEncodeCtx<'a>

pub fn new(encoder: &'a dyn ExecutionPlanEncode) -> Self

Create a new encode context wrapping an [ExecutionPlanEncode] implementation (supplied by datafusion-proto).

pub fn encode_child( &self, plan: &Arc<dyn ExecutionPlan>, ) -> Result<PhysicalPlanNode>

Serialize a single child plan.

pub fn encode_children<'b, I>(&self, plans: I) -> Result<Vec<PhysicalPlanNode>>

where I: IntoIterator<Item = &'b Arc<dyn ExecutionPlan>>,

Serialize an iterator of child plans.

pub fn encode_expr( &self, expr: &Arc<dyn PhysicalExpr>, ) -> Result<PhysicalExprNode>

Serialize a single physical expression.

pub fn encode_expressions<'b, I>( &self, exprs: I, ) -> Result<Vec<PhysicalExprNode>>

where I: IntoIterator<Item = &'b Arc<dyn PhysicalExpr>>,

Serialize an iterator of physical expressions.

pub fn encode_udf(&self, udf: &ScalarUDF) -> Result<Option<Vec<u8>>>

Serialize a scalar UDF to an opaque payload (None = built-in, decodable by name). No proto types cross this boundary.

pub fn encode_udaf(&self, udaf: &AggregateUDF) -> Result<Option<Vec<u8>>>

Serialize an aggregate UDF to an opaque payload (None = decodable by name).

pub fn encode_udwf(&self, udwf: &WindowUDF) -> Result<Option<Vec<u8>>>

Serialize a window UDF to an opaque payload (None = decodable by name).

pub fn expr_ctx(&self) -> PhysicalExprEncodeCtx<'_>

An expression-level encode context backed by this plan context.

Lets a plan hand ctx to expression-level conversions that own their own wire logic — e.g. Partitioning::try_to_proto and PhysicalSortExpr::try_to_proto.

Trait Implementations

impl PhysicalExprEncode for ExecutionPlanEncodeCtx<'_>

Lets ExecutionPlanEncodeCtx back a PhysicalExprEncodeCtx, so expression-level conversions can be reused from plan hooks.

fn encode(&self, expr: &Arc<dyn PhysicalExpr>) -> Result<PhysicalExprNode>

Encode an expression to a protobuf node.