Skip to main content

BoxConditionalBiConsumerOnce

Struct BoxConditionalBiConsumerOnce 

Source
pub struct BoxConditionalBiConsumerOnce<T, U> { /* private fields */ }
Expand description

BoxConditionalBiConsumerOnce struct

A conditional one-time bi-consumer that only executes when a predicate is satisfied. Uses BoxBiConsumerOnce and BoxBiPredicate for single ownership semantics.

This type is typically created by calling BoxBiConsumerOnce::when() and is designed to work with the or_else() method to create if-then-else logic.

§Features

  • Single Ownership: Not cloneable, consumes self on use
  • Conditional Execution: Only consumes when predicate returns true
  • Chainable: Can add or_else branch to create if-then-else logic
  • Implements BiConsumerOnce: Can be used anywhere a BiConsumerOnce is expected

§Examples

§Basic Conditional Execution

use qubit_function::{BiConsumerOnce, BoxBiConsumerOnce};
use std::sync::{Arc, Mutex};

let log = Arc::new(Mutex::new(Vec::new()));
let l = log.clone();
let consumer = BoxBiConsumerOnce::new(move |x: &i32, y: &i32| {
    l.lock().unwrap().push(*x + *y);
});
let conditional = consumer.when(|x: &i32, y: &i32| *x > 0 && *y > 0);

conditional.accept(&5, &3);
assert_eq!(*log.lock().unwrap(), vec![8]); // Executed

§With or_else Branch

use qubit_function::{BiConsumerOnce, BoxBiConsumerOnce};
use std::sync::{Arc, Mutex};

let log = Arc::new(Mutex::new(Vec::new()));
let l1 = log.clone();
let l2 = log.clone();
let consumer = BoxBiConsumerOnce::new(move |x: &i32, y: &i32| {
    l1.lock().unwrap().push(*x + *y);
}).when(|x: &i32, y: &i32| *x > 0 && *y > 0)
  .or_else(move |x: &i32, y: &i32| {
    l2.lock().unwrap().push(*x * *y);
});

consumer.accept(&5, &3);
assert_eq!(*log.lock().unwrap(), vec![8]); // when branch executed

§Author

Haixing Hu

Implementations§

Source§

impl<T, U> BoxConditionalBiConsumerOnce<T, U>

Source

pub fn and_then<C>(self, next: C) -> BoxBiConsumerOnce<T, U>
where T: 'static, U: 'static, C: BiConsumerOnce<T, U> + 'static,

Chains another bi-consumer in sequence

Combines the current conditional bi-consumer with another bi-consumer into a new bi-consumer that implements the following semantics:

When the returned bi-consumer is called with two arguments:

  1. First, it checks the predicate of this conditional bi-consumer
  2. If the predicate is satisfied, it executes the internal bi-consumer of this conditional bi-consumer
  3. Then, regardless of whether the predicate was satisfied, it unconditionally executes the next bi-consumer

In other words, this creates a bi-consumer that conditionally executes the first action (based on the predicate), and then always executes the second action.

§Parameters
  • next - The next bi-consumer to execute (always executed)
§Returns

Returns a new combined bi-consumer

§Examples
use std::sync::atomic::{AtomicI32, Ordering};
use qubit_function::BoxBiConsumer;
use qubit_function::BiConsumer;
use std::sync::Arc;

let result = Arc::new(AtomicI32::new(0));
let result1 = result.clone();
let result2 = result.clone();

let consumer1 = BoxBiConsumer::new(move |x: &i32, y: &i32| {
    result1.fetch_add(x + y, Ordering::SeqCst);
});

let consumer2 = BoxBiConsumer::new(move |x: &i32, y: &i32| {
    result2.fetch_add(2 * (x + y), Ordering::SeqCst);
});

let conditional = consumer1.when(|x: &i32, y: &i32| *x > 0 && *y > 0);
let chained = conditional.and_then(consumer2);

