Struct TreeFlattenSpec 

pub struct TreeFlattenSpec {
    pub root: Option<String>,
    pub children: String,
    pub leaf: String,
    pub columns: ColumnsSpec,
    pub groups: Vec<ColumnsSpec>,
    pub ancestors: Option<AncestorsSpec>,
    pub path_as: Option<String>,
    pub path_sep: String,
    pub drop_empty: bool,
    pub emit_group_rows: bool,
    pub max_depth: usize,
}

Available on crate feature transform-tree-flatten only.

Spec for the tree_flatten transform — recursive tree/matrix → leaf rows (1→0..N). Compile with TreeFlattenSpec::compile; attach via TreeFlattenSpec::into_stage.

Fields

root: Option<String>

Path to the top-level node array within the record — e.g. Rows.Row. Absent → the record itself is the single root node.

children: String

Path (within a node) to its child-node array — the recursion key, e.g. Rows.Row.

leaf: String

Leaf detection: has_no_children (default) or has_field:<name> (a node carrying <name> is a leaf even if it also has children).

columns: ColumnsSpec

How the value columns are read from a leaf. Set exactly one of columns or groups.

groups: Vec<ColumnsSpec>

Several positional cell arrays per leaf, each named by its own header list (#746) — the zip_columns groups shape. Each group needs a header; the groups’ columns are merged into one row, and a width mismatch, a missing cell array or a column two groups both name fails the page.

ancestors: Option<AncestorsSpec>

Ancestor/group labels carried onto every row.

path_as: Option<String>

Emit the joined ancestor path under this column (e.g. Income > Sales).

path_sep: String

Separator for path_as.

drop_empty: bool

Skip leaves whose value cells are all empty (null or "").

emit_group_rows: bool

Also emit a row for a group node that carries its own cells (subtotals).

max_depth: usize

Stack-overflow backstop; a branch deeper than this is truncated (logged).

Implementations

impl TreeFlattenSpec

pub fn compile(&self) -> Result<CompiledTreeFlatten, FaucetError>

Validate the spec, returning a reusable CompiledTreeFlatten.

pub fn into_stage(&self) -> Result<TransformStage, FaucetError>

Compile and wrap as a TransformStage::Custom (1→0..N). With groups the stage is a TransformStage::PageFn, so a record that cannot be zipped fails the page instead of passing through.

Trait Implementations

impl Clone for TreeFlattenSpec

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TreeFlattenSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TreeFlattenSpec

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for TreeFlattenSpec

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for TreeFlattenSpec

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for TreeFlattenSpec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TreeFlattenSpec