Struct PlanContext

pub struct PlanContext<T: Sized> {
    pub plan: Arc<dyn ExecutionPlan>,
    pub data: T,
    pub children: Vec<Self>,
}

A node object beneficial for writing optimizer rules, encapsulating an ExecutionPlan node with a payload. Since there are two ways to access child plans—directly from the plan and through child nodes—it’s recommended to perform mutable operations via Self::update_plan_from_children.

Fields

plan: Arc<dyn ExecutionPlan>

The execution plan associated with this context.

data: T

Custom data payload of the node.

children: Vec<Self>

Child contexts of this node.

Implementations

impl<T> PlanContext<T>

pub fn new(plan: Arc<dyn ExecutionPlan>, data: T, children: Vec<Self>) -> Self

pub fn update_plan_from_children(self) -> Result<Self>

impl<T: Default> PlanContext<T>

pub fn new_default(plan: Arc<dyn ExecutionPlan>) -> Self

Trait Implementations

impl<T> ConcreteTreeNode for PlanContext<T>

fn children(&self) -> &[Self]

Provides read-only access to child nodes.

fn take_children(self) -> (Self, Vec<Self>)

Detaches the node from its children, returning the node itself and its detached children.

fn with_new_children(self, children: Vec<Self>) -> Result<Self>

Reattaches updated child nodes to the node, returning the updated node.

impl<T: Debug + Sized> Debug for PlanContext<T>

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

Formats the value using the given formatter.

impl<T: Display> Display for PlanContext<T>

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

Formats the value using the given formatter.