chained.accept(&5, &3);  // result = (5+3) + 2*(5+3) = 24
let result3 = result.clone();
result3.store(0, Ordering::SeqCst);  // reset
chained.accept(&-5, &3); // result = 0 + 2*(-5+3) = -4 (not -8!)
Source

pub fn or_else<C>(self, else_consumer: C) -> BoxBiConsumerOnce<T, U>
where T: 'static, U: 'static, C: BiConsumerOnce<T, U> + 'static,

Adds an else branch

Executes the original bi-consumer when the condition is satisfied, otherwise executes else_consumer.

§Parameters
  • else_consumer - The bi-consumer for the else branch
§Returns

Returns a new bi-consumer with if-then-else logic

Examples found in repository?
examples/consumers/bi_consumer_once_demo.rs (lines 85-87)
24fn main() {
25    println!("=== BiConsumerOnce Demo ===\n");
26
27    // 1. Basic usage
28    println!("1. Basic usage:");
29    let log = Arc::new(Mutex::new(Vec::new()));
30    let l = log.clone();
31    let consumer = BoxBiConsumerOnce::new(move |x: &i32, y: &i32| {
32        l.lock().unwrap().push(*x + *y);
33        println!("  Sum: {}", x + y);
34    });
35    consumer.accept(&10, &5);
36    println!("  Log: {:?}\n", *log.lock().unwrap());
37
38    // 2. Method chaining
39    println!("2. Method chaining:");
40    let log = Arc::new(Mutex::new(Vec::new()));
41    let l1 = log.clone();
42    let l2 = log.clone();
43    let chained = BoxBiConsumerOnce::new(move |x: &i32, y: &i32| {
44        l1.lock().unwrap().push(*x + *y);
45        println!("  First: sum={}", x + y);
46    })
47    .and_then(move |x: &i32, y: &i32| {
48        l2.lock().unwrap().push(*x * *y);
49        println!("  Second: product={}", x * y);
50    });
51    chained.accept(&5, &3);
52    println!("  Log: {:?}\n", *log.lock().unwrap());
53
54    // 3. Conditional execution - true case
55    println!("3. Conditional execution - true case:");
56    let log = Arc::new(Mutex::new(Vec::new()));
57    let l = log.clone();
58    let conditional = BoxBiConsumerOnce::new(move |x: &i32, y: &i32| {
59        l.lock().unwrap().push(*x + *y);
60    })
61    .when(|x: &i32, y: &i32| *x > 0 && *y > 0);
62    conditional.accept(&5, &3);
63    println!("  Positive values: {:?}\n", *log.lock().unwrap());
64
65    // 4. Conditional execution - false case
66    println!("4. Conditional execution - false case:");
67    let log = Arc::new(Mutex::new(Vec::new()));
68    let l = log.clone();
69    let conditional = BoxBiConsumerOnce::new(move |x: &i32, y: &i32| {
70        l.lock().unwrap().push(*x + *y);
71    })
72    .when(|x: &i32, y: &i32| *x > 0 && *y > 0);
73    conditional.accept(&-5, &3);
74    println!("  Negative value (unchanged): {:?}\n", *log.lock().unwrap());
75
76    // 5. Conditional branching
77    println!("5. Conditional branching:");
78    let log = Arc::new(Mutex::new(Vec::new()));
79    let l1 = log.clone();
80    let l2 = log.clone();
81    let branch = BoxBiConsumerOnce::new(move |x: &i32, _y: &i32| {
82        l1.lock().unwrap().push(*x);
83    })
84    .when(|x: &i32, y: &i32| *x > *y)
85    .or_else(move |_x: &i32, y: &i32| {
86        l2.lock().unwrap().push(*y);
87    });
88    branch.accept(&15, &10);
89    println!("  When x > y: {:?}\n", *log.lock().unwrap());
90
91    // 6. Working with closures directly
92    println!("6. Working with closures directly:");
93    let log = Arc::new(Mutex::new(Vec::new()));
94    let l = log.clone();
95    let closure = move |x: &i32, y: &i32| {
96        l.lock().unwrap().push(*x + *y);
97        println!("  Processed: {}", x + y);
98    };
99    closure.accept(&10, &20);
100    println!("  Log: {:?}\n", *log.lock().unwrap());
101
102    // 7. Moving captured values
103    println!("7. Moving captured values:");
104    let data = vec![1, 2, 3, 4, 5];
105    let consumer = BoxBiConsumerOnce::new(move |x: &i32, y: &i32| {
106        println!("  x={}, y={}", x, y);
107        println!("  Captured data: {:?}", data);
108        println!("  Data sum: {}", data.iter().sum::<i32>());
109    });
110    consumer.accept(&5, &3);
111    // data is no longer available here
112    println!();
113
114    // 8. Initialization callback
115    println!("8. Initialization callback:");
116    let log = Arc::new(Mutex::new(Vec::new()));
117    let l = log.clone();
118    let init_callback = BoxBiConsumerOnce::new(move |width: &i32, height: &i32| {
119        println!("  Initializing with dimensions: {}x{}", width, height);
120        l.lock().unwrap().push(*width * *height);
121    });
122    init_callback.accept(&800, &600);
123    println!("  Areas: {:?}\n", *log.lock().unwrap());
124
125    // 9. Cleanup callback
126    println!("9. Cleanup callback:");
127    let cleanup = BoxBiConsumerOnce::new(|count: &i32, total: &i32| {
128        println!("  Cleanup: processed {} out of {} items", count, total);
129        println!(
130            "  Success rate: {:.1}%",
131            (*count as f64 / *total as f64) * 100.0
132        );
133    });
134    cleanup.accept(&85, &100);
135    println!();
136
137    // 10. Name support
138    println!("10. Name support:");
139    let mut named_consumer = BoxBiConsumerOnce::<i32, i32>::noop();
140    println!("  Initial name: {:?}", named_consumer.name());
141
142    named_consumer.set_name("init_callback");
143    println!("  After setting name: {:?}", named_consumer.name());
144    println!("  Display: {}", named_consumer);
145    named_consumer.accept(&1, &2);
146    println!();
147
148    // 11. Print helpers
149    println!("11. Print helpers:");
150    let print = BoxBiConsumerOnce::new(|x: &i32, y: &i32| println!("{}, {}", x, y));
151    print.accept(&42, &10);
152
153    let print_with =
154        BoxBiConsumerOnce::new(|x: &i32, y: &i32| println!("Dimensions: {}, {}", x, y));
155    print_with.accept(&800, &600);
156    println!();
157
158    // 12. Converting to function
159    println!("12. Converting to function:");
160    let log = Arc::new(Mutex::new(Vec::new()));
161    let l = log.clone();
162    let consumer = BoxBiConsumerOnce::new(move |x: &i32, y: &i32| {
163        l.lock().unwrap().push(*x + *y);
164    });
165    let func = consumer.into_fn();
166    func(&7, &3);
167    println!("  Log: {:?}\n", *log.lock().unwrap());
168
169    println!("=== Demo Complete ===");
170}

Trait Implementations§

Source§

impl<T, U> BiConsumerOnce<T, U> for BoxConditionalBiConsumerOnce<T, U>

Source§

fn accept(self, first: &T, second: &U)

Performs the one-time consumption operation Read more
Source§

fn into_fn(self) -> impl FnOnce(&T, &U)

Converts to a closure Read more
Source§

fn into_box(self) -> BoxBiConsumerOnce<T, U>
where Self: Sized + 'static,

Converts to BoxBiConsumerOnce Read more
Source§

impl<T, U> Debug for BoxConditionalBiConsumerOnce<T, U>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<T, U> Display for BoxConditionalBiConsumerOnce<T, U>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.