Struct AxisPlan 

#[non_exhaustive]
pub struct AxisPlan {
    pub axis: Axis,
    pub within: Vec<AxisPlan>,
}

One node in the user’s grouping plan: an axis to cluster on, plus a (possibly empty) list of sub-plans describing how to further cluster the records that fall into each top-level cluster.

--by FIELD,FIELD,... builds a degenerate chain (each axis is the only child of its parent). --within adds explicit children. The runtime walks within recursively per cluster.

AxisPlan is #[non_exhaustive] — construct values via AxisPlan::leaf, AxisPlan::with, or AxisPlan::with_many.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

axis: Axis

Axis to cluster on at this level.

within: Vec<AxisPlan>

Sub-plans applied to each cluster’s record subset. Empty for leaf levels.

Implementations

impl AxisPlan

pub fn leaf(axis: Axis) -> Self

A leaf plan with no sub-axes.

Examples

use face_core::{Axis, AxisPlan};

// `Axis` is `#[non_exhaustive]`; build it by deserializing the
// wire form (the same shape `result.axes[]` carries in §7).
let axis: Axis = serde_json::from_value(serde_json::json!({
    "field": "kind",
    "strategy": "exact",
    "auto": false,
})).unwrap();
let plan = AxisPlan::leaf(axis);
assert!(plan.within.is_empty());

pub fn with(axis: Axis, within: AxisPlan) -> Self

A plan with one sub-axis.

pub fn with_many(axis: Axis, within: Vec<AxisPlan>) -> Self

A plan with arbitrary children.

Trait Implementations

impl Clone for AxisPlan

fn clone(&self) -> AxisPlan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AxisPlan

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

Formats the value using the given formatter.