Struct BoxConditionalBiConsumer 

pub struct BoxConditionalBiConsumer<T, U> { /* private fields */ }

BoxConditionalBiConsumer struct

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

This type is typically created by calling BoxBiConsumer::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 BiConsumer: Can be used anywhere a BiConsumer is expected

Examples

Basic Conditional Execution

use prism3_function::{BiConsumer, BoxBiConsumer};
use std::sync::{Arc, Mutex};

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

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

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

With or_else Branch

use prism3_function::{BiConsumer, BoxBiConsumer};
use std::sync::{Arc, Mutex};

let log = Arc::new(Mutex::new(Vec::new()));
let l1 = log.clone();
let l2 = log.clone();
let mut consumer = BoxBiConsumer::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

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

Author

Haixing Hu

Implementations

impl<T, U> BoxConditionalBiConsumer<T, U>

where T: 'static, U: 'static,

pub fn and_then<C>(self, next: C) -> BoxBiConsumer<T, U>

where C: BiConsumer<T, U> + 'static,

Chains another consumer in sequence

Combines the current conditional consumer with another consumer into a new consumer. The current conditional consumer executes first, followed by the next consumer.

Parameters

• next - The next consumer to execute. Note: This parameter is passed by value and will transfer ownership. If you need to preserve the original consumer, clone it first (if it implements Clone). Can be:
  • A closure: |x: &T, y: &U|
  • A BoxBiConsumer<T, U>
  • An ArcBiConsumer<T, U>
  • An RcBiConsumer<T, U>
  • Any type implementing BiConsumer<T, U>

Returns

Returns a new BoxBiConsumer<T, U>

Examples

Direct value passing (ownership transfer)

use prism3_function::{BiConsumer, BoxBiConsumer};
use std::sync::{Arc, Mutex};

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

// second is moved here
let mut chained = cond.and_then(second);
chained.accept(&5, &3);
assert_eq!(*log.lock().unwrap(), vec![8, 15]);
// second.accept(&2, &3); // Would not compile - moved

Preserving original with clone

use prism3_function::{BiConsumer, BoxBiConsumer};
use std::sync::{Arc, Mutex};

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

// Clone to preserve original
let mut chained = cond.and_then(second.clone());
chained.accept(&5, &3);
assert_eq!(*log.lock().unwrap(), vec![8, 15]);

// Original still usable
second.accept(&2, &3);
assert_eq!(*log.lock().unwrap(), vec![8, 15, 6]);

pub fn or_else<C>(self, else_consumer: C) -> BoxBiConsumer<T, U>

where C: BiConsumer<T, U> + 'static,

Adds an else branch

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

Parameters

• else_consumer - The consumer for the else branch. Note: This parameter is passed by value and will transfer ownership. If you need to preserve the original consumer, clone it first (if it implements Clone). Can be:
  • A closure: |x: &T, y: &U|
  • A BoxBiConsumer<T, U>
  • An RcBiConsumer<T, U>
  • An ArcBiConsumer<T, U>
  • Any type implementing BiConsumer<T, U>

Returns

Returns the composed BoxBiConsumer<T, U>

Examples

Using a closure (recommended)

use prism3_function::{BiConsumer, BoxBiConsumer};
use std::sync::{Arc, Mutex};

let log = Arc::new(Mutex::new(Vec::new()));
let l1 = log.clone();
let l2 = log.clone();
let mut consumer = BoxBiConsumer::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]); // Condition satisfied

consumer.accept(&-5, &3);
assert_eq!(*log.lock().unwrap(), vec![8, -15]); // Condition not satisfied

Examples found in repository

examples/bi_consumer_demo.rs (lines 129-131)

