Skip to main content

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