floxide 3.2.2

A directed graph workflow system in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

# Tutorial: Floxide, an easy distributed workflow engine

Floxide is a workflow engine for Rust designed to make building and running **distributed** task sequences easy.
Think of it like a *digital assembly line* where different steps (**Nodes**) can run on different computers.
It uses a central **WorkQueue** to assign tasks to **Workers** and **Checkpointing** to recover from failures, making your workflows *scalable* and *fault-tolerant*.
An **Orchestrator** manages starting, stopping, and monitoring these distributed runs.


**Source Repository:** [None](None)

```mermaid
flowchart TD
    A0["Node Trait & node! Macro"]
    A1["Workflow Trait & workflow! Macro"]
    A2["Transition Enum"]
    A3["WorkflowCtx & Context Trait"]
    A4["Checkpoint & CheckpointStore Trait"]
    A5["WorkQueue Trait"]
    A6["DistributedWorker"]
    A7["DistributedOrchestrator"]
    A8["Distributed Stores (RunInfoStore, MetricsStore, ErrorStore, LivenessStore, WorkItemStateStore)"]
    A9["RetryPolicy & RetryNode"]
    A1 -- "Contains / Defines Flow Bet..." --> A0
    A0 -- "Returns Outcome As" --> A2
    A0 -- "Uses Shared Context" --> A3
    A9 -- "Wraps Node For Retries" --> A0
    A1 -- "Uses Workflow Context" --> A3
    A1 -- "Uses For Distributed State" --> A4
    A1 -- "Uses For Distributed Steps" --> A5
    A6 -- "Executes Workflow Step" --> A1
    A6 -- "Dequeues/Enqueues Work Items" --> A5
    A6 -- "Loads/Saves Checkpoints" --> A4
    A6 -- "Updates Run State/Metrics" --> A8
    A7 -- "Starts Distributed Run" --> A1
    A7 -- "Manages Run via Queue" --> A5
    A7 -- "Manages Run via Checkpoints" --> A4
    A7 -- "Queries Run State/Metrics" --> A8
    A1 -- "Applies Retry Policy (via m..." --> A9
    A9 -- "Uses Context for Delay" --> A3
```

## Chapters

1. [`Transition` Enum
](01__transition__enum_.md)
2. [`Node` Trait & `node!` Macro
](02__node__trait____node___macro_.md)
3. [`WorkflowCtx` & `Context` Trait
](03__workflowctx_____context__trait_.md)
4. [`Workflow` Trait & `workflow!` Macro
](04__workflow__trait____workflow___macro_.md)
5. [`WorkQueue` Trait
](05__workqueue__trait_.md)
6. [`Checkpoint` & `CheckpointStore` Trait
](06__checkpoint_____checkpointstore__trait_.md)
7. [`DistributedWorker`
](07__distributedworker__.md)
8. [`DistributedOrchestrator`
](08__distributedorchestrator__.md)
9. [Distributed Stores (`RunInfoStore`, `MetricsStore`, `ErrorStore`, `LivenessStore`, `WorkItemStateStore`)
](09_distributed_stores___runinfostore____metricsstore____errorstore____livenessstore____workitemstatestore___.md)
10. [`RetryPolicy` & `RetryNode`
](10__retrypolicy_____retrynode__.md)