zrx-stream 0.0.22

Stream interface
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

// Copyright (c) 2025-2026 Zensical and contributors

// SPDX-License-Identifier: MIT
// All contributions are certified under the DCO

// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:

// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.

// ----------------------------------------------------------------------------

//! Stream tuple.

use crate::stream::Stream;

use zrx_scheduler::Value;

mod convert;
mod ext;

pub use ext::StreamTupleExt;

// ----------------------------------------------------------------------------
// Traits
// ----------------------------------------------------------------------------

/// Stream tuple construction.
///
/// This trait is used to prepend streams to existings stream tuples, which is
/// necessary to implement stream methods that take a tuple of streams, as they
/// need to be combined with the current stream (i.e. `self`) to construct a
/// stream tuple for further consumption.
pub trait StreamTupleCons<I, T> {
    /// Output type of construction.
    type Output;

    /// Prepends a stream to the stream tuple.
    ///
    /// This method is used to prepend a stream to the tuple and consume it,
    /// constructing a new stream tuple that includes the given stream.
    fn cons(head: Stream<I, T>, tail: Self) -> Self::Output;
}

// ----------------------------------------------------------------------------
// Macros
// ----------------------------------------------------------------------------

/// Implements stream tuple construction trait.
macro_rules! impl_stream_tuple_cons {
    ($T1:ident $(, $T:ident)* $(,)?) => {
        impl<I, $T1, $($T,)*> StreamTupleCons<I, $T1> for ($(Stream<I, $T>,)*)
        where
            $T1: Value,
            $($T: Value,)*
        {
            type Output = (Stream<I, $T1>, $(Stream<I, $T>,)*);

            #[inline]
            fn cons(head: Stream<I, $T1>, tail: Self) -> Self::Output {
                #[allow(non_snake_case)]
                let ($($T,)*) = tail;
                (head, $($T,)*)
            }
        }
    };
}

// ----------------------------------------------------------------------------

impl_stream_tuple_cons!(T1);
impl_stream_tuple_cons!(T1, T2);
impl_stream_tuple_cons!(T1, T2, T3);
impl_stream_tuple_cons!(T1, T2, T3, T4);
impl_stream_tuple_cons!(T1, T2, T3, T4, T5);
impl_stream_tuple_cons!(T1, T2, T3, T4, T5, T6);
impl_stream_tuple_cons!(T1, T2, T3, T4, T5, T6, T7);
impl_stream_tuple_cons!(T1, T2, T3, T4, T5, T6, T7, T8);