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