qubit_function/transformers/transformer/rc_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 `RcTransformer` public type.
12
13use super::{
14 BoxTransformer,
15 BoxTransformerOnce,
16 Predicate,
17 Rc,
18 RcConditionalTransformer,
19 Transformer,
20 impl_rc_conversions,
21 impl_shared_transformer_methods,
22 impl_transformer_clone,
23 impl_transformer_common_methods,
24 impl_transformer_constant_method,
25 impl_transformer_debug_display,
26};
27
28// ============================================================================
29// RcTransformer - Rc<dyn Fn(T) -> R>
30// ============================================================================
31
32/// RcTransformer - single-threaded transformer wrapper
33///
34/// A single-threaded, clonable transformer wrapper optimized for scenarios
35/// that require sharing without thread-safety overhead.
36///
37/// # Features
38///
39/// - **Based on**: `Rc<dyn Fn(T) -> R>`
40/// - **Ownership**: Shared ownership via reference counting (non-atomic)
41/// - **Reusability**: Can be called multiple times (each call consumes its
42/// input)
43/// - **Thread Safety**: Not thread-safe (no `Send + Sync`)
44/// - **Clonable**: Cheap cloning via `Rc::clone`
45///
46pub struct RcTransformer<T, R> {
47 pub(super) function: Rc<dyn Fn(T) -> R>,
48 pub(super) name: Option<String>,
49}
50
51// Implement RcTransformer
52impl<T, R> RcTransformer<T, R> {
53 impl_transformer_common_methods!(
54 RcTransformer<T, R>,
55 (Fn(T) -> R + 'static),
56 |f| Rc::new(f)
57 );
58
59 impl_shared_transformer_methods!(
60 RcTransformer<T, R>,
61 RcConditionalTransformer,
62 into_rc,
63 Transformer,
64 'static
65 );
66}
67
68impl_transformer_constant_method!(RcTransformer<T, R>);
69
70// Implement Debug and Display for RcTransformer
71impl_transformer_debug_display!(RcTransformer<T, R>);
72
73// Implement Clone for RcTransformer
74impl_transformer_clone!(RcTransformer<T, R>);
75
76// Implement Transformer for RcTransformer
77impl<T, R> Transformer<T, R> for RcTransformer<T, R> {
78 fn apply(&self, input: T) -> R {
79 (self.function)(input)
80 }
81
82 // Generate all conversion methods using the unified macro
83 impl_rc_conversions!(
84 RcTransformer<T, R>,
85 BoxTransformer,
86 BoxTransformerOnce,
87 Fn(input: T) -> R
88 );
89}