prism3_function::functions::stateful_function

Struct BoxStatefulFunction

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

Expand description

BoxStatefulFunction - stateful function wrapper based on Box<dyn FnMut>

A stateful function wrapper that provides single ownership with reusable stateful transformation. The stateful function consumes the input and can be called multiple times while maintaining internal state.

§Features

Based on: Box<dyn FnMut(&T) -> R>
Ownership: Single ownership, cannot be cloned
Reusability: Can be called multiple times (each call consumes its input)
Thread Safety: Not thread-safe (no Send + Sync requirement)
Statefulness: Can modify internal state between calls

§Author

Haixing Hu

Implementations§

Source §

impl<T, R> BoxStatefulFunction<T, R>
where T: 'static, R: 'static,

Source

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

Creates a new function.

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

Source

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

Creates a new named function.

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) -> R + 'static,

Creates a new named function 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 function.

§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 function.

§Parameters

name - The name to set for this function

Source

pub fn when(self, predicate: P) -> BoxConditionalStatefulFunction<T, R>
where P: Predicate<T> + '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::{BoxFunction, Function};

let double = BoxFunction::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

Source

pub fn and_then<S, F>(self, after: F) -> BoxStatefulFunction<T, S>
where S: 'static, F: StatefulFunction<R, S> + '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::{BoxFunction, Function};

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

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

Source §

impl<T, R> BoxStatefulFunction<T, R>
where T: 'static, R: Clone + 'static,

Source

pub fn constant(value: R) -> BoxStatefulFunction<T, R>

Creates a constant function

§Examples

/// rust /// use prism3_function::{BoxStatefulFunction, Function}; /// /// let constant = BoxStatefulFunction::constant("hello"); /// assert_eq!(constant.apply(123), "hello"); ///

Source §

impl<T> BoxStatefulFunction<T, T>
where T: Clone + 'static,

Source

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

Creates an identity function

§Examples

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