Struct PlanContext 

pub struct PlanContext<'a> {
    pub bound: &'a BoundStatement,
    pub qctx: Arc<QueryContext>,
    pub metadata: Option<&'a MetadataContext>,
    pub validated: &'a ValidatedStatement,
}

Unified context for the plan_bound phase.

Bundles all inputs needed by statement planners during bound-statement planning. Callers construct a PlanContext once; planners destructure only the fields they need.

Fields

bound: &'a BoundStatement

The bound (post-binder) statement to plan.

qctx: Arc<QueryContext>

Query-level context (space, session, parameters).

metadata: Option<&'a MetadataContext>

Pre-resolved metadata for referenced tags/edges/indexes. Only populated when schema_manager is available.

validated: &'a ValidatedStatement

AST-derived validated statement (expression analysis context). Needed by planners that still use AST-level info (e.g., MATCH YIELD columns).

Implementations

impl<'a> PlanContext<'a>

pub fn new( bound: &'a BoundStatement, qctx: Arc<QueryContext>, metadata: Option<&'a MetadataContext>, validated: &'a ValidatedStatement, ) -> Self

Create a new PlanContext.

pub fn without_metadata( bound: &'a BoundStatement, qctx: Arc<QueryContext>, validated: &'a ValidatedStatement, ) -> Self

Create a PlanContext with metadata injected later.

pub fn as_inner(&self) -> PlanContext<'_>

Shorthand: return a sub-context containing only bound + qctx + validated, for recursive planners (Pipe, SetOperation) that forward to sub-planners.

pub fn with_bound<'b>(&'b self, bound: &'b BoundStatement) -> PlanContext<'b>

Replace the bound statement (for recursive planning of sub-statements).

pub fn derive_validated( &self, child: &BoundStatement, ) -> Option<ValidatedStatement>

Derive the ValidatedStatement aligned with a child bound statement.

Composite planners (Pipe, SetOperation, Explain) forward a shared validated that describes the whole query, while each stage planner expects the AST fragment matching its own bound sub-statement (e.g. MatchStatementPlanner requires Stmt::Match). The binder mirrors the AST structure exactly, so the fragment is located by walking the parent AST and parent bound statement in parallel.

Returns None when the structures do not mirror each other; callers then keep the parent validated (previous behavior).

Trait Implementations

impl<'a> Clone for PlanContext<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for PlanContext<'a>

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

Formats the value using the given formatter.