qubit_function/transformers/stateful_transformer/rc_stateful_transformer.rs
1/*******************************************************************************
2 *
3 * Copyright (c) 2025 - 2026 Haixing Hu.
4 *
5 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0.
8 *
9 ******************************************************************************/
10// qubit-style: allow explicit-imports
11//! Defines the `RcStatefulTransformer` public type.
12
13#![allow(unused_imports)]
14
15use super::*;
16
17// ============================================================================
18// RcStatefulTransformer - Rc<RefCell<dyn FnMut(T) -> R>>
19// ============================================================================
20
21/// RcStatefulTransformer - single-threaded transformer wrapper
22///
23/// A single-threaded, clonable transformer wrapper optimized for scenarios
24/// that require sharing without thread-safety overhead.
25///
26/// # Features
27///
28/// - **Based on**: `Rc<RefCell<dyn FnMut(T) -> R>>`
29/// - **Ownership**: Shared ownership via reference counting (non-atomic)
30/// - **Reusability**: Can be called multiple times (each call consumes
31/// its input)
32/// - **Thread Safety**: Not thread-safe (no `Send + Sync`)
33/// - **Clonable**: Cheap cloning via `Rc::clone`
34/// - **Statefulness**: Can modify internal state between calls
35///
36pub struct RcStatefulTransformer<T, R> {
37 pub(super) function: Rc<RefCell<dyn FnMut(T) -> R>>,
38 pub(super) name: Option<String>,
39}
40
41// Implement RcStatefulTransformer
42impl<T, R> RcStatefulTransformer<T, R> {
43 impl_transformer_common_methods!(
44 RcStatefulTransformer<T, R>,
45 (FnMut(T) -> R + 'static),
46 |f| Rc::new(RefCell::new(f))
47 );
48
49 impl_shared_transformer_methods!(
50 RcStatefulTransformer<T, R>,
51 RcConditionalStatefulTransformer,
52 into_rc,
53 StatefulTransformer,
54 'static
55 );
56}
57
58// Implement constant method for RcStatefulTransformer
59impl_transformer_constant_method!(stateful RcStatefulTransformer<T, R>);
60
61// Implement Debug and Display for RcStatefulTransformer
62impl_transformer_debug_display!(RcStatefulTransformer<T, R>);
63
64// Implement Clone for RcStatefulTransformer
65impl_transformer_clone!(RcStatefulTransformer<T, R>);
66
67// Implement StatefulTransformer trait for RcStatefulTransformer
68impl<T, R> StatefulTransformer<T, R> for RcStatefulTransformer<T, R> {
69 fn apply(&mut self, input: T) -> R {
70 let mut self_fn = self.function.borrow_mut();
71 self_fn(input)
72 }
73
74 // Generate all conversion methods using the unified macro
75 impl_rc_conversions!(
76 RcStatefulTransformer<T, R>,
77 BoxStatefulTransformer,
78 BoxTransformerOnce,
79 FnMut(input: T) -> R
80 );
81}