panproto-inst 0.13.0

Instance representation for panproto
Documentation

panproto-inst

crates.io docs.rs

Instance representation for panproto.

This crate provides three models for concrete data instances that conform to schemas defined via panproto-schema: tree-shaped W-type instances, relational set-valued functor instances, and graph-shaped instances. All three are unified under the Instance enum. The crate also handles JSON serialization, validation, and the full adjoint triple of instance transformations (restrict, extend, and right Kan extension).

API

Item Description
WInstance Tree-shaped (W-type) instance with nodes, arcs, and hyper-edge fans
FInstance Relational (set-valued functor) instance with tables and foreign keys
GInstance Graph-shaped instance with nodes and edges (cycles allowed, no root)
Instance Unified enum wrapping all three instance shapes
Node Metadata for a W-type instance node (anchor, value, position, annotations)
Value / FieldPresence Leaf values and field presence tracking
Fan Hyper-edge fan representation
parse_json / to_json Schema-guided JSON serialization round-trip
validate_wtype Axiom checking (I1–I7) for W-type instances
wtype_restrict 5-step restrict pipeline (ΔF) for W-type instances
wtype_extend Left Kan extension (ΣF) for W-type instances
wtype_pi Right Kan extension (ΠF) for injective migrations
functor_restrict / functor_extend Precomposition and left Kan extension for functor instances
functor_pi Right Kan extension for functor instances
graph_restrict Restrict pipeline for graph-shaped instances
CompiledMigration Pre-computed migration data for fast per-record application
FieldTransform Value-level operation on node extra_fields: rename, drop, add, keep, or apply expression
InstanceQuery / execute Declarative query engine: anchor selection, predicate filtering, path navigation, projection, grouping, limits
Complement / DroppedNode Complement data from restriction for backward migration
SectionEnrichment Enrichment specification for section construction
fiber_at_anchor / fiber_decomposition Polynomial functor operations: preimage of a migration at target anchors
fiber_at_node Instance-aware fiber at a specific target node
restrict_with_complement Restriction with complement tracking
section Section construction (right inverse of projection)
hom_schema / curry_migration / eval_hom Internal hom schema construction, currying, and evaluation
group_by / join Instance partitioning and pullback operations
eval_with_instance Instance-aware expression evaluation with graph traversal builtins (Edge, Children, HasEdge, EdgeCount, Anchor)
CompiledMigration::add_field_rename Builder: rename a field key on a vertex's nodes
CompiledMigration::add_field_drop Builder: drop a field from a vertex's nodes
CompiledMigration::add_field_default Builder: add a field with a default value
CompiledMigration::add_field_keep Builder: retain only specified fields
CompiledMigration::add_field_expr Builder: apply an expression to a field's value
Provenance / ProvenanceMap Data lineage tracking: which source fields contributed to each target field
SourceField / TransformStep Provenance detail: source references and transform chain steps
compute_provenance Build a provenance map from source/target nodes and a vertex remapping
InstError / ParseError / RestrictError Error types

Example

use panproto_inst::{parse_json, to_json, validate_wtype};

let instance = parse_json(&schema, "root_vertex", &json_value)?;
let errors = validate_wtype(&schema, &instance);
let round_tripped = to_json(&schema, &instance);

License

MIT