Skip to main content

Module engine

Module engine 

Source
Expand description

Formualizer Dependency Graph Engine

Provides incremental formula evaluation with dependency tracking.

Re-exports§

pub use arena::AstNodeId;
pub use cancel::CancelToken;
pub use eval::CycleTelemetry;
pub use eval::Engine;
pub use eval::EngineAction;
pub use eval::EngineBaselineStats;
pub use eval::EvalResult;
pub use eval::RecalcPlan;
pub use eval::TableMetadata;
pub use eval::VirtualDepTelemetry;
pub use eval_delta::DeltaMode;
pub use eval_delta::EvalDelta;
pub use eval_delta::EvalDeltaCompatibilityPolicy;
pub use eval_delta::EvalDeltaRecord;
pub use eval_delta::TARGET_EVAL_DELTA_VERSION;
pub use eval_delta::TargetEvalDelta;
pub use formula_ingest::FormulaIngestBatch;
pub use formula_ingest::FormulaIngestRecord;
pub use formula_ingest::FormulaIngestReport;
pub use journal::ActionJournal;
pub use journal::ArrowOp;
pub use journal::ArrowUndoBatch;
pub use journal::GraphUndoBatch;
pub use graph::snapshot::VertexSnapshot;
pub use graph::ChangeEvent;
pub use graph::DependencyGraph;
pub use graph::DependencyRef;
pub use graph::GraphBaselineStats;
pub use graph::OperationSummary;
pub use graph::StripeKey;
pub use graph::StripeType;
pub use graph::block_index;
pub use resource_ledger::AdmissionResourceBudget;
pub use resource_ledger::DeadlineResourceBudget;
pub use resource_ledger::DiskScratchPolicy;
pub use resource_ledger::EvaluationBudgets;
pub use resource_ledger::EvaluationIncompleteReason;
pub use resource_ledger::EvaluationResourceConfigDiagnostic;
pub use resource_ledger::LegacyResourceConfigDisposition;
pub use resource_ledger::OptimizationResourceBudget;
pub use resource_ledger::ResourceEnvelope;
pub use resource_ledger::ResourceLedgerError;
pub use resource_ledger::ResourceLedgerSnapshot;
pub use resource_ledger::RetainedResourceBudget;
pub use resource_ledger::ScratchResourceBudget;
pub use resource_ledger::SemanticResourceBudget;
pub use resource_ledger::WorkResourceBudget;
pub use resource_observability::EvaluationRequestKind;
pub use resource_observability::EvaluationRequestOutcome;
pub use resource_observability::EvaluationRequestPhaseTimings;
pub use resource_observability::EvaluationResourceBaselineStats;
pub use resource_observability::EvaluationResourceClass;
pub use resource_observability::EvaluationResourceLedgerRequestStats;
pub use resource_observability::EvaluationResourceReason;
pub use resource_observability::EvaluationResourceRequestStats;
pub use resource_observability::FormulaDirtyLeaseOutcome;
pub use resource_observability::FormulaPlaneRoute;
pub use resource_observability::FormulaPlaneRouteEvent;
pub use resource_observability::FormulaPlaneRoutePhase;
pub use resource_observability::FormulaPlaneRouteTransitionReason;
pub use resource_observability::FormulaPlaneTopologyCacheOutcome;
pub use resource_observability::FormulaPlaneTopologyRequestStats;
pub use resource_observability::FormulaPlaneTopologyStrategy;
pub use row_visibility::RowVisibilitySource;
pub use row_visibility::VisibilityMaskMode;
pub use scheduler::Layer;
pub use scheduler::Schedule;
pub use scheduler::ScheduleUnit;
pub use scheduler::Scheduler;
pub use vertex::VertexId;
pub use vertex::VertexKind;
pub use graph::editor::DataUpdateSummary;
pub use graph::editor::EditorError;
pub use graph::editor::MetaUpdateSummary;
pub use graph::editor::RangeSummary;
pub use graph::editor::ShiftSummary;
pub use graph::editor::TransactionId;
pub use graph::editor::VertexDataPatch;
pub use graph::editor::VertexEditor;
pub use graph::editor::VertexMeta;
pub use graph::editor::VertexMetaPatch;
pub use graph::editor::change_log::ChangeLog;
pub use graph::editor::change_log::ChangeLogger;
pub use graph::editor::change_log::NullChangeLogger;

Modules§

arena
arrow_ingest
cancel
Cooperative cancellation for engine calls.
csr_edges
debug_views
delta_edges
effects
Formal effects pipeline for evaluation (ticket 603).
eval
eval_delta
formula_ingest
graph
ingest
ingest_builder
inspect
Read-only, engine-native workbook introspection.
interval_tree
journal
Internal action journal types used for atomicity and undo/redo.
live_edges
Live-edge collection for statically-cyclic SCC evaluation (Stage 1 of the runtime-cycle-verdicts work; pre-work for RFC #112).
live_graph
Local SCC analysis over a recorded live-edge list (Stage 2 of the runtime-cycle-verdicts work, RFC #112).
lookup_index_cache
named_range
plan
range_view
resource_ledger
resource_observability
row_visibility
scheduler
sheet_index
sheet_registry
spill
Spill interfaces (shim) for reserve/write/commit/rollback lifecycle. Phase 2: Introduce types only; implementation can delegate to current graph methods.
topo
Dynamic topological ordering utilities
tuning
Warmup configuration and tuning parameters
vertex
vertex_store
virtual_deps

Structs§

CycleConfig
Cycle handling configuration (spec: formualizer-cycle-semantics-spec.md §2).
EvalConfig
Configuration for the evaluation engine
FormulaParseDiagnostic
Captured diagnostic for a malformed formula encountered during ingest/graph-build.
PreparationRevision
PreparedTargetGraphReport
ResourceExhaustionDetail
Binding-safe typed resource exhaustion payload.
SpillConfig
Configuration for spill behavior. Nested under EvalConfig to avoid bloating the top-level.
TargetEvalOptions
Controls that apply to a whole target evaluation: preparation and evaluation. Cancellation and the deadline are hoisted onto the engine for the duration of the call, so every checkpoint in both phases observes them.
TombstoneRegistry
WorkbookLoadLimits
Workbook ingest limits applied by loader backends before they materialize large sheets.

Enums§

CycleDetection
How statically-cyclic SCCs are treated at evaluation time.
CyclePolicy
What happens to witnessed (live) cycles under CycleDetection::Runtime.
DateSystem
DeterministicMode
Deterministic evaluation configuration.
EvaluationTarget
FormulaParsePolicy
Policy for handling malformed formulas encountered during workbook ingest.
FormulaPlaneMode
FormulaSpoolDiskPolicy
Storage policy for the private formula replay spool used while loading workbooks.
OpaquePreparePolicy
OpaqueReason
PreparationOutcome
PrepareScope
ResourceExhaustionReason
Stable reason for a resource exhaustion diagnostic.
SheetIndexMode
SpillBoundsPolicy
SpillBufferMode
SpillCancellationPolicy
SpillConflictPolicy
SpillTiebreaker
SpillVisibility
TableSelection

Traits§

CalcObserver
🔮 Scalability Hook: Performance monitoring trait for calculation observability

Functions§

new_engine
Construct a new engine with the given resolver and configuration

Type Aliases§

PrepareTargetsOptionsDeprecated
Former name of TargetEvalOptions. The struct governs the whole call, not only preparation, so it was renamed before the name was frozen by a release.
RequestId