qubit-function 0.8.3

Common functional programming type aliases for Rust, providing Java-style functional interfaces
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238

/*******************************************************************************
 *
 *    Copyright (c) 2025 - 2026.
 *    Haixing Hu, Qubit Co. Ltd.
 *
 *    All rights reserved.
 *
 ******************************************************************************/

//! # Transformer Constant Method Macro
//!
//! Generates constant method implementation for transformer types.
//!
//! This macro generates an `impl` block that implements the `constant()` method
//! for transformer types that return a constant value regardless of input.
//!
//! This macro supports various transformer types through pattern matching on
//! the struct signature.
//!
//! # Parameters
//!
//! * `$struct_name<$generics>` - The struct name with its generic parameters
//!   - Single parameter: `BoxTransformer<T, R>`
//!   - Two parameters: `BoxBiTransformer<T, U, R>`
//!   - Stateful variants: `BoxStatefulTransformer<T, R>`
//!
//! # Usage
//!
//! ```ignore
//! // Single-parameter transformer
//! impl_transformer_constant_method!(BoxTransformer<T, R>);
//!
//! // Two-parameter transformer
//! impl_transformer_constant_method!(BoxBiTransformer<T, U, R>);
//!
//! // Stateful transformer
//! impl_transformer_constant_method!(BoxStatefulTransformer<T, R>);
//! ```
//!
//! # Generated Implementation
//!
//! For single-parameter transformers, the macro generates:
//!
//! ```ignore
//! impl<T, R> BoxTransformer<T, R>
//! where
//!     R: Clone + 'static,
//! {
//!     /// Creates a constant transformer
//!     ///
//!     /// # Examples
//!     ///
//!     /// ```rust
//!     /// use qubit_function::{BoxTransformer, Transformer};
//!     ///
//!     /// let constant = BoxTransformer::constant("hello");
//!     /// assert_eq!(constant.apply(123), "hello");
//!     /// ```
//!     pub fn constant(value: R) -> BoxTransformer<T, R> {
//!         BoxTransformer::new(move |_| value.clone())
//!     }
//! }
//! ```
//!
//! # Author
//!
//! Haixing Hu

