cloacina-workflow 0.6.1

Minimal types for authoring Cloacina workflows without runtime dependencies
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

/*
 *  Copyright 2025-2026 Colliery Software
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

//! # Cloacina Workflow - Minimal Types for Workflow Authoring
//!
//! This crate provides the minimal set of types needed to compile Cloacina workflows
//! without pulling in heavy runtime dependencies like database drivers.
//!
//! ## Purpose
//!
//! Workflow authors who only need to compile workflows can depend on this lightweight
//! crate instead of the full `cloacina` crate. This provides:
//!
//! - Faster compile times
//! - Smaller binary sizes
//! - Easier cross-compilation (no native database drivers)
//! - Clear separation between "authoring workflows" and "running workflows"
//!
//! ## Types Provided
//!
//! - [`Context`] - Data container for sharing values between tasks
//! - [`Task`] - Trait defining executable tasks
//! - [`TaskState`] - Task execution state enum
//! - [`TaskNamespace`] - Hierarchical task identification
//! - [`TaskError`], [`ContextError`], [`CheckpointError`] - Error types
//! - [`RetryPolicy`], [`BackoffStrategy`], [`RetryCondition`] - Retry configuration
//!
//! ## Usage
//!
//! ```rust
//! use cloacina_workflow::{Context, TaskError};
//!
//! // Create a context
//! let mut ctx = Context::<serde_json::Value>::new();
//! ctx.insert("key", serde_json::json!("value")).unwrap();
//!
//! // Access data
//! let value = ctx.get("key").unwrap();
//! ```
//!
//! ## With the Task Macro
//!
//! The macros are included by default, so you only need one import:
//!
//! ```rust,ignore
//! use cloacina_workflow::{task, packaged_workflow, Context, TaskError};
//!
//! #[task(id = "my_task", dependencies = [])]
//! async fn my_task(ctx: &mut Context<serde_json::Value>) -> Result<(), TaskError> {
//!     ctx.insert("result", serde_json::json!("done"))?;
//!     Ok(())
//! }
//! ```

pub mod context;
pub mod cron_evaluator;
pub mod error;
pub mod namespace;
pub mod retry;
pub mod task;
pub mod trigger;

// Re-export primary types at crate root for convenience
pub use context::Context;
pub use error::{CheckpointError, ContextError, TaskError};
pub use namespace::{parse_namespace, TaskNamespace};
pub use retry::{BackoffStrategy, RetryCondition, RetryPolicy, RetryPolicyBuilder};
pub use task::{Task, TaskState};
pub use trigger::{Trigger, TriggerError, TriggerResult};

// Re-export macros when the feature is enabled
#[cfg(feature = "macros")]
pub use cloacina_macros::{task, trigger, workflow};

/// Private re-exports used by generated macro code. Not part of the public API.
#[doc(hidden)]
#[cfg(feature = "macros")]
pub mod __private {
    pub use tokio;
}