Struct PlanRef 

pub struct PlanRef(/* private fields */);

Shared, erased handle to a plan operator.

Implementations

impl PlanRef

pub fn ptr_eq(lhs: &Self, rhs: &Self) -> bool

Returns whether two references point at the same plan.

pub fn id(&self) -> PlanId

Returns the operator ID.

pub fn dtype(&self) -> &DType

Returns the dtype produced by this plan.

pub fn row_count(&self) -> u64

Returns the number of rows in this plan’s row domain.

pub fn children(&self) -> &PlanChildren

Returns the common child container without initializing any child.

pub fn child_count(&self) -> usize

Returns the number of children without initializing any child.

pub fn child(&self, index: usize) -> VortexResult<Option<PlanRef>>

Returns the child at index, initializing it on first access.

pub fn child_required(&self, index: usize) -> VortexResult<PlanRef>

Returns the child at index, or an error when the index is out of bounds.

pub fn with_children( &self, children: impl Into<PlanChildren>, ) -> VortexResult<PlanRef>

Rebuilds this plan with children stored outside its erased operator data.

pub fn child_name(&self, index: usize) -> Cow<'_, str>

Returns the display name of the child at index.

pub fn metadata(&self) -> Option<Vec<u8>>

Serializes operator-specific metadata, or None when the operator is not serializable.

pub fn is<V: PlanVTable>(&self) -> bool

Returns whether this plan uses vtable V.

pub fn as_<V: PlanVTable>(&self) -> &Plan<V>

Downcasts this plan to vtable V.

pub fn as_opt<V: PlanVTable>(&self) -> Option<&Plan<V>>

Attempts to borrow this plan as a typed handle for vtable V.

pub fn compile( &self, rows: Range<u64>, mask: &Mask, compiler: &mut Compiler<'_>, ) -> VortexResult<Option<Chain>>

Compiles this plan over rows of its row domain, restricted to mask. See PlanVTable::compile.

pub fn reach( &self, rows: Range<u64>, at: &Reach, visit: &mut dyn FnMut(SegmentId, Range<u64>), ) -> VortexResult<()>

Visits the segments compiling this plan over rows could read. See PlanVTable::reach.

pub fn display_tree(&self) -> PlanTreeDisplay<'_>

Displays this plan and its descendants with the default plan extractors.

pub fn tree_display_builder(&self) -> PlanTreeDisplay<'_>

Creates a composable tree display with no extractors.

Trait Implementations

impl Clone for PlanRef

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 PlanRef

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

Formats the value using the given formatter.

impl Display for PlanRef

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

Formats the value using the given formatter.

impl<V: PlanVTable> From<Plan<V>> for PlanRef

fn from(value: Plan<V>) -> Self

Converts to this type from the input type.

impl TreeDisplayExtractor<PlanRef, DepthContext> for PlanSummaryExtractor

fn write_header( &self, plan: &PlanRef, _context: &PlanTreeContext, formatter: &mut Formatter<'_>, ) -> Result

Write space-prefixed annotations on the node’s header line.

fn write_details( &self, node: &N, context: &C, formatter: &mut IndentedFormatter<'_, '_>, ) -> Result<(), Error>

Write detail lines beneath the node’s header.