zrx_module/module/context.rs
1// Copyright (c) 2025-2026 Zensical and contributors
2
3// SPDX-License-Identifier: MIT
4// Third-party contributions licensed under DCO
5
6// Permission is hereby granted, free of charge, to any person obtaining a copy
7// of this software and associated documentation files (the "Software"), to
8// deal in the Software without restriction, including without limitation the
9// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10// sell copies of the Software, and to permit persons to whom the Software is
11// furnished to do so, subject to the following conditions:
12
13// The above copyright notice and this permission notice shall be included in
14// all copies or substantial portions of the Software.
15
16// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
19// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
22// IN THE SOFTWARE.
23
24// ----------------------------------------------------------------------------
25
26//! Context.
27
28use zrx_id::Id;
29use zrx_stream::workflow::Builder;
30use zrx_stream::{Stream, Value, Workflow};
31
32// ----------------------------------------------------------------------------
33// Structs
34// ----------------------------------------------------------------------------
35
36/// Context.
37#[derive(Default)]
38pub struct Context {
39 /// Workflow builder.
40 builder: Builder<Id>,
41}
42
43// ----------------------------------------------------------------------------
44// Implementations
45// ----------------------------------------------------------------------------
46
47impl Context {
48 /// Adds a stream to the context.
49 #[must_use]
50 pub fn add<T>(&self) -> Stream<Id, T>
51 where
52 T: Value,
53 {
54 self.builder.add()
55 }
56}
57
58// ----------------------------------------------------------------------------
59// Trait implementations
60// ----------------------------------------------------------------------------
61
62impl From<Context> for Workflow<Id> {
63 /// Creates a workflow from a context.
64 #[inline]
65 fn from(context: Context) -> Self {
66 context.builder.build().expect("invariant")
67 }
68}