Struct datafusion_common::tree_node::Transformed

pub struct Transformed<T> {
    pub data: T,
    pub transformed: bool,
    pub tnr: TreeNodeRecursion,
}

This struct is used by tree transformation APIs such as

• TreeNode::rewrite,
• TreeNode::transform_down,
• TreeNode::transform_down_mut,
• TreeNode::transform_up,
• TreeNode::transform_up_mut,
• TreeNode::transform_down_up

to control the transformation and return the transformed result.

Specifically, API users can provide transformation closures or TreeNodeRewriter implementations to control the transformation by returning:

• The resulting (possibly transformed) node,
• A flag indicating whether any change was made to the node, and
• A flag specifying how to proceed with the recursion.

At the end of the transformation, the return value will contain:

• The final (possibly transformed) tree,
• A flag indicating whether any change was made to the tree, and
• A flag specifying how the recursion ended.

Fields

data: T

transformed: bool

tnr: TreeNodeRecursion

Implementations

impl<T> Transformed<T>

pub fn new(data: T, transformed: bool, tnr: TreeNodeRecursion) -> Self

Create a new Transformed object with the given information.

pub fn yes(data: T) -> Self

Wrapper for transformed data with TreeNodeRecursion::Continue statement.

pub fn no(data: T) -> Self

Wrapper for unchanged data with TreeNodeRecursion::Continue statement.

pub fn update_data<U, F: FnOnce(T) -> U>(self, f: F) -> Transformed<U>

Applies the given f to the data of this Transformed object.

pub fn map_data<U, F: FnOnce(T) -> Result<U>>( self, f: F ) -> Result<Transformed<U>>

Maps the data of Transformed object to the result of the given f.

pub fn try_transform_node<F: FnOnce(T) -> Result<Transformed<T>>>( self, f: F ) -> Result<Transformed<T>>

If TreeNodeRecursion of the node is TreeNodeRecursion::Continue or TreeNodeRecursion::Jump, transformation is applied to the node. Otherwise, it remains as it is.

Trait Implementations

impl<T: Debug> Debug for Transformed<T>

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

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq for Transformed<T>

fn eq(&self, other: &Transformed<T>) -> bool

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

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

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

impl<T> StructuralPartialEq for Transformed<T>