blazen-core 0.1.120

Core workflow engine for Blazen - event-driven, async, pausable workflows
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

//! # `Blazen` Core
//!
//! The workflow engine at the heart of the `Blazen` framework.
//!
//! This crate provides:
//!
//! - [`Context`] -- shared, typed key/value state accessible by all steps.
//! - [`StepFn`] / [`StepOutput`] / [`StepRegistration`] -- step definition
//!   primitives.
//! - [`WorkflowBuilder`] / [`Workflow`] -- fluent construction and execution
//!   of event-driven workflows.
//! - [`WorkflowHandler`] -- handle for awaiting results and streaming
//!   intermediate events.
//! - [`WorkflowError`] -- comprehensive error type for everything that can
//!   go wrong during workflow execution.
//!
//! # Architecture
//!
//! A workflow is a directed graph of *steps*. Each step declares which event
//! types it accepts and what it may emit. The runtime maintains an internal
//! event queue; when an event arrives, the engine looks up matching step
//! handlers and spawns them concurrently. Step outputs are fed back into the
//! queue until a [`StopEvent`](blazen_events::StopEvent) terminates the
//! loop.

pub mod builder;
pub mod context;
pub mod error;
pub(crate) mod event_loop;
pub mod handler;
pub mod session_ref;
pub mod snapshot;
pub mod step;
pub mod value;
pub mod workflow;

pub use builder::{InputHandlerFn, WorkflowBuilder};
pub use context::Context;
pub use error::{Result, WorkflowError};
pub use handler::WorkflowHandler;
pub use session_ref::{
    RegistryKey, SESSION_REF_TAG, SessionPausePolicy, SessionRefError, SessionRefRegistry,
};
pub use snapshot::{SerializedEvent, WorkflowSnapshot};
pub use step::{StepFn, StepOutput, StepRegistration};
pub use value::{BytesWrapper, StateValue};
pub use workflow::Workflow;