zrx_stream/stream/combinator/tuple/convert.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 tuple conversions.
27
28use zrx_scheduler::{Id, Value};
29
30use crate::stream::combinator::convert::IntoStreamTupleCons;
31use crate::stream::Stream;
32
33mod join;
34
35pub use join::IntoJoin;
36
37// ----------------------------------------------------------------------------
38// Implementations
39// ----------------------------------------------------------------------------
40
41impl<I, T> Stream<I, T>
42where
43 I: Id,
44 T: Value,
45{
46 /// Joins the stream with a tuple of streams.
47 #[inline]
48 pub fn join<S, O>(&self, streams: S) -> Stream<I, O::Output>
49 where
50 S: IntoStreamTupleCons<I, T, Output = O>,
51 O: IntoJoin<I>,
52 {
53 streams // fmt
54 .into_stream_tuple_cons(self.clone())
55 .into_join()
56 }
57}