Enum DisplayFormatType 

pub enum DisplayFormatType {
    Default,
    Verbose,
    TreeRender,
}

Options for controlling how each ExecutionPlan should format itself

Variants

Default

Default, compact format. Example: FilterExec: c12 < 10.0

This format is designed to provide a detailed textual description of all parts of the plan.

Verbose

Verbose, showing all available details.

This form is even more detailed than Self::Default

TreeRender

TreeRender, displayed in the tree explain type.

This format is inspired by DuckDB’s explain plans. The information presented should be “user friendly”, and contain only the most relevant information for understanding a plan. It should NOT contain the same level of detail information as the Self::Default format.

In this mode, each line has one of two formats:

1. A string without a =, which is printed in its own line

2. A string with a = that is treated as a key=value pair. Everything before the first = is treated as the key, and everything after the first = is treated as the value.

For example, if the output of TreeRender is this:

Parquet
partition_sizes=[1]

It is rendered in the center of a box in the following way:

┌───────────────────────────┐
│       DataSourceExec      │
│    --------------------   │
│    partition_sizes: [1]   │
│          Parquet          │
└───────────────────────────┘

Trait Implementations

impl Clone for DisplayFormatType

fn clone(&self) -> DisplayFormatType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DisplayFormatType

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

Formats the value using the given formatter.

impl PartialEq for DisplayFormatType

fn eq(&self, other: &DisplayFormatType) -> 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 Copy for DisplayFormatType

impl StructuralPartialEq for DisplayFormatType