ironflow_engine/
lib.rs

1//! # ironflow-engine
2//!
3//! Workflow orchestration engine for **ironflow**.
4//!
5//! Workflows are defined as Rust-native handlers implementing
6//! [`WorkflowHandler`](handler::WorkflowHandler). Handlers receive a
7//! [`WorkflowContext`](context::WorkflowContext) and can chain step outputs,
8//! use native `if`/`else`/`match` for conditional branching, and execute
9//! steps in parallel.
10//!
11//! Handlers can be executed inline or enqueued for a background worker.
12//!
13//! ## Custom operations
14//!
15//! Implement [`Operation`](operation::Operation) to define custom step types
16//! (e.g. GitLab, Gmail, Slack) that integrate into the workflow lifecycle.
17//! Call [`WorkflowContext::operation()`](context::WorkflowContext::operation)
18//! inside a handler to execute them with full step tracking.
19//!
20//! ## Testing handlers
21//!
22//! [`TestEngine`](testing::TestEngine) runs a handler against an in-memory
23//! store with mocked shell, HTTP, agent and approval steps, so a handler's
24//! logic can be asserted without a server, a worker or a real process.
25//!
26//! # Example
27//!
28//! ```no_run
29//! use ironflow_engine::prelude::*;
30//! use std::future::Future;
31//! use std::pin::Pin;
32//!
33//! struct DeployWorkflow;
34//!
35//! impl WorkflowHandler for DeployWorkflow {
36//!     fn name(&self) -> &str { "deploy" }
37//!     fn execute<'a>(&'a self, ctx: &'a mut WorkflowContext) -> HandlerFuture<'a> {
38//!         Box::pin(async move {
39//!             let build = ctx.shell("build", ShellConfig::new("cargo build")).await?;
40//!             ctx.agent("review", AgentStepConfig::new(
41//!                 &format!("Review: {}", build.stdout())
42//!             )).await?;
43//!             Ok(())
44//!         })
45//!     }
46//! }
47//! ```
48
49// The derives of `ironflow-engine-macros` expand to `::ironflow_engine::...`; this
50// lets the crate's own tests and doc examples use them too.
51extern crate self as ironflow_engine;
52
53/// Engine version, compiled from `Cargo.toml` at build time.
54pub const VERSION: &str = env!("CARGO_PKG_VERSION");
55
56pub mod artifact;
57pub mod budget;
58pub mod config;
59pub mod context;
60pub mod decision;
61pub mod engine;
62pub mod error;
63pub mod escalation;
64pub mod executor;
65pub mod fsm;
66pub mod guard;
67pub mod handler;
68pub mod log_sender;
69pub mod notify;
70pub mod operation;
71pub mod plan;
72pub mod replay_policy;
73pub mod retry_policy;
74pub mod run_creator;
75pub mod schedule;
76pub mod testing;
77
78/// Convenience re-exports.
79pub mod prelude {
80    pub use crate::artifact::{ArtifactSink, ArtifactUpload, DirectArtifactSink};
81    pub use crate::budget::BudgetConfig;
82    pub use crate::config::{
83        AgentStepConfig, ApprovalConfig, Approvers, DelayConfig, EscalationPolicy, HttpConfig,
84        HumanInputConfig, NotificationTarget, ShellConfig, StepConfig,
85    };
86    pub use crate::context::WorkflowContext;
87    pub use crate::engine::{Engine, EnqueueOptions, ExecutionMode, WorkflowResult};
88    pub use crate::error::EngineError;
89    pub use crate::executor::StepResult;
90    pub use crate::fsm::{RunEvent, RunFsm, StepEvent, StepFsm};
91    pub use crate::guard::{WorkflowGuardConfig, WorkflowGuardState, WorkflowRejection};
92    pub use crate::handler::{HandlerFuture, WorkflowHandler};
93    pub use crate::notify::{
94        Event, EventPublisher, EventSubscriber, WebhookSubscriber, WorkflowEvent, WorkflowEventBus,
95    };
96    pub use crate::operation::{
97        NoopSecretResolver, Operation, OperationContext, SecretResolver, SecretValue,
98        TypedOperation,
99    };
100    pub use crate::plan::{ConditionResult, ExecutionPlan, PlanOptions, PlannedStep};
101    pub use crate::run_creator::{CreateRunOpts, RunCreator};
102    pub use crate::schedule::CronSchedule;
103}
ironflow_engine/lib.rs

ironflow_engine/
lib.rs
