Struct ArcStatefulMutatingFunction 

pub struct ArcStatefulMutatingFunction<T, R> { /* private fields */ }

ArcStatefulMutatingFunction struct

A stateful mutating function implementation based on Arc<Mutex<dyn FnMut(&mut T) -> R + Send>> for thread-safe shared ownership scenarios. This type allows the function to be safely shared and used across multiple threads.

Features

• Shared Ownership: Cloneable via Arc, multiple owners allowed
• Thread-Safe: Implements Send + Sync, safe for concurrent use
• Stateful: Can modify captured environment (uses FnMut)
• Chainable: Method chaining via &self (non-consuming)

Use Cases

Choose ArcStatefulMutatingFunction when:

• The function needs to be shared across multiple threads for stateful operations
• Concurrent task processing (e.g., thread pools)
• Thread safety is required (Send + Sync)

Examples

use prism3_function::{StatefulMutatingFunction,
                      ArcStatefulMutatingFunction};

let counter = {
    let mut count = 0;
    ArcStatefulMutatingFunction::new(move |x: &mut i32| {
        count += 1;
        *x *= 2;
        count
    })
};
let mut clone = counter.clone();

let mut value = 5;
assert_eq!(clone.apply(&mut value), 1);

Author

Haixing Hu

Implementations

impl<T, R> ArcStatefulMutatingFunction<T, R>

where T: 'static, R: 'static,

pub fn new<F>(f: F) -> Self

where F: FnMut(&mut T) -> R + Send + 'static,

Creates a new function.

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

pub fn new_with_name<F>(name: &str, f: F) -> Self

where F: FnMut(&mut T) -> R + Send + 'static,

Creates a new named function.

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

pub fn new_with_optional_name<F>(f: F, name: Option<String>) -> Self

where F: FnMut(&mut T) -> R + Send + 'static,

Creates a new named function with an optional name.

Wraps the provided closure and assigns it an optional name.

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

Gets the name of this function.

Returns

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

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

Sets the name of this function.

Parameters

• name - The name to set for this function

pub fn when<P>( &self, predicate: P, ) -> ArcConditionalStatefulMutatingFunction<T, R>

where P: Predicate<T> + Send + Sync + 'static,

Creates a conditional function that executes based on predicate result.

Parameters

• predicate - The predicate to determine whether to execute the function operation

Returns

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

Examples

use prism3_function::{ArcFunction, Function};
use std::sync::Arc;

let double = ArcFunction::new(|x: i32| x * 2);
let conditional = double.when(|value: &i32| *value > 0);
assert_eq!(conditional.or_else(|_| 0).apply(5), 10);  // executed
assert_eq!(conditional.or_else(|_| 0).apply(-3), 0);  // not executed

pub fn and_then<S, F>(&self, after: F) -> ArcStatefulMutatingFunction<T, S>

where S: 'static, F: Function<R, S> + Send + Sync + 'static,

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

Parameters

• after - The subsequent function to execute after the current function completes

Returns

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

Examples

use prism3_function::{ArcFunction, Function};
use std::sync::Arc;

let double = ArcFunction::new(|x: i32| x * 2);
let to_string = ArcFunction::new(|x: i32| x.to_string());

let chained = double.and_then(to_string);
assert_eq!(chained.apply(5), "10".to_string());

impl<T> ArcStatefulMutatingFunction<T, T>

where T: Clone + 'static,

pub fn identity() -> ArcStatefulMutatingFunction<T, T>

Creates an identity function

Examples

/// rust /// use prism3_function::ArcStatefulMutatingFunction; /// /// let mut identity = ArcStatefulMutatingFunction::<i32, i32>::identity(); /// let mut value = 42; /// assert_eq!(identity.apply(&mut value), 42); ///

Trait Implementations

impl<T, R> Clone for ArcStatefulMutatingFunction<T, R>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, R> Debug for ArcStatefulMutatingFunction<T, R>

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

Formats the value using the given formatter.

impl<T, R> Display for ArcStatefulMutatingFunction<T, R>

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

Formats the value using the given formatter.

impl<T, R> StatefulMutatingFunction<T, R> for ArcStatefulMutatingFunction<T, R>

fn apply(&mut self, t: &mut T) -> R

Applies the function to the mutable reference and returns a result

fn into_box(self) -> BoxStatefulMutatingFunction<T, R>

where T: 'static, R: 'static,

Convert this function into a BoxStatefulMutatingFunction<T, R>.

fn into_rc(self) -> RcStatefulMutatingFunction<T, R>

where T: 'static, R: 'static,

Convert this function into an RcStatefulMutatingFunction<T, R>.

fn into_arc(self) -> ArcStatefulMutatingFunction<T, R>

where T: 'static, R: 'static,

Convert this function into an ArcStatefulMutatingFunction<T, R>.

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

Consume the function and return an FnMut(&mut T) -> R closure.

fn into_once(self) -> BoxMutatingFunctionOnce<T, R>

where T: 'static, R: 'static,

Convert to StatefulMutatingFunctionOnce

fn to_box(&self) -> BoxStatefulMutatingFunction<T, R>

where T: 'static, R: 'static,

Create a non-consuming BoxStatefulMutatingFunction<T, R> that forwards to self.

fn to_rc(&self) -> RcStatefulMutatingFunction<T, R>

where T: 'static, R: 'static,

Create a non-consuming RcStatefulMutatingFunction<T, R> that forwards to self.

fn to_arc(&self) -> ArcStatefulMutatingFunction<T, R>

where T: 'static, R: 'static,

Create a non-consuming ArcStatefulMutatingFunction<T, R> that forwards to self.

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

Create a boxed FnMut(&mut T) -> R closure that forwards to self.

fn to_once(&self) -> BoxMutatingFunctionOnce<T, R>

where T: 'static, R: 'static,

Convert to StatefulMutatingFunctionOnce without consuming self