zrx_stream/stream/combinator/set/ext.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 set extensions.
27
28use zrx_scheduler::{Id, Value};
29
30use crate::stream::Stream;
31
32use super::convert::IntoStreamSet;
33
34// ----------------------------------------------------------------------------
35// Traits
36// ----------------------------------------------------------------------------
37
38/// Extension of [`StreamSet`][].
39///
40/// Although, conceptually, this extension trait does belong to [`StreamSet`][],
41/// allowing to conveniently work with data types that can be converted into a
42/// set of streams, it is deliberately implemented for anything that converts
43/// via [`IntoStreamSet`], as this offers more flexibilty.
44///
45/// [`StreamSet`]: crate::stream::combinator::StreamSet
46pub trait StreamSetExt<I, T>: IntoStreamSet<I, T> + Sized
47where
48 I: Id,
49 T: Value + Clone + Eq,
50{
51 fn union(self) -> Option<Stream<I, T>> {
52 self.into_stream_set() // fmt
53 .into_union()
54 }
55
56 fn intersection(self) -> Option<Stream<I, T>> {
57 self.into_stream_set() // fmt
58 .into_intersection()
59 }
60
61 fn difference(self) -> Option<Stream<I, T>> {
62 self.into_stream_set() // fmt
63 .into_difference()
64 }
65
66 fn coalesce(self) -> Option<Stream<I, T>> {
67 self.into_stream_set() // fmt
68 .into_coalesce()
69 }
70}
71
72// ----------------------------------------------------------------------------
73// Blanket implementations
74// ----------------------------------------------------------------------------
75
76impl<'a, S, I, T> StreamSetExt<I, T> for S
77where
78 S: IntoIterator<Item = &'a Stream<I, T>>,
79 I: Id,
80 T: Value + Clone + Eq,
81{
82}