qubit_function/transformers/stateful_transformer/arc_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 `ArcStatefulTransformer` public type.
12
13use super::{
14 Arc,
15 ArcConditionalStatefulTransformer,
16 BoxStatefulTransformer,
17 BoxTransformerOnce,
18 Mutex,
19 Predicate,
20 RcStatefulTransformer,
21 StatefulTransformer,
22 impl_arc_conversions,
23 impl_closure_trait,
24 impl_shared_transformer_methods,
25 impl_transformer_clone,
26 impl_transformer_common_methods,
27 impl_transformer_constant_method,
28 impl_transformer_debug_display,
29};
30
31// ============================================================================
32// ArcStatefulTransformer - Arc<Mutex<dyn FnMut(T) -> R + Send>>
33// ============================================================================
34
35/// ArcStatefulTransformer - thread-safe transformer wrapper
36///
37/// A thread-safe, clonable transformer wrapper suitable for multi-threaded
38/// scenarios. Can be called multiple times and shared across threads
39/// while maintaining internal state.
40///
41/// # Features
42///
43/// - **Based on**: `Arc<Mutex<dyn FnMut(T) -> R + Send>>`
44/// - **Ownership**: Shared ownership via reference counting
45/// - **Reusability**: Can be called multiple times (each call consumes
46/// its input)
47/// - **Thread Safety**: Thread-safe (`Send` required)
48/// - **Clonable**: Cheap cloning via `Arc::clone`
49/// - **Statefulness**: Can modify internal state between calls
50///
51pub struct ArcStatefulTransformer<T, R> {
52 pub(super) function: Arc<Mutex<dyn FnMut(T) -> R + Send>>,
53 pub(super) name: Option<String>,
54}
55
56impl<T, R> ArcStatefulTransformer<T, R> {
57 impl_transformer_common_methods!(
58 ArcStatefulTransformer<T, R>,
59 (FnMut(T) -> R + Send + 'static),
60 |f| Arc::new(Mutex::new(f))
61 );
62
63 impl_shared_transformer_methods!(
64 ArcStatefulTransformer<T, R>,
65 ArcConditionalStatefulTransformer,
66 into_arc,
67 StatefulTransformer,
68 Send + Sync + 'static
69 );
70}
71
72// Implement constant method for ArcStatefulTransformer
73impl_transformer_constant_method!(stateful thread_safe ArcStatefulTransformer<T, R>);
74
75// Implement Debug and Display for ArcStatefulTransformer
76impl_transformer_debug_display!(ArcStatefulTransformer<T, R>);
77
78// Implement Clone for ArcStatefulTransformer
79impl_transformer_clone!(ArcStatefulTransformer<T, R>);
80
81impl<T, R> StatefulTransformer<T, R> for ArcStatefulTransformer<T, R> {
82 fn apply(&mut self, input: T) -> R {
83 let mut func = self.function.lock();
84 func(input)
85 }
86
87 // Use macro to implement conversion methods
88 impl_arc_conversions!(
89 ArcStatefulTransformer<T, R>,
90 BoxStatefulTransformer,
91 RcStatefulTransformer,
92 BoxTransformerOnce,
93 FnMut(t: T) -> R
94 );
95}
96
97// ============================================================================
98// Blanket implementation for standard FnMut trait
99// ============================================================================
100
101// Implement StatefulTransformer<T, R> for any type that implements FnMut(T) -> R
102impl_closure_trait!(
103 StatefulTransformer<T, R>,
104 apply,
105 BoxTransformerOnce,
106 FnMut(input: T) -> R
107);