RcStatefulConsumer

Struct RcStatefulConsumer 

Source
pub struct RcStatefulConsumer<T> { /* private fields */ }
Expand description

RcStatefulConsumer struct

Consumer implementation based on Rc<RefCell<dyn FnMut(&T)>> for single-threaded shared ownership scenarios. This consumer provides the benefits of shared ownership without the overhead of thread safety.

§Features

  • Shared Ownership: Cloneable through Rc, allowing multiple owners
  • Single-Threaded: Not thread-safe, cannot be sent across threads
  • Interior Mutability: Uses RefCell for runtime borrowing checks
  • No Lock Overhead: More efficient than ArcStatefulConsumer for single-threaded use
  • Non-Consuming API: and_then borrows &self, original object remains usable

§Use Cases

Choose RcStatefulConsumer when:

  • Need to share consumers within a single thread
  • Thread safety is not needed
  • Performance is important (avoid lock overhead)
  • UI event handling in single-threaded frameworks
  • Building complex single-threaded state machines

§Performance Considerations

RcStatefulConsumer performs better than ArcStatefulConsumer in single-threaded scenarios:

  • Non-Atomic Counting: clone/drop is cheaper than Arc
  • No Lock Overhead: RefCell uses runtime checks, no locks
  • Better Cache Locality: No atomic operations means better CPU cache behavior

But still has slight overhead compared to BoxStatefulConsumer:

  • Reference Counting: Non-atomic but still exists
  • Runtime Borrowing Checks: RefCell checks at runtime

§Safety

RcStatefulConsumer is not thread-safe and does not implement Send or Sync. Attempting to send it to another thread will result in a compilation error. For thread-safe sharing, use ArcStatefulConsumer instead.

§Examples

use prism3_function::{Consumer, RcStatefulConsumer};
use std::rc::Rc;
use std::cell::RefCell;

let log = Rc::new(RefCell::new(Vec::new()));
let l = log.clone();
let mut consumer = RcStatefulConsumer::new(move |x: &i32| {
    l.borrow_mut().push(*x * 2);
});
let mut clone = consumer.clone();

consumer.accept(&5);
assert_eq!(*log.borrow(), vec![10]);

§Author

Haixing Hu

Implementations§

Source§

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

Source

pub fn new<F>(f: F) -> Self
where F: FnMut(&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: FnMut(&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: FnMut(&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<P>(&self, predicate: P) -> RcConditionalStatefulConsumer<T>
where P: Predicate<T> + 'static,

Creates a conditional consumer

Wraps this consumer with a predicate condition, creating a new conditional consumer that will only execute the original consumer when the predicate evaluates to true.

§Parameters
  • predicate - The condition that must be satisfied for the consumer to execute
§Returns

Returns a conditional consumer that executes this consumer only when the predicate is satisfied

§Examples
let consumer = ArcConsumer::new(|x: &i32| println!("{}", x));
let conditional = consumer.when(|x| *x > 0);

conditional.accept(&5);  // prints: 5
conditional.accept(&-5); // prints nothing
Source

pub fn and_then<C>(&self, after: C) -> RcStatefulConsumer<T>
where T: 'static, C: StatefulConsumer<T> + 'static,

Chains another consumer in sequence

Combines this consumer with another consumer into a new consumer that executes both consumers in sequence. The returned consumer first executes this consumer, then unconditionally executes the after consumer.

§Parameters
  • after - The consumer to execute after this one (always executed)
§Returns

Returns a new consumer that executes both consumers in sequence

§Examples
let consumer1 = ArcConsumer::new(|x: &i32| print!("first: {}", x));
let consumer2 = ArcConsumer::new(|x: &i32| println!(" second: {}", x));

let chained = consumer1.and_then(consumer2);

chained.accept(&5);  // prints: first: 5 second: 5

Trait Implementations§

Source§

impl<T> Clone for RcStatefulConsumer<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<T> Debug for RcStatefulConsumer<T>

Source§

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

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

impl<T> Display for RcStatefulConsumer<T>

Source§

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

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

impl<T> StatefulConsumer<T> for RcStatefulConsumer<T>

Source§

fn accept(&mut self, value: &T)

Execute consumption operation Read more
Source§

fn into_box(self) -> BoxStatefulConsumer<T>
where T: 'static,

Convert to BoxStatefulConsumer Read more
Source§

fn into_rc(self) -> RcStatefulConsumer<T>
where T: 'static,

Convert to RcStatefulConsumer Read more
Source§

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

Convert to closure Read more
Source§

fn to_box(&self) -> BoxStatefulConsumer<T>
where T: 'static,

Convert to BoxStatefulConsumer Read more
Source§

fn to_rc(&self) -> RcStatefulConsumer<T>
where T: 'static,

Convert to RcStatefulConsumer Read more
Source§

fn to_fn(&self) -> impl FnMut(&T)

Convert to closure Read more
Source§

fn into_once(self) -> BoxConsumerOnce<T>
where T: 'static,

Convert to ConsumerOnce Read more
Source§

fn to_once(&self) -> BoxConsumerOnce<T>
where T: 'static,

Convert to ConsumerOnce without consuming self Read more
Source§

fn into_arc(self) -> ArcStatefulConsumer<T>
where Self: Sized + Send + 'static, T: 'static,

Convert to ArcStatefulConsumer Read more
Source§

fn to_arc(&self) -> ArcStatefulConsumer<T>
where Self: Sized + Clone + Send + 'static, T: 'static,

Convert to ArcStatefulConsumer 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.