qubit_function/consumers/bi_consumer/
rc_conditional_bi_consumer.rs

1/*******************************************************************************
2 *
3 *    Copyright (c) 2025 - 2026 Haixing Hu.
4 *
5 *    SPDX-License-Identifier: Apache-2.0
6 *
7 *    Licensed under the Apache License, Version 2.0.
8 *
9 ******************************************************************************/
10// qubit-style: allow explicit-imports
11//! Defines the `RcConditionalBiConsumer` public type.
12
13use super::{
14    BiConsumer,
15    BiPredicate,
16    BoxBiConsumer,
17    RcBiConsumer,
18    RcBiPredicate,
19    impl_conditional_consumer_clone,
20    impl_conditional_consumer_conversions,
21    impl_conditional_consumer_debug_display,
22    impl_shared_conditional_consumer,
23};
24
25// =======================================================================
26// 9. RcConditionalBiConsumer - Rc-based Conditional BiConsumer
27// =======================================================================
28
29/// RcConditionalBiConsumer struct
30///
31/// A conditional bi-consumer that wraps an `RcBiConsumer` and only executes
32/// when a predicate is satisfied. Based on `Rc` for single-threaded shared ownership.
33///
34/// # Features
35///
36/// - **Shared Ownership**: Cloneable through `Rc`, allows multiple owners
37/// - **Single-Threaded**: Not thread-safe, more efficient than Arc in single-threaded contexts
38/// - **Conditional Execution**: Only consumes when predicate returns `true`
39/// - **Implements BiConsumer**: Can be used anywhere a `BiConsumer` is expected
40/// - **Non-mutating**: Neither modifies itself nor input values
41///
42pub struct RcConditionalBiConsumer<T, U> {
43    pub(super) consumer: RcBiConsumer<T, U>,
44    pub(super) predicate: RcBiPredicate<T, U>,
45}
46
47// Use macro to generate conditional bi-consumer implementations
48impl_shared_conditional_consumer!(
49    RcConditionalBiConsumer<T, U>,
50    RcBiConsumer,
51    BiConsumer,
52    into_rc,
53    'static
54);
55
56// Hand-written BiConsumer trait implementation
57impl<T, U> BiConsumer<T, U> for RcConditionalBiConsumer<T, U> {
58    fn accept(&self, first: &T, second: &U) {
59        if self.predicate.test(first, second) {
60            self.consumer.accept(first, second);
61        }
62    }
63
64    // Generates: into_box(), into_rc(), into_fn()
65    impl_conditional_consumer_conversions!(
66        BoxBiConsumer<T, U>,
67        RcBiConsumer,
68        Fn
69    );
70}
71
72// Use macro to generate Clone implementation
73impl_conditional_consumer_clone!(RcConditionalBiConsumer<T, U>);
74
75// Use macro to generate Debug and Display implementations
76impl_conditional_consumer_debug_display!(RcConditionalBiConsumer<T, U>);
qubit_function/consumers/bi_consumer/rc_conditional_bi_consumer.rs

qubit_function/consumers/bi_consumer/
rc_conditional_bi_consumer.rs
