batchflow_core/lib.rs
1//! # BatchFlow Core
2//!
3//! Core traits and the execution engine for [BatchFlow](https://crates.io/crates/batchflow),
4//! a production-grade batch processing framework for Rust, inspired by
5//! [Spring Batch](https://spring.io/projects/spring-batch) but designed around
6//! idiomatic Rust: traits, ownership, `Result`-based error handling, and an
7//! async-first execution engine.
8//!
9//! This crate holds the framework's heart — the `ItemReader` / `ItemProcessor`
10//! / `ItemWriter` abstractions, the chunk-oriented execution engine, and the
11//! metadata model. Storage backends, observability, and I/O adapters live in
12//! sibling crates.
13//!
14//! ## Status
15//!
16//! **Under active development.** The API is unstable and being built out phase
17//! by phase. Not yet usable as a batch framework.
18#![forbid(unsafe_code)]
19
20// Phase 2 lands here: `BatchError`, the `ItemReader` / `ItemProcessor` /
21// `ItemWriter` traits (associated types — see ADR-003), and `read_chunk`.