fn main() {
    println!("=== BiConsumer Demo ===\n");

    // 1. BoxBiConsumer - Single ownership
    println!("1. BoxBiConsumer - Single ownership:");
    let log = Arc::new(Mutex::new(Vec::new()));
    let l = log.clone();
    let mut box_consumer = BoxBiConsumer::new(move |x: &i32, y: &i32| {
        println!("  Processing: x={}, y={}", x, y);
        l.lock().unwrap().push(*x + *y);
    });
    box_consumer.accept(&10, &5);
    println!("  Result log: {:?}\n", *log.lock().unwrap());

    // 2. Method chaining with BoxBiConsumer
    println!("2. BoxBiConsumer with method chaining:");
    let log = Arc::new(Mutex::new(Vec::new()));
    let l1 = log.clone();
    let l2 = log.clone();
    let mut chained = BoxBiConsumer::new(move |x: &i32, y: &i32| {
        l1.lock().unwrap().push(*x + *y);
        println!("  After first operation: sum = {}", x + y);
    })
    .and_then(move |x: &i32, y: &i32| {
        l2.lock().unwrap().push(*x * *y);
        println!("  After second operation: product = {}", x * y);
    });
    chained.accept(&5, &3);
    println!("  Final log: {:?}\n", *log.lock().unwrap());

    // 3. ArcBiConsumer - Thread-safe shared ownership
    println!("3. ArcBiConsumer - Thread-safe shared ownership:");
    let log = Arc::new(Mutex::new(Vec::new()));
    let l = log.clone();
    let arc_consumer = ArcBiConsumer::new(move |x: &i32, y: &i32| {
        l.lock().unwrap().push(*x + *y);
        println!("  Thread {:?}: sum = {}", thread::current().id(), x + y);
    });

    let consumer1 = arc_consumer.clone();
    let consumer2 = arc_consumer.clone();

    let handle1 = thread::spawn(move || {
        let mut c = consumer1;
        c.accept(&10, &5);
    });

    let handle2 = thread::spawn(move || {
        let mut c = consumer2;
        c.accept(&20, &8);
    });

    handle1.join().unwrap();
    handle2.join().unwrap();
    println!("  Final log: {:?}\n", *log.lock().unwrap());

    // 4. RcBiConsumer - Single-threaded shared ownership
    println!("4. RcBiConsumer - Single-threaded shared ownership:");
    let log = Rc::new(RefCell::new(Vec::new()));
    let l = log.clone();
    let rc_consumer = RcBiConsumer::new(move |x: &i32, y: &i32| {
        l.borrow_mut().push(*x + *y);
    });

    let mut clone1 = rc_consumer.clone();
    let mut clone2 = rc_consumer.clone();

    clone1.accept(&5, &3);
    println!("  After first use: {:?}", *log.borrow());

    clone2.accept(&7, &2);
    println!("  After second use: {:?}\n", *log.borrow());

    // 5. Working with closures directly
    println!("5. Working with closures directly:");
    let log = Arc::new(Mutex::new(Vec::new()));
    let l = log.clone();
    let mut closure = move |x: &i32, y: &i32| {
        let sum = *x + *y;
        l.lock().unwrap().push(sum);
    };
    closure.accept(&10, &20);
    println!("  After closure: {:?}\n", *log.lock().unwrap());

    // 6. Conditional BiConsumer
    println!("6. Conditional BiConsumer:");
    let log = Arc::new(Mutex::new(Vec::new()));
    let l = log.clone();
    let mut conditional = BoxBiConsumer::new(move |x: &i32, y: &i32| {
        l.lock().unwrap().push(*x + *y);
    })
    .when(|x: &i32, y: &i32| *x > 0 && *y > 0);

    conditional.accept(&5, &3);
    println!("  Positive values: {:?}", *log.lock().unwrap());

    conditional.accept(&-5, &3);
    println!("  Negative value (unchanged): {:?}\n", *log.lock().unwrap());

    // 7. Conditional branch BiConsumer
    println!("7. Conditional branch BiConsumer:");
    let log = Arc::new(Mutex::new(Vec::new()));
    let l1 = log.clone();
    let l2 = log.clone();
    let mut branch = BoxBiConsumer::new(move |x: &i32, _y: &i32| {
        l1.lock().unwrap().push(*x);
    })
    .when(|x: &i32, y: &i32| *x > *y)
    .or_else(move |_x: &i32, y: &i32| {
        l2.lock().unwrap().push(*y);
    });

    branch.accept(&15, &10);
    println!("  When x > y: {:?}", *log.lock().unwrap());

    branch.accept(&5, &10);
    println!("  When x <= y: {:?}\n", *log.lock().unwrap());

    // 8. Accumulating statistics
    println!("8. Accumulating statistics:");
    let count = Arc::new(Mutex::new(0));
    let sum = Arc::new(Mutex::new(0));
    let c = count.clone();
    let s = sum.clone();
    let mut stats_consumer = BoxBiConsumer::new(move |x: &i32, y: &i32| {
        *c.lock().unwrap() += 1;
        *s.lock().unwrap() += x + y;
    });

    stats_consumer.accept(&5, &3);
    stats_consumer.accept(&10, &2);
    stats_consumer.accept(&7, &8);

    println!("  Count: {}", *count.lock().unwrap());
    println!("  Sum: {}\n", *sum.lock().unwrap());

    // 9. Name support
    println!("9. Name support:");
    let mut named_consumer = BoxBiConsumer::<i32, i32>::noop();
    println!("  Initial name: {:?}", named_consumer.name());

    named_consumer.set_name("sum_calculator");
    println!("  After setting name: {:?}", named_consumer.name());
    println!("  Display: {}\n", named_consumer);

    println!("=== Demo Complete ===");
}

Trait Implementations

impl<T, U> BiConsumer<T, U> for BoxConditionalBiConsumer<T, U>

where T: 'static, U: 'static,

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

Performs the consumption operation

fn into_box(self) -> BoxBiConsumer<T, U>

Converts to BoxBiConsumer

fn into_rc(self) -> RcBiConsumer<T, U>

Converts to RcBiConsumer

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

Converts bi-consumer to a closure

fn into_arc(self) -> ArcBiConsumer<T, U>

where Self: Sized + Send + 'static, T: Send + 'static, U: Send + 'static,

Converts to ArcBiConsumer