/// Generates constant method implementation for transformer types.
///
/// This macro generates an `impl` block that implements the `constant()` method
/// for transformer types that return a constant value regardless of input.
///
/// This macro supports various transformer types through pattern matching on
/// the struct signature.
///
/// # Parameters
///
/// * `$struct_name<$generics>` - The struct name with its generic parameters
///   - Single parameter: `BoxTransformer<T, R>`
///   - Two parameters: `BoxBiTransformer<T, U, R>`
///   - Stateful variants: `BoxStatefulTransformer<T, R>`
///
/// # Usage
///
/// ```rust,ignore
/// // Single-parameter transformer
/// impl_transformer_constant_method!(BoxTransformer<T, R>);
///
/// // Two-parameter transformer
/// impl_transformer_constant_method!(BoxBiTransformer<T, U, R>);
///
/// // Stateful transformer
/// impl_transformer_constant_method!(BoxStatefulTransformer<T, R>);
/// ```
///
/// # Author
///
/// Haixing Hu
macro_rules! impl_transformer_constant_method {
    // Single-parameter transformer (BoxTransformer, RcTransformer, BoxTransformerOnce)
    ($struct_name:ident < $t:ident, $r:ident >) => {
        impl<$t, $r> $struct_name<$t, $r> {
            /// Creates a constant transformer
            ///
            /// # Examples
            ///
            #[doc = concat!("/// ```rust\n/// use qubit_function::{", stringify!($struct_name), ", Transformer};\n///\n/// let constant = ", stringify!($struct_name), "::constant(\"hello\");\n/// assert_eq!(constant.apply(123), \"hello\");\n/// ```")]
            pub fn constant(value: $r) -> $struct_name<$t, $r>
            where
                $r: Clone + 'static,
            {
                $struct_name::new(move |_| value.clone())
            }
        }
    };

    // Thread-safe single-parameter transformer (ArcTransformer)
    (thread_safe $struct_name:ident < $t:ident, $r:ident >) => {
        impl<$t, $r> $struct_name<$t, $r> {
            /// Creates a constant transformer
            ///
            /// # Examples
            ///
            #[doc = concat!("/// ```rust\n/// use qubit_function::{", stringify!($struct_name), ", Transformer};\n///\n/// let constant = ", stringify!($struct_name), "::constant(\"hello\");\n/// assert_eq!(constant.apply(123), \"hello\");\n/// ```")]
            pub fn constant(value: $r) -> $struct_name<$t, $r>
            where
                $r: Clone + Send + Sync + 'static,
            {
                $struct_name::new(move |_| value.clone())
            }
        }
    };

    // Two-parameter transformer (BoxBiTransformer, RcBiTransformer, BoxBiTransformerOnce)
    ($struct_name:ident < $t:ident, $u:ident, $r:ident >) => {
        impl<$t, $u, $r> $struct_name<$t, $u, $r> {
            /// Creates a constant bi-transformer
            ///
            /// # Examples
            ///
            #[doc = concat!("/// ```rust\n/// use qubit_function::{", stringify!($struct_name), ", BiTransformer};\n///\n/// let constant = ", stringify!($struct_name), "::constant(\"hello\");\n/// assert_eq!(constant.apply(123, 456), \"hello\");\n/// ```")]
            pub fn constant(value: $r) -> $struct_name<$t, $u, $r>
            where
                $r: Clone + 'static,
            {
                $struct_name::new(move |_, _| value.clone())
            }
        }
    };

    // Thread-safe two-parameter transformer (ArcBiTransformer)
    (thread_safe $struct_name:ident < $t:ident, $u:ident, $r:ident >) => {
        impl<$t, $u, $r> $struct_name<$t, $u, $r> {
            /// Creates a constant bi-transformer
            ///
            /// # Examples
            ///
            #[doc = concat!("/// ```rust\n/// use qubit_function::{", stringify!($struct_name), ", BiTransformer};\n///\n/// let constant = ", stringify!($struct_name), "::constant(\"hello\");\n/// assert_eq!(constant.apply(123, 456), \"hello\");\n/// ```")]
            pub fn constant(value: $r) -> $struct_name<$t, $u, $r>
            where
                $r: Clone + Send + Sync + 'static,
            {
                $struct_name::new(move |_, _| value.clone())
            }
        }
    };

    // Stateful transformer (BoxStatefulTransformer, RcStatefulTransformer)
    (stateful $struct_name:ident < $t:ident, $r:ident >) => {
        impl<$t, $r> $struct_name<$t, $r> {
            /// Creates a constant transformer
            ///
            /// # Examples
            ///
            #[doc = concat!("/// ```rust\n/// use qubit_function::{", stringify!($struct_name), ", StatefulTransformer};\n///\n/// let mut constant = ", stringify!($struct_name), "::constant(\"hello\");\n/// assert_eq!(constant.apply(123), \"hello\");\n/// ```")]
            pub fn constant(value: $r) -> $struct_name<$t, $r>
            where
                $r: Clone + 'static,
            {
                $struct_name::new(move |_| value.clone())
            }
        }
    };

    // Thread-safe stateful transformer (ArcStatefulTransformer)
    (stateful thread_safe $struct_name:ident < $t:ident, $r:ident >) => {
        impl<$t, $r> $struct_name<$t, $r> {
            /// Creates a constant transformer
            ///
            /// # Examples
            ///
            #[doc = concat!("/// ```rust\n/// use qubit_function::{", stringify!($struct_name), ", StatefulTransformer};\n///\n/// let mut constant = ", stringify!($struct_name), "::constant(\"hello\");\n/// assert_eq!(constant.apply(123), \"hello\");\n/// ```")]
            pub fn constant(value: $r) -> $struct_name<$t, $r>
            where
                $r: Clone + Send + 'static,
            {
                $struct_name::new(move |_| value.clone())
            }
        }
    };

    // Stateful bi-transformer (BoxStatefulBiTransformer, RcStatefulBiTransformer)
    (stateful $struct_name:ident < $t:ident, $u:ident, $r:ident >) => {
        impl<$t, $u, $r> $struct_name<$t, $u, $r> {
            /// Creates a constant bi-transformer
            ///
            /// # Examples
            ///
            #[doc = concat!("/// ```rust\n/// use qubit_function::{", stringify!($struct_name), ", StatefulBiTransformer};\n///\n/// let constant = ", stringify!($struct_name), "::constant(\"hello\");\n/// assert_eq!(constant.apply(123, 456), \"hello\");\n/// ```")]
            pub fn constant(value: $r) -> $struct_name<$t, $u, $r>
            where
                $r: Clone + 'static,
            {
                $struct_name::new(move |_, _| value.clone())
            }
        }
    };

    // Thread-safe stateful bi-transformer (ArcStatefulBiTransformer)
    (stateful thread_safe $struct_name:ident < $t:ident, $u:ident, $r:ident >) => {
        impl<$t, $u, $r> $struct_name<$t, $u, $r> {
            /// Creates a constant bi-transformer
            ///
            /// # Examples
            ///
            #[doc = concat!("/// ```rust\n/// use qubit_function::{", stringify!($struct_name), ", StatefulBiTransformer};\n///\n/// let constant = ", stringify!($struct_name), "::constant(\"hello\");\n/// assert_eq!(constant.apply(123, 456), \"hello\");\n/// ```")]
            pub fn constant(value: $r) -> $struct_name<$t, $u, $r>
            where
                $r: Clone + Send + 'static,
            {
                $struct_name::new(move |_, _| value.clone())
            }
        }
    };
}

pub(crate) use impl_transformer_constant_method;