zrx_stream/
stream.rs

1// Copyright (c) 2025-2026 Zensical and contributors
2
3// SPDX-License-Identifier: MIT
4// All contributions are certified under the 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//! Stream.
27
28use std::marker::PhantomData;
29
30use zrx_scheduler::{Id, Value};
31
32pub mod barrier;
33pub mod combinator;
34pub mod function;
35pub mod operator;
36pub mod value;
37pub mod workspace;
38
39use function::InspectFn as ForEachFn;
40use workspace::Workflow;
41
42// ----------------------------------------------------------------------------
43// Structs
44// ----------------------------------------------------------------------------
45
46/// Stream.
47#[derive(Debug)]
48pub struct Stream<I, T> {
49    /// Identifier.
50    id: usize,
51    /// Associated workflow.
52    workflow: Workflow<I>,
53    /// Capture types.
54    marker: PhantomData<T>,
55}
56
57// ----------------------------------------------------------------------------
58// Implementations
59// ----------------------------------------------------------------------------
60
61impl<I, T> Stream<I, T>
62where
63    I: Id,
64    T: Value + Clone,
65{
66    pub fn for_each<F>(&self, f: F)
67    where
68        F: ForEachFn<I, T> + Clone,
69    {
70        self.inspect(f);
71    }
72}
73
74// ----------------------------------------------------------------------------
75// Trait implementations
76// ----------------------------------------------------------------------------
77
78impl<I, T> Clone for Stream<I, T> {
79    /// Clones the stream.
80    #[inline]
81    fn clone(&self) -> Self {
82        let workflow = self.workflow.clone();
83        Self { workflow, ..*self }
84    }
85}
86
87// ----------------------------------------------------------------------------
88
89impl<I, T> PartialEq for Stream<I, T> {
90    /// Compares two streams for equality.
91    #[inline]
92    fn eq(&self, other: &Self) -> bool {
93        self.id == other.id
94    }
95}
96
97impl<I, T> Eq for Stream<I, T> {}
zrx_stream/stream.rs

zrx_stream/
stream.rs
