qubit_function/transformers/bi_transformer/box_bi_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 `BoxBiTransformer` public type.
12
13#![allow(unused_imports)]
14
15use super::*;
16
17// ============================================================================
18// BoxBiTransformer - Box<dyn Fn(T, U) -> R>
19// ============================================================================
20
21/// BoxBiTransformer - bi-transformer wrapper based on `Box<dyn Fn>`
22///
23/// A bi-transformer wrapper that provides single ownership with reusable
24/// transformation. The bi-transformer consumes both inputs and can be called
25/// multiple times.
26///
27/// # Features
28///
29/// - **Based on**: `Box<dyn Fn(T, U) -> R>`
30/// - **Ownership**: Single ownership, cannot be cloned
31/// - **Reusability**: Can be called multiple times (each call consumes its
32/// inputs)
33/// - **Thread Safety**: Not thread-safe (no `Send + Sync` requirement)
34///
35pub struct BoxBiTransformer<T, U, R> {
36 pub(super) function: Box<dyn Fn(T, U) -> R>,
37 pub(super) name: Option<String>,
38}
39
40// Implement BoxBiTransformer
41impl<T, U, R> BoxBiTransformer<T, U, R> {
42 impl_transformer_common_methods!(
43 BoxBiTransformer<T, U, R>,
44 (Fn(T, U) -> R + 'static),
45 |f| Box::new(f)
46 );
47
48 impl_box_transformer_methods!(
49 BoxBiTransformer<T, U, R>,
50 BoxConditionalBiTransformer,
51 Transformer
52 );
53}
54
55// Implement constant method for BoxBiTransformer
56impl_transformer_constant_method!(BoxBiTransformer<T, U, R>);
57
58// Implement Debug and Display for BoxBiTransformer
59impl_transformer_debug_display!(BoxBiTransformer<T, U, R>);
60
61// Implement BiTransformer trait for BoxBiTransformer
62impl<T, U, R> BiTransformer<T, U, R> for BoxBiTransformer<T, U, R> {
63 fn apply(&self, first: T, second: U) -> R {
64 (self.function)(first, second)
65 }
66
67 // Generates: into_box(), into_rc(), into_fn(), into_once()
68 impl_box_conversions!(
69 BoxBiTransformer<T, U, R>,
70 RcBiTransformer,
71 Fn(T, U) -> R,
72 BoxBiTransformerOnce
73 );
74}