Expand description
Core primitives for the face CLI.
This crate hosts the public type surface that the rest of the face
workspace builds on: cluster identifiers, axes and strategies,
nested and flat cluster forms, the JSON envelope, and the typed
error type. See docs/design.md (§5–§7, §11) for the spec.
Re-exports§
pub use cluster::Cluster;pub use cluster::FlatCluster;pub use cluster::from_flat;pub use cluster::to_flat;pub use cluster_id::ClusterId;pub use cluster_id::ClusterIdError;pub use cluster_id::ClusterIdSegment;pub use cluster_tree::AxisPlan;pub use cluster_tree::build_tree;pub use detect::Preset;pub use detect::ScoreDetection;pub use detect::ScoreOptions;pub use detect::StrategyDetectionOptions;pub use detect::auto_strategy;pub use detect::auto_strategy_with_options;pub use detect::detect_preset;pub use detect::detect_score;pub use detect::detect_score_with_options;pub use detect::invert;pub use detect::pick_grouping_field;pub use detect::pick_grouping_field_with_options;pub use detect::sample_scores;pub use detect::validate_score_path;pub use diagnostics::Diagnostics;pub use diagnostics::NullDiagnostics;pub use diagnostics::VecDiagnostics;pub use envelope::DetectionReport;pub use envelope::Envelope;pub use envelope::EnvelopeCache;pub use envelope::InputFormat;pub use envelope::Page;pub use envelope::ResultBlock;pub use error::DetectionCandidate;pub use error::FaceError;pub use error::SkipReason;pub use error::SkipReport;pub use format::OutputFormat;pub use format::RenderOptions;pub use format::render;pub use input::ItemsOptions;pub use input::ParseOptions;pub use input::ParsedInput;pub use input::parse;pub use input::parse;pub use input::parse_with_columns;pub use input::parse_with_columns_and_options;pub use input::sniff_format;pub use record::Record;pub use strategy::Axis;pub use strategy::SimilarAlgorithm;pub use strategy::Strategy;
Modules§
- cluster
- Nested and flat cluster representations and conversions between them.
- cluster_
id - Cluster identifiers (§6.1 of
docs/design.md). - cluster_
tree - Execution coordinator: walks an
AxisPlanand dispatches to the per-strategy clusterers, recursing onwithinfor two-axis (and deeper) nesting (§5.5). - detect
- Auto-detection of score field, preset distribution shape, and per-axis strategy.
- diagnostics
- Side channel for non-fatal events emitted during clustering (§11.1).
- envelope
- Top-level JSON envelope for
--format=jsonoutput (§7). - error
- Error types and per-record skip reporting for the face core surface.
- format
- Output rendering for the seven
--format=styles (§8 ofdocs/design.md). - input
- Input pipeline: format sniffing, parsing, and §4.2 items detection.
- path
- jq-like path resolution against
serde_json::Value. - record
- One concrete record passed into clustering.
- strategy
- Grouping axes and per-axis strategies (§5 and §7’s
result.axes[]).