Skip to main content

Crate pureflow

Crate pureflow 

Source
Expand description

Pureflow — a flow-based programming (FBP) workflow engine for building concurrent data pipelines.

§Feature flags

FeatureEnables
wasmWasmtime-backed WASM batch node execution
introspectionRead-only workflow introspection with JSON serialization
tracingtracing crate integration for runtime observability
arrowApache Arrow columnar data support in message payloads
tomlTOML workflow definition parser
yamlYAML workflow definition parser
fullAll of the above

§Modules

The full API surface of each internal crate is re-exported under a matching module. Use the flat top-level re-exports for the most common items, and reach into the modules for anything more specific.

Modules§

contract
Node contract metadata and port-level validation.
core
Core traits and contracts for node implementors.
engine
Workflow execution engine: run policies, registries, and entry points.
format
Workflow definition parsers (JSON always; TOML and YAML behind features).
runtime
Low-level async runtime that backs the engine.
types
Identifier types shared across Pureflow.
workflow
Workflow structure: nodes, edges, and graph validation.

Structs§

BatchNodeExecutor
Node executor adapter for host-owned batch implementations such as WASM.
CancellationHandle
Runtime-owned handle that can request cancellation for shared contexts.
CancellationToken
Read-only cancellation view carried by a node execution context.
EdgeDefinition
Directed connection from one output port to one input port.
EdgeEndpoint
Static endpoint for one side of a workflow edge.
ExecutionError
Runtime execution failure from a node.
ExecutionId
Stable identifier for one workflow execution.
LifecycleError
Failure while recording or reacting to a lifecycle event.
MessageId
Stable identifier for one message envelope.
NodeContract
Contract metadata for one node.
NodeDefinition
Static node declaration and its input/output port topology.
NodeId
Stable node identifier inside a workflow graph.
PortContract
Contract-side declaration for one node port.
PortId
Stable port identifier on a node.
PortsIn
Declared input ports available to a node execution boundary.
PortsOut
Declared output ports available to a node execution boundary.
StaticNodeExecutorRegistry
In-memory registry keyed by workflow node identifier.
WorkflowDefinition
Parsed workflow definition independent of runtime execution.
WorkflowId
Stable workflow identifier.
WorkflowRunPolicy
Runtime policy for executing one workflow graph.
WorkflowRunSummary
Aggregate outcome for one workflow run.

Enums§

Determinism
Contract-level determinism declaration.
ExecutionMode
Declared execution mode for one node contract.
IdentifierError
Error returned when an identifier is malformed.
PacketPayload
Packet payload carried over runtime ports.
PortDirection
Direction of a port in a node’s static topology.
PureflowError
Shared runtime-facing error for the Pureflow foundation layer.
WorkflowTerminalState
Terminal state for one workflow run.
WorkflowValidationError
Error returned when a workflow graph is structurally invalid.

Traits§

NodeExecutor
Async node interface for the first runtime skeleton.

Functions§

run_workflow_with_registry_policy_summary
Execute the workflow through a registry with an explicit run policy.
run_workflow_with_registry_summary
Execute the workflow by resolving one executor for each node from a registry.

Type Aliases§

PortPacket
Default packet payload for the first channel-backed port surface.
Result
Shared result type for runtime-facing APIs.