From c9a6a121969633c1bb981a2bc0553548006f7020 Mon Sep 17 00:00:00 2001 From: Andrew Lamb Date: Thu, 18 Feb 2021 17:22:27 -0500 Subject: [PATCH 1/3] ARROW-11692: [Rust][DataFusion] Improve OptimizerRule comments --- rust/datafusion/src/optimizer/optimizer.rs | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/rust/datafusion/src/optimizer/optimizer.rs b/rust/datafusion/src/optimizer/optimizer.rs index 34c566fc162..d37008b6193 100644 --- a/rust/datafusion/src/optimizer/optimizer.rs +++ b/rust/datafusion/src/optimizer/optimizer.rs @@ -20,11 +20,14 @@ use crate::error::Result; use crate::logical_plan::LogicalPlan; -/// An optimizer rules performs a transformation on a logical plan to produce an optimized -/// logical plan. + +/// `OptimizerRule` transforms one ['LogicalPlan'] into another which +/// computes the same results, but in a potentially more efficient +/// way. pub trait OptimizerRule { - /// Perform optimizations on the plan - fn optimize(&self, plan: &LogicalPlan) -> Result; - /// Produce a human readable name for this optimizer rule + /// Rewrite `plan` to an optimized form + fn optimize(&self, plan: LogicalPlan) -> Result; + + /// A human readable name for this optimizer rule fn name(&self) -> &str; } From 09b3027ba95ea67d1245bad884390d4fe103422a Mon Sep 17 00:00:00 2001 From: Andrew Lamb Date: Thu, 18 Feb 2021 17:32:34 -0500 Subject: [PATCH 2/3] Correct signature --- rust/datafusion/src/optimizer/optimizer.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rust/datafusion/src/optimizer/optimizer.rs b/rust/datafusion/src/optimizer/optimizer.rs index d37008b6193..4e32dae256a 100644 --- a/rust/datafusion/src/optimizer/optimizer.rs +++ b/rust/datafusion/src/optimizer/optimizer.rs @@ -26,7 +26,7 @@ use crate::logical_plan::LogicalPlan; /// way. pub trait OptimizerRule { /// Rewrite `plan` to an optimized form - fn optimize(&self, plan: LogicalPlan) -> Result; + fn optimize(&self, plan: &LogicalPlan) -> Result; /// A human readable name for this optimizer rule fn name(&self) -> &str; From 8035d9b49a299d42d233d31ecd26377366150f84 Mon Sep 17 00:00:00 2001 From: Andrew Lamb Date: Fri, 19 Feb 2021 08:46:24 -0500 Subject: [PATCH 3/3] cargo fmt --- rust/datafusion/src/optimizer/optimizer.rs | 1 - 1 file changed, 1 deletion(-) diff --git a/rust/datafusion/src/optimizer/optimizer.rs b/rust/datafusion/src/optimizer/optimizer.rs index 4e32dae256a..dee8e06a5e3 100644 --- a/rust/datafusion/src/optimizer/optimizer.rs +++ b/rust/datafusion/src/optimizer/optimizer.rs @@ -20,7 +20,6 @@ use crate::error::Result; use crate::logical_plan::LogicalPlan; - /// `OptimizerRule` transforms one ['LogicalPlan'] into another which /// computes the same results, but in a potentially more efficient /// way.