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().expect("mutex should not be poisoned").push(*x + *y);
});
let conditional = consumer.when(|x: &i32, y: &i32| *x > 0 && *y > 0);

conditional.accept(&5, &3);
assert_eq!(*log.lock().expect("mutex should not be poisoned"), 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().expect("mutex should not be poisoned").push(*x + *y);
}).when(|x: &i32, y: &i32| *x > 0 && *y > 0)
  .or_else(move |x: &i32, y: &i32| {
    l2.lock().expect("mutex should not be poisoned").push(*x * *y);
});

consumer.accept(&5, &3);
assert_eq!(*log.lock().expect("mutex should not be poisoned"), vec![8]); // when branch executed

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

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.