Expand description
Native ProofFrame engine for Arrow-backed data contracts.
The crate exposes a Rust-native API by default. The Python extension module is available behind
the python feature and is enabled by the PyPI build configuration. Core invariants are stable
enough for the stable 0.6.0 release: versioned canonical dataset fingerprints, compiled relational
and dataset contracts, disk-backed exact state, deterministic partitions, and signed evidence.
Modules§
- evidence
- Strict, versioned evidence envelopes binding data, execution and result claims.
- receipt
- Ed25519-signed proof receipts over canonical JSON reports.
Structs§
- Assertion
Ast - Balance
Equal Ast - Require two numeric columns to total the same amount.
- Balance
Equal Plan - Two numeric columns that must total the same amount.
- Cancellation
Token - Cooperative cancellation shared across cloned operation handles.
- Changed
Row - A row present in both datasets whose values changed.
- Column
Contract - Rule set applied to a single column during validation.
- Column
Plan - One schema-resolved column in the execution intermediate representation.
- Column
Profile - Per-column summary produced while profiling a dataset.
- Compare
Ast - Compare
Plan - Compiled
Contract - Contract execution IR compiled in Arrow schema order.
- Compiled
Rules - Semantically checked rules ready for typed execution.
- Composite
Unique Ast - Composite
Unique Plan - Conditional
Unique Ast - Uniqueness among the rows a condition selects.
- Conditional
Unique Plan - Uniqueness among the rows a predicate selects.
- Contract
- Validation contract: per-column rules plus a bound on emitted findings.
- Contract
Ast - Strict, versioned syntax tree parsed from a ProofFrame contract document.
- Contract
AstV2 - Count
Plan - Count
Range Ast - Dataset
Plan - Dataset
Rules Ast - Diff
Metrics - Diff
Options - Diff
Report - Exact keyed diff between two datasets.
- Dominant
Value Ast - Bound the share of a column held by its most common value.
- Dominant
Value Plan - The largest share of a column one value may hold.
- Duplicate
Sample - Exact
Metrics - Exact
State - Exact
Summary - Execution
Metrics - Accounted engine state for a compiled validation execution.
- Execution
Options - Execution hints that do not alter contract semantics.
- Fast
Validation Report - Rules-only validation result that skips profiling and fingerprinting.
- Finding
- A single rule violation with bounded, row-level evidence.
- Fingerprint
- Typed canonical digest with its algorithm version and row count.
- Fingerprint
Options - Inputs that affect canonical fingerprint semantics.
- GapDetection
Ast - Require consecutive values to stay within one step of each other.
- GapDetection
Plan - A resolved step rule: which column, how far apart consecutive values may be, and the unit that distance is measured in.
- Leakage
Options - Leakage
Report - Train/test overlap result that exposes only hashed sample identifiers.
- Memory
Reservation - RAII charge for engine-owned memory.
- Monotonicity
Ast - Require a column to move in one direction as the dataset is read in order.
- Monotonicity
Plan - A resolved ordering rule: which column, which direction, and what a null means.
- Mutually
Exclusive Ast - Require that a row fills at most one, or exactly one, of a set of columns.
- Mutually
Exclusive Plan - A resolved exclusivity rule: which columns, and how many of them may be filled.
- PiiFinding
- A single PII detection that never carries the matched value.
- PiiFingerprint
Options - Secret-bearing scan configuration. The key is deliberately never serializable.
- PiiReport
- Aggregated PII scan result with bounded per-cell findings.
- Profile
- Deterministic dataset profile with a canonical content fingerprint.
- Ratio
Plan - Ratio
Range Ast - Reference
Ast - Every local key must also appear in a named reference dataset.
- Reference
Bindings - Reference datasets supplied for one execution, keyed by their contract name.
- Reference
Outcome - What a single reference rule was checked against.
- Reference
Plan - One resolved referential integrity rule.
- Resource
Account - A node in a resource hierarchy. Reservations charge this node and every ancestor.
- Resource
Limits - Hard limits shared by validation, distinct, diff and evidence operations.
- RowCount
Delta Ast - Bound how far this dataset’s row count may move from a reference dataset’s.
- RowCount
Delta Plan - How far this dataset’s row count may move from a reference dataset’s.
- RowPlan
- RowRule
Ast - RuleAst
- Syntax-level rule set for one named column.
- Rule
AstV2 - Statistic
Ast - Bound a summary statistic of a numeric column.
- Statistic
Plan - A resolved statistic rule.
- Suggest
Options - Controls which potentially expensive or brittle rules are included in a suggestion.
- SumAst
- Bound the total of a numeric column.
- SumPlan
- A resolved total rule.
- Temp
Reservation - RAII charge for operation-owned temporary storage.
- Validation
Report - Full validation result: findings plus the dataset profile and fingerprint.
Enums§
- Bound
Ast - Exact source literal for a numeric, decimal, or timestamp bound.
- Compare
OpAst - Composite
Null Policy Ast - Contract
Document - Contract
Version - Version of the serialized contract language.
- Diff
Output - Distinct
Mode - Exact distinct counting can dominate large profiles, so callers can opt out.
- Error
Code - Stable machine-readable category for every ProofFrame failure.
- Exclusive
Mode Ast - Fingerprint
Version - Canonical fingerprint algorithm selected for an operation.
- Kernel
Kind - Arrow-specialized kernel selected once during contract compilation.
- Monotonic
Direction Ast - Monotonic
Null Policy Ast - What a null means for an ordering rule.
- NaNPolicy
- Runtime NaN behavior compiled for floating-point kernels.
- NaNPolicy
Ast - Source-level floating-point NaN policy.
- Null
Policy Ast - Operand
Ast - Operand
Plan - Parameterized
Type Ast - PiiFingerprint
Mode - Linkability policy for redacted PII value fingerprints.
- Primitive
Type Ast - Proof
Frame Error - Errors returned by ProofFrame profiling, validation, diffing, and receipts.
- Reference
Null Policy Ast - Null handling for the local key of a referential integrity rule.
- RowPlan
Kind - Scalar
Value Plan - Spill
Policy - Policy for exact-state overflow during a keyed diff.
- Statistic
Kind - Which summary a statistic rule bounds.
- SumBounds
- Whether a column’s total is counted exactly or with floating-point compensation, and the bounds it must stay inside.
- Time
Unit Ast - TypeAst
- Typed
Bound - Exact semantic value used by compiled range checks.
- Value
Kind - Value
Ref
Functions§
- check_
partition_ readers - Validate ordered Arrow partitions with bounded native workers.
- check_
partition_ readers_ with_ evidence - Validate ordered partitions and bind each partition fingerprint into a manifest.
- check_
partition_ readers_ with_ evidence_ and_ references - Bind partition fingerprints into a manifest while resolving reference rules.
- check_
partition_ readers_ with_ references - Validate ordered partitions whose reference rules resolve against
references. - detect_
leakage_ readers - Detect train/test row or key leakage between two Arrow readers.
- detect_
leakage_ with_ options - diff_
readers - Compute an exact keyed diff between two Arrow readers.
- diff_
readers_ with_ options - execute_
reader - Execute a compiled contract without reparsing or performing rule-map lookups.
- execute_
reader_ with_ fingerprint - Execute validation and compute the V2 dataset fingerprint from the same batch traversal.
- execute_
reader_ with_ fingerprint_ and_ references - Validate, fingerprint, and resolve reference rules from the same batch traversal.
- execute_
reader_ with_ references - Execute a compiled contract whose reference rules resolve against
references. - fingerprint_
reader - Return only the canonical dataset fingerprint, without profiling or exact distinct state.
- fingerprint_
reader_ with_ options - Return a typed canonical fingerprint using an explicitly selected version.
- profile_
reader - Profile Arrow record batches and return typed Rust metadata.
- profile_
reader_ in_ memory - Profile without a spill target, for a filesystem that cannot be written to.
- profile_
reader_ with_ distinct - Profile Arrow record batches with configurable exact distinct counting.
- profile_
reader_ with_ resources - Profile with a hard resource budget for optional exact distinct state.
- profile_
reader_ with_ resources_ and_ hint - Profile with hard resource budgets and an exact, non-consuming row-count hint.
- review_
html - The offline HTML review for one validation and fingerprint scan.
- review_
markdown - The Markdown summary written for a CI job summary or a pull request.
- scan_
pii_ reader - Scan Arrow record batches for high-signal PII patterns.
- scan_
pii_ reader_ with_ options - Scan for PII using an explicit linkability and key-management policy.
- suggest_
reader_ with_ options - Suggest a strict V2 contract from one Arrow stream without materializing it.
- validate_
fast_ reader - Validate Arrow record batches with the rules-only fast path.
- validate_
reader - Validate Arrow record batches with the full profiling path.
Type Aliases§
- Partition
Reader - One independently consumable Arrow stream in a logical dataset partition.