Struct BoxConsumer

Source

pub struct BoxConsumer<T> { /* private fields */ }

Expand description

BoxConsumer struct

Readonly consumer implementation based on Box<dyn Fn(&T)> for single ownership scenarios.

§Features

Single Ownership: Not cloneable, transfers ownership when used
Zero Overhead: No reference counting or lock overhead
Completely Immutable: Neither modifies itself nor input
No Interior Mutability: No need for Mutex or RefCell

§Use Cases

Choose BoxConsumer when:

Readonly consumer is used once or in a linear flow
No need to share consumer across contexts
Pure observation operations, such as logging

§Examples

use prism3_function::{Consumer, BoxConsumer};

let consumer = BoxConsumer::new(|x: &i32| {
    println!("Observed value: {}", x);
});
consumer.accept(&5);

§Author

Haixing Hu

Implementations§

Source §

impl<T> BoxConsumer<T>
where T: 'static,

Source

pub fn new<F>(f: F) -> Self
where F: Fn(&T) + 'static,

Creates a new consumer.

Wraps the provided closure in the appropriate smart pointer type for this consumer implementation.

Source

pub fn new_with_name<F>(name: &str, f: F) -> Self
where F: Fn(&T) + 'static,

Creates a new named consumer.

Wraps the provided closure and assigns it a name, which is useful for debugging and logging purposes.

Source

pub fn new_with_optional_name<F>(f: F, name: Option<String>) -> Self
where F: Fn(&T) + 'static,

Creates a new named consumer with an optional name.

Wraps the provided closure and assigns it an optional name.

Source

pub fn name(&self) -> Option<&str>

Gets the name of this consumer.

§Returns

Returns Some(&str) if a name was set, None otherwise.

Source

pub fn set_name(&mut self, name: &str)

Sets the name of this consumer.

§Parameters

name - The name to set for this consumer

Source

pub fn noop() -> Self

Creates a no-operation consumer.

Creates a consumer that does nothing when called. Useful for default values or placeholder implementations.

§Returns

Returns a new consumer instance that performs no operation.

Source

pub fn when(self, predicate: P) -> BoxConditionalConsumer<T>
where P: Predicate<T> + 'static,

Creates a conditional consumer that executes based on predicate result.

§Parameters

predicate - The predicate to determine whether to execute the consumption operation

§Returns

Returns a conditional consumer that only executes when the predicate returns true.

§Examples

use std::sync::Arc;
use std::sync::atomic::{AtomicI32, Ordering};
use prism3_rust_function::consumers::*;

let counter = Arc::new(AtomicI32::new(0));
let consumer = BoxConsumer::new({
    let counter = Arc::clone(&counter);
    move |value: &i32| {
        counter.fetch_add(*value, Ordering::SeqCst);
    }
});

let conditional = consumer.when(|value: &i32| *value > 0);
conditional.accept(&1);  // counter = 1
conditional.accept(&-1); // not executed, counter remains 1

Source

pub fn and_then<C>(self, after: C) -> BoxConsumer<T>
where Self: Sized + 'static, T: 'static, C: Consumer<T> + 'static,

Chains execution with another consumer, executing the current consumer first, then the subsequent consumer.

§Parameters

after - The subsequent consumer to execute after the current consumer completes

§Returns

Returns a new consumer that executes the current consumer and the subsequent consumer in sequence.

§Examples

use std::sync::Arc;
use std::sync::atomic::{AtomicI32, Ordering};
use prism3_rust_function::consumers::*;

let counter1 = Arc::new(AtomicI32::new(0));
let counter2 = Arc::new(AtomicI32::new(0));

let consumer1 = BoxConsumer::new({
    let counter = Arc::clone(&counter1);
    move |value: &i32| {
        counter.fetch_add(*value, Ordering::SeqCst);
    }
});

let consumer2 = BoxConsumer::new({
    let counter = Arc::clone(&counter2);
    move |value: &i32| {
        counter.fetch_add(*value * 2, Ordering::SeqCst);
    }
});

let chained = consumer1.and_then(consumer2);
chained.accept(&5);
// counter1 = 5, counter2 = 10