Struct expr::OptimizedMirRelationExpr

pub struct OptimizedMirRelationExpr(pub MirRelationExpr);

A MirRelationExpr that claims to have been optimized, e.g., by an transform::Optimizer.

Tuple Fields

0: MirRelationExpr

Implementations

impl OptimizedMirRelationExpr

pub fn declare_optimized(expr: MirRelationExpr) -> OptimizedMirRelationExpr

Declare that the input expr is optimized, without actually running it through an optimizer. This can be useful to mark as optimized literal MirRelationExprs that are obviously optimal, without invoking the whole machinery of the optimizer.

pub fn as_inner_mut(&mut self) -> &mut MirRelationExpr

Get mutable access to the inner MirRelationExpr

Callers of this method need to ensure that the underlying expression stays optimized after any mutations are applied

pub fn into_inner(self) -> MirRelationExpr

Methods from Deref<Target = MirRelationExpr>

pub fn typ(&self) -> RelationType

Reports the schema of the relation.

This method determines the type through recursive traversal of the relation expression, drawing from the types of base collections. As such, this is not an especially cheap method, and should be used judiciously.

The relation type is computed incrementally with a recursive post-order traversal, that accumulates the input types for the relations yet to be visited in type_stack.

pub fn typ_with_input_types(&self, input_types: &[RelationType]) -> RelationType

Reports the schema of the relation given the schema of the input relations.

input_types is required to contain the schemas for the input relations of the current relation in the same order as they are visited by try_visit1 method, even though not all may be used for computing the schema of the current relation. For example, Let expects two input types, one for the value relation and one for the body, in that order, but only the one for the body is used to determine the type of the Let relation.

It is meant to be used during post-order traversals to compute relation schemas incrementally.

pub fn arity(&self) -> usize

The number of columns in the relation.

This number is determined from the type, which is determined recursively at non-trivial cost.

pub fn num_inputs(&self) -> usize

The number of child relations this relation has.

pub fn is_empty(&self) -> bool

Indicates if this is a constant empty collection.

A false value does not mean the collection is known to be non-empty, only that we cannot currently determine that it is statically empty.

pub fn global_uses(&self) -> Vec<GlobalId>

Returns the distinct global identifiers on which this expression depends.

See MirRelationExpr::global_uses_into to reuse an existing vector.

pub fn global_uses_into(&self, out: &mut Vec<GlobalId>)

Appends global identifiers on which this expression depends to out.

Unlike MirRelationExpr::global_uses, this method does not deduplicate the global identifiers.

pub fn pretty_humanized(&self, id_humanizer: &impl ExprHumanizer) -> String

Pretty-print this MirRelationExpr to a string.

This method allows an additional ExprHumanizer which can annotate identifiers with human-meaningful names for the identifiers.

pub fn pretty(&self) -> String

Pretty-print this MirRelationExpr to a string.

pub fn json(&self) -> String

Print this MirRelationExpr to a JSON-formatted string.

pub fn pretty_typed(&self) -> String

Pretty-print this MirRelationExpr to a string with type information.

pub fn try_visit_children<'a, F, E>(&'a self, f: F) -> Result<(), E> where
    F: FnMut(&'a MirRelationExpr) -> Result<(), E>,
    E: From<RecursionLimitError>, 

Applies a fallible immutable f to each child of type MirRelationExpr.

pub fn visit_children<'a, F>(&'a self, f: F) where
    F: FnMut(&'a MirRelationExpr), 

Applies an infallible immutable f to each child of type MirRelationExpr.

pub fn try_visit_post<'a, F, E>(&'a self, f: &mut F) -> Result<(), E> where
    F: FnMut(&'a MirRelationExpr) -> Result<(), E>,
    E: From<RecursionLimitError>, 

Post-order immutable fallible MirRelationExpr visitor.

pub fn visit_post<'a, F>(&'a self, f: &mut F) where
    F: FnMut(&'a MirRelationExpr), 

Post-order immutable infallible MirRelationExpr visitor.

pub fn try_visit_pre<F, E>(&self, f: &mut F) -> Result<(), E> where
    F: FnMut(&MirRelationExpr) -> Result<(), E>,
    E: From<RecursionLimitError>, 

Pre-order immutable fallible MirRelationExpr visitor.

pub fn visit_pre<F>(&self, f: &mut F) where
    F: FnMut(&MirRelationExpr), 

Pre-order immutable infallible MirRelationExpr visitor.

pub fn visit_pre_post<F1, F2>(&self, pre: &mut F1, post: &mut F2) where
    F1: FnMut(&MirRelationExpr) -> Option<Vec<&MirRelationExpr>>,
    F2: FnMut(&MirRelationExpr), 

A generalization of Self::visit_pre and Self::visit_post.

The function pre runs on a MirRelationExpr before it runs on any of the child MirRelationExprs. The function post runs on child MirRelationExprs first before the parent.

Optionally, pre can return which child MirRelationExprs, if any, should be visited (default is to visit all children).

Trait Implementations

impl Clone for OptimizedMirRelationExpr

fn clone(&self) -> OptimizedMirRelationExpr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OptimizedMirRelationExpr

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

Formats the value using the given formatter.

impl Deref for OptimizedMirRelationExpr

type Target = MirRelationExpr

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for OptimizedMirRelationExpr

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Hash for OptimizedMirRelationExpr

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<OptimizedMirRelationExpr> for OptimizedMirRelationExpr

fn eq(&self, other: &OptimizedMirRelationExpr) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for OptimizedMirRelationExpr

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Eq for OptimizedMirRelationExpr

impl StructuralEq for OptimizedMirRelationExpr

impl StructuralPartialEq for OptimizedMirRelationExpr