Enum PlanBaseRef

pub enum PlanBaseRef<'a> {
    Logical(&'a PlanBase<Logical>),
    Stream(&'a PlanBase<Stream>),
    Batch(&'a PlanBase<Batch>),
}

Reference to PlanBase with erased conventions.

Used for accessing fields on a type-erased plan node. All traits of GenericPlanRef, PhysicalPlanRef, StreamPlanRef and BatchPlanRef are implemented for this type, so runtime checks are required when calling methods on it.

Variants

Logical(&'a PlanBase<Logical>)

Stream(&'a PlanBase<Stream>)

Batch(&'a PlanBase<Batch>)

Implementations

impl<'a> PlanBaseRef<'a>

pub fn is_logical(&self) -> bool

Returns true if this is a PlanBaseRef::Logical, otherwise false

pub fn as_logical_mut(&mut self) -> Option<&mut &'a PlanBase<Logical>>

Optionally returns mutable references to the inner fields if this is a PlanBaseRef::Logical, otherwise None

pub fn as_logical(&self) -> Option<&&'a PlanBase<Logical>>

Optionally returns references to the inner fields if this is a PlanBaseRef::Logical, otherwise None

pub fn into_logical(self) -> Result<&'a PlanBase<Logical>, Self>

Returns the inner fields if this is a PlanBaseRef::Logical, otherwise returns back the enum in the Err case of the result

pub fn is_stream(&self) -> bool

Returns true if this is a PlanBaseRef::Stream, otherwise false

pub fn as_stream_mut(&mut self) -> Option<&mut &'a PlanBase<Stream>>

Optionally returns mutable references to the inner fields if this is a PlanBaseRef::Stream, otherwise None

pub fn as_stream(&self) -> Option<&&'a PlanBase<Stream>>

Optionally returns references to the inner fields if this is a PlanBaseRef::Stream, otherwise None

pub fn into_stream(self) -> Result<&'a PlanBase<Stream>, Self>

Returns the inner fields if this is a PlanBaseRef::Stream, otherwise returns back the enum in the Err case of the result

pub fn is_batch(&self) -> bool

Returns true if this is a PlanBaseRef::Batch, otherwise false

pub fn as_batch_mut(&mut self) -> Option<&mut &'a PlanBase<Batch>>

Optionally returns mutable references to the inner fields if this is a PlanBaseRef::Batch, otherwise None

pub fn as_batch(&self) -> Option<&&'a PlanBase<Batch>>

Optionally returns references to the inner fields if this is a PlanBaseRef::Batch, otherwise None

pub fn into_batch(self) -> Result<&'a PlanBase<Batch>, Self>

Returns the inner fields if this is a PlanBaseRef::Batch, otherwise returns back the enum in the Err case of the result

impl PlanBaseRef<'_>

pub fn convention(self) -> Convention

Get the convention of this plan base.

impl<'a> PlanBaseRef<'a>

Workaround for getters returning references.

For example, callers writing GenericPlanRef::schema(&foo.plan_base()) will lead to a borrow checker error, as it borrows PlanBaseRef again, which is already a reference.

As a workaround, we directly let the getters below take the ownership of PlanBaseRef, which is Copy. When callers write foo.plan_base().schema(), the compiler will prefer these ones over the ones defined in traits like GenericPlanRef.

pub(super) fn schema(self) -> &'a Schema

pub(super) fn stream_key(self) -> Option<&'a [usize]>

pub(super) fn functional_dependency(self) -> &'a FunctionalDependencySet

pub(super) fn distribution(self) -> &'a Distribution

pub(super) fn watermark_columns(self) -> &'a FixedBitSet

pub(super) fn columns_monotonicity(self) -> &'a MonotonicityMap

pub(super) fn order(self) -> &'a Order

Trait Implementations

impl BatchPlanRef for PlanBaseRef<'_>

fn order(&self) -> &Order

impl<'a> Clone for PlanBaseRef<'a>

fn clone(&self) -> PlanBaseRef<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for PlanBaseRef<'a>

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

Formats the value using the given formatter.

impl GenericPlanRef for PlanBaseRef<'_>

fn id(&self) -> PlanNodeId

fn schema(&self) -> &Schema

fn stream_key(&self) -> Option<&[usize]>

fn functional_dependency(&self) -> &FunctionalDependencySet

fn ctx(&self) -> OptimizerContextRef

impl<'a> Hash for PlanBaseRef<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq for PlanBaseRef<'a>

fn eq(&self, other: &PlanBaseRef<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PhysicalPlanRef for PlanBaseRef<'_>

fn distribution(&self) -> &Distribution

impl StreamPlanRef for PlanBaseRef<'_>

fn append_only(&self) -> bool

fn emit_on_window_close(&self) -> bool

fn watermark_columns(&self) -> &FixedBitSet

fn columns_monotonicity(&self) -> &MonotonicityMap

impl<'a> Copy for PlanBaseRef<'a>

impl<'a> Eq for PlanBaseRef<'a>

impl<'a> StructuralPartialEq for PlanBaseRef<'a>