obzenflow_runtime 0.2.4

Runtime services for ObzenFlow - execution and coordination business logic
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

// SPDX-License-Identifier: MIT OR Apache-2.0
// SPDX-FileCopyrightText: 2025-2026 ObzenFlow Contributors
// https://obzenflow.dev

#![doc = include_str!("../README.md")]

// Core modules
pub mod backpressure;
pub mod bootstrap;
pub mod contracts;
pub mod control_plane;
pub mod effects;
pub mod errors;
pub mod execution;
pub mod feed_plan;
pub mod id_conversions;
pub mod message_bus;
pub mod replay;
pub mod run_context;
pub mod runtime_config;
pub mod runtime_resource_limits;
pub mod supervised_base;
pub mod typing;

// Major subsystems
pub mod messaging;
pub mod metrics;
pub mod pipeline;
pub mod stages;

/// Internal cross-crate integration for the framework, DSL and supervisor tests.
/// This namespace is not a supported application API.
/// Authored joins use [`stages::TypedJoinHandler`] instead.
#[doc(hidden)]
pub mod __private {
    pub mod lifecycle;

    // Public macros resolve through this narrow hygiene surface without
    // re-exporting Core itself as an alternate authoring gateway.
    pub use crate::stages::common::handlers::join::{
        ErasedJoinInvocation, TypedJoinHandlerAdapter, UnifiedJoinHandler,
    };
    pub use crate::stages::common::handlers::sink::SinkWriterAdapter;
    pub use crate::stages::common::handlers::source::typed::{
        TypedAsyncFiniteSourceHandlerAdapter, TypedAsyncInfiniteSourceHandlerAdapter,
        TypedFiniteSourceHandlerAdapter, TypedInfiniteSourceHandlerAdapter,
    };
    pub use crate::stages::common::handlers::source::{
        ErasedSourceCompletion, ErasedSourceInvocation, ErasedSourceOutcome,
        UnifiedAsyncFiniteSourceHandler, UnifiedAsyncInfiniteSourceHandler,
        UnifiedFiniteSourceHandler, UnifiedInfiniteSourceHandler,
    };
    pub use obzenflow_core::event::schema::{EmptySet, WithMember};
}

#[cfg(any(test, feature = "test-support"))]
pub mod testing;

/// Convenience re-exports of the most commonly used runtime types.
///
/// The prelude gathers types that almost every flow definition or stage
/// implementation needs, grouped into five categories:
///
/// **Errors** — [`FlowError`](crate::errors::FlowError),
/// [`MessageBusError`](crate::errors::MessageBusError),
/// [`PipelineSupervisorError`](crate::errors::PipelineSupervisorError),
/// and the [`RuntimeResult`](crate::errors::RuntimeResult) type alias.
///
/// **Pipeline** —
/// [`PipelineBuilder`](crate::pipeline::PipelineBuilder) and
/// [`PipelineStageConfig`](crate::pipeline::PipelineStageConfig) for
/// constructing flows,
/// [`FlowHandle`](crate::pipeline::FlowHandle) for controlling a running
/// pipeline, and
/// [`PipelineState`](crate::pipeline::PipelineState) for latest-state observation,
/// and [`PipelineControl`](crate::pipeline::PipelineControl) for submitting controls.
///
/// **Message bus** —
/// [`FsmMessageBus`](crate::message_bus::FsmMessageBus) (the inter-stage
/// transport) and
/// [`StageCommand`](crate::message_bus::StageCommand) (control signals
/// sent to individual stages).
///
/// **Handlers** — the user-facing handler traits:
/// [`TypedFiniteSourceHandler`](crate::stages::TypedFiniteSourceHandler),
/// [`TypedInfiniteSourceHandler`](crate::stages::TypedInfiniteSourceHandler),
/// [`TypedTransformHandler`](crate::stages::TypedTransformHandler),
/// [`SinkWriter`](crate::stages::SinkWriter),
/// [`TypedStatefulHandler`](crate::stages::TypedStatefulHandler),
/// [`TypedJoinHandler`](crate::stages::TypedJoinHandler),
/// [`ObserverHandler`](crate::stages::ObserverHandler), and the
/// [`ResourceManaged`](crate::stages::ResourceManaged) trait for stages
/// that own resources. Also includes
/// [`SourceError`](crate::stages::SourceError) for source-specific error
/// reporting.
///
/// **Event flow** —
/// [`UpstreamSubscription`](crate::messaging::UpstreamSubscription) for
/// wiring journal-based message delivery between stages.
pub mod prelude {
    // Errors
    pub use crate::errors::{FlowError, MessageBusError, PipelineSupervisorError, RuntimeResult};

    // Pipeline
    pub use crate::pipeline::{
        FlowHandle, FlowStopMode, ObserverConfig, PipelineBuilder, PipelineControl,
        PipelineStageConfig, PipelineState,
    };

    // Message bus
    pub use crate::message_bus::{FsmMessageBus, StageCommand};

    // Handlers
    pub use crate::stages::{
        EffectfulStatefulHandler, EffectfulTransformHandler, HostedIngressSource, InferenceHandler,
        IngressDecodeError, IngressDecoder, InlineSink, ObserverHandler, ResourceManaged,
        SinkConnector, SinkDescription, SinkWriter, SourceError, SourceObservationSink,
        TypedAsyncFiniteSourceHandler, TypedAsyncInfiniteSourceHandler, TypedFiniteSourceHandler,
        TypedInfiniteSourceHandler, TypedJoinHandler, TypedStatefulHandler, TypedTransformHandler,
    };
    pub use crate::typing::{SourceTyping, TransformTyping};

    // Event flow
    pub use crate::effects::{
        DomainFacts, Effect, EffectCommitHandle, EffectContext, EffectDeclaration, EffectError,
        EffectOutcomeKind, EffectOutcomePayload, EffectSafety, Effects, IdempotencyKey,
        RecordedReply, SinkRedeliverySafety, TransactionalEffectPort,
    };
    pub use crate::messaging::UpstreamSubscription;

    // Metrics
}