qubit_function/transformers/

bi_transformer_once.rs

/*******************************************************************************
 *
 *    Copyright (c) 2025 - 2026.
 *    Haixing Hu, Qubit Co. Ltd.
 *
 *    All rights reserved.
 *
 ******************************************************************************/
//! # BiTransformerOnce Types
//!
//! Provides Rust implementations of consuming bi-transformer traits similar to
//! Rust's `FnOnce` trait, but with value-oriented semantics for functional
//! programming patterns with two inputs.
//!
//! This module provides the `BiTransformerOnce<T, U, R>` trait and one-time use
//! implementations:
//!
//! - [`BoxBiTransformerOnce`]: Single ownership, one-time use
//!
//! # Author
//!
//! Haixing Hu
use crate::macros::{
    impl_box_once_conversions,
    impl_closure_once_trait,
};
use crate::predicates::bi_predicate::{
    BiPredicate,
    BoxBiPredicate,
};
use crate::transformers::{
    macros::{
        impl_box_conditional_transformer,
        impl_box_transformer_methods,
        impl_conditional_transformer_debug_display,
        impl_transformer_common_methods,
        impl_transformer_constant_method,
        impl_transformer_debug_display,
    },
    transformer_once::TransformerOnce,
};

// ============================================================================
// Core Trait
// ============================================================================

/// BiTransformerOnce trait - consuming bi-transformation that takes ownership
///
/// Defines the behavior of a consuming bi-transformer: converting two values of
/// types `T` and `U` to a value of type `R` by taking ownership of self and
/// both inputs. This trait is analogous to `FnOnce(T, U) -> R`.
///
/// # Type Parameters
///
/// * `T` - The type of the first input value (consumed)
/// * `U` - The type of the second input value (consumed)
/// * `R` - The type of the output value
///
/// # Author
///
/// Haixing Hu
pub trait BiTransformerOnce<T, U, R> {
    /// Transforms two input values, consuming self and both inputs
    ///
    /// # Parameters
    ///
    /// * `first` - The first input value (consumed)
    /// * `second` - The second input value (consumed)
    ///
    /// # Returns
    ///
    /// The transformed output value
    fn apply(self, first: T, second: U) -> R;

    /// Converts to BoxBiTransformerOnce
    ///
    /// **⚠️ Consumes `self`**: The original bi-transformer becomes unavailable
    /// after calling this method.
    ///
    /// # Returns
    ///
    /// Returns `BoxBiTransformerOnce<T, U, R>`
    fn into_box(self) -> BoxBiTransformerOnce<T, U, R>
    where
        Self: Sized + 'static,
    {
        BoxBiTransformerOnce::new(move |t: T, u: U| self.apply(t, u))
    }

    /// Converts bi-transformer to a closure
    ///
    /// **⚠️ Consumes `self`**: The original bi-transformer becomes unavailable
    /// after calling this method.
    ///
    /// # Returns
    ///
    /// Returns a closure that implements `FnOnce(T, U) -> R`
    fn into_fn(self) -> impl FnOnce(T, U) -> R
    where
        Self: Sized + 'static,
    {
        move |t: T, u: U| self.apply(t, u)
    }

    /// Converts bi-transformer to a boxed function pointer
    ///
    /// **📌 Borrows `&self`**: The original bi-transformer remains usable
    /// after calling this method.
    ///
    /// # Returns
    ///
    /// Returns a boxed function pointer that implements `FnOnce(T, U) -> R`
    ///
    /// # Examples
    ///
    /// ```rust
    /// use qubit_function::BiTransformerOnce;
    ///
    /// let add = |x: i32, y: i32| x + y;
    /// let func = add.to_fn();
    /// assert_eq!(func(20, 22), 42);
    /// ```
    fn to_box(&self) -> BoxBiTransformerOnce<T, U, R>
    where
        Self: Clone + 'static,
    {
        self.clone().into_box()
    }

    /// Converts bi-transformer to a closure
    ///
    /// **📌 Borrows `&self`**: The original bi-transformer remains usable
    /// after calling this method.
    ///
    /// # Returns
    ///
    /// Returns a closure that implements `FnOnce(T, U) -> R`
    ///
    /// # Examples
    ///
    /// ```rust
    /// use qubit_function::BiTransformerOnce;
    ///
    /// let add = |x: i32, y: i32| x + y;
    /// let func = add.to_fn();
    /// assert_eq!(func(20, 22), 42);
    /// ```
    fn to_fn(&self) -> impl FnOnce(T, U) -> R
    where
        Self: Clone + 'static,
    {
        self.clone().into_fn()
    }
}

// ============================================================================
// BoxBiTransformerOnce - Box<dyn FnOnce(T, U) -> R>
// ============================================================================

/// BoxBiTransformerOnce - consuming bi-transformer wrapper based on
/// `Box<dyn FnOnce>`
///
/// A bi-transformer wrapper that provides single ownership with one-time use
/// semantics. Consumes self and both input values.
///
/// # Features
///
/// - **Based on**: `Box<dyn FnOnce(T, U) -> R>`
/// - **Ownership**: Single ownership, cannot be cloned
/// - **Reusability**: Can only be called once (consumes self and inputs)
/// - **Thread Safety**: Not thread-safe (no `Send + Sync` requirement)
///
/// # Author
///
/// Haixing Hu
pub struct BoxBiTransformerOnce<T, U, R> {
    function: Box<dyn FnOnce(T, U) -> R>,
    name: Option<String>,
}

// Implement BoxBiTransformerOnce
impl<T, U, R> BoxBiTransformerOnce<T, U, R> {
    impl_transformer_common_methods!(
        BoxBiTransformerOnce<T, U, R>,
        (FnOnce(T, U) -> R + 'static),
        |f| Box::new(f)
    );

    impl_box_transformer_methods!(
        BoxBiTransformerOnce<T, U, R>,
        BoxConditionalBiTransformerOnce,
        TransformerOnce
    );
}

// Implement BiTransformerOnce trait for BoxBiTransformerOnce
impl<T, U, R> BiTransformerOnce<T, U, R> for BoxBiTransformerOnce<T, U, R> {
    fn apply(self, first: T, second: U) -> R {
        (self.function)(first, second)
    }

    impl_box_once_conversions!(
        BoxBiTransformerOnce<T, U, R>,
        BiTransformerOnce,
        FnOnce(T, U) -> R
    );
}

// Implement constant method for BoxBiTransformerOnce
impl_transformer_constant_method!(BoxBiTransformerOnce<T, U, R>);

// Use macro to generate Debug and Display implementations
impl_transformer_debug_display!(BoxBiTransformerOnce<T, U, R>);

// ============================================================================
// Blanket implementation for standard FnOnce trait
// ============================================================================

// Implement BiTransformerOnce for all FnOnce(T, U) -> R using macro
impl_closure_once_trait!(
    BiTransformerOnce<T, U, R>,
    apply,
    BoxBiTransformerOnce,
    FnOnce(first: T, second: U) -> R
);

// ============================================================================
// FnBiTransformerOnceOps - Extension trait for FnOnce(T, U) -> R bi-transformers
// ============================================================================

/// Extension trait for closures implementing `FnOnce(T, U) -> R`
///
/// Provides composition methods (`and_then`, `when`) for one-time use
/// bi-transformer closures and function pointers without requiring explicit
/// wrapping in `BoxBiTransformerOnce`.
///
/// This trait is automatically implemented for all closures and function
/// pointers that implement `FnOnce(T, U) -> R`.
///
/// # Design Rationale
///
/// While closures automatically implement `BiTransformerOnce<T, U, R>` through
/// blanket implementation, they don't have access to instance methods like
/// `and_then` and `when`. This extension trait provides those methods,
/// returning `BoxBiTransformerOnce` for maximum flexibility.
///
/// # Examples
///
/// ## Chain composition with and_then
///
/// ```rust
/// use qubit_function::{BiTransformerOnce, FnBiTransformerOnceOps};
///
/// let add = |x: i32, y: i32| x + y;
/// let double = |x: i32| x * 2;
///
/// let composed = add.and_then(double);
/// assert_eq!(composed.apply(3, 5), 16); // (3 + 5) * 2
/// ```
///
/// ## Conditional execution with when
///
/// ```rust
/// use qubit_function::{BiTransformerOnce, FnBiTransformerOnceOps};
///
/// let add = |x: i32, y: i32| x + y;
/// let multiply = |x: i32, y: i32| x * y;
///
/// let conditional = add.when(|x: &i32, y: &i32| *x > 0 && *y > 0).or_else(multiply);
/// assert_eq!(conditional.apply(5, 3), 8); // add
/// ```
///
/// # Author
///
/// Haixing Hu
pub trait FnBiTransformerOnceOps<T, U, R>: FnOnce(T, U) -> R + Sized {
    /// Chain composition - applies self first, then after
    ///
    /// Creates a new bi-transformer that applies this bi-transformer first,
    /// then applies the after transformer to the result. Consumes self and
    /// returns a `BoxBiTransformerOnce`.
    ///
    /// # Type Parameters
    ///
    /// * `S` - The output type of the after transformer
    /// * `F` - The type of the after transformer (must implement TransformerOnce<R, S>)
    ///
    /// # Parameters
    ///
    /// * `after` - The transformer to apply after self. **Note: This parameter
    ///   is passed by value and will transfer ownership.** Since this is a
    ///   `FnOnce` bi-transformer, the parameter will be consumed. Can be:
    ///   - A closure: `|x: R| -> S`
    ///   - A function pointer: `fn(R) -> S`
    ///   - A `BoxTransformerOnce<R, S>`
    ///   - Any type implementing `TransformerOnce<R, S>`
    ///
    /// # Returns
    ///
    /// A new `BoxBiTransformerOnce<T, U, S>` representing the composition
    ///
    /// # Examples
    ///
    /// ```rust
    /// use qubit_function::{BiTransformerOnce, FnBiTransformerOnceOps,
    ///     BoxTransformerOnce};
    ///
    /// let add = |x: i32, y: i32| x + y;
    /// let to_string = BoxTransformerOnce::new(|x: i32| x.to_string());
    ///
    /// // to_string is moved and consumed
    /// let composed = add.and_then(to_string);
    /// assert_eq!(composed.apply(20, 22), "42");
    /// // to_string.apply(10); // Would not compile - moved
    /// ```
    fn and_then<S, F>(self, after: F) -> BoxBiTransformerOnce<T, U, S>
    where
        Self: 'static,
        S: 'static,
        F: crate::transformers::transformer_once::TransformerOnce<R, S> + 'static,
        T: 'static,
        U: 'static,
        R: 'static,
    {
        BoxBiTransformerOnce::new(move |t: T, u: U| after.apply(self(t, u)))
    }

    /// Creates a conditional bi-transformer
    ///
    /// Returns a bi-transformer that only executes when a bi-predicate is
    /// satisfied. You must call `or_else()` to provide an alternative
    /// bi-transformer for when the condition is not satisfied.
    ///
    /// # Parameters
    ///
    /// * `predicate` - The condition to check. **Note: This parameter is passed
    ///   by value and will transfer ownership.** If you need to preserve the
    ///   original bi-predicate, clone it first (if it implements `Clone`).
    ///   Can be:
    ///   - A closure: `|x: &T, y: &U| -> bool`
    ///   - A function pointer: `fn(&T, &U) -> bool`
    ///   - A `BoxBiPredicate<T, U>`
    ///   - An `RcBiPredicate<T, U>`
    ///   - An `ArcBiPredicate<T, U>`
    ///   - Any type implementing `BiPredicate<T, U>`
    ///
    /// # Returns
    ///
    /// Returns `BoxConditionalBiTransformerOnce<T, U, R>`
    ///
    /// # Examples
    ///
    /// ## Basic usage with or_else
    ///
    /// ```rust
    /// use qubit_function::{BiTransformerOnce, FnBiTransformerOnceOps};
    ///
    /// let add = |x: i32, y: i32| x + y;
    /// let multiply = |x: i32, y: i32| x * y;
    /// let conditional = add.when(|x: &i32, y: &i32| *x > 0)
    ///     .or_else(multiply);
    ///
    /// assert_eq!(conditional.apply(5, 3), 8);
    /// ```
    ///
    /// ## Preserving bi-predicate with clone
    ///
    /// ```rust
    /// use qubit_function::{BiTransformerOnce, FnBiTransformerOnceOps,
    ///     RcBiPredicate};
    ///
    /// let add = |x: i32, y: i32| x + y;
    /// let both_positive = RcBiPredicate::new(|x: &i32, y: &i32|
    ///     *x > 0 && *y > 0);
    ///
    /// // Clone to preserve original bi-predicate
    /// let conditional = add.when(both_positive.clone())
    ///     .or_else(|x: i32, y: i32| x * y);
    ///
    /// assert_eq!(conditional.apply(5, 3), 8);
    ///
    /// // Original bi-predicate still usable
    /// assert!(both_positive.test(&5, &3));
    /// ```
    fn when<P>(self, predicate: P) -> BoxConditionalBiTransformerOnce<T, U, R>
    where
        Self: 'static,
        P: BiPredicate<T, U> + 'static,
        T: 'static,
        U: 'static,
        R: 'static,
    {
        BoxBiTransformerOnce::new(self).when(predicate)
    }
}

/// Blanket implementation of FnBiTransformerOnceOps for all closures
///
/// Automatically implements `FnBiTransformerOnceOps<T, U, R>` for any type that
/// implements `FnOnce(T, U) -> R`.
///
/// # Author
///
/// Haixing Hu
impl<T, U, R, F> FnBiTransformerOnceOps<T, U, R> for F where F: FnOnce(T, U) -> R {}

// ============================================================================
// BinaryOperatorOnce Trait - Marker trait for BiTransformerOnce<T, T, T>
// ============================================================================

/// BinaryOperatorOnce trait - marker trait for one-time use binary operators
///
/// A one-time use binary operator takes two values of type `T` and produces a
/// value of the same type `T`, consuming self in the process. This trait
/// extends `BiTransformerOnce<T, T, T>` to provide semantic clarity for
/// same-type binary operations with consuming semantics. Equivalent to Java's
/// `BinaryOperator<T>` but with FnOnce semantics.
///
/// # Automatic Implementation
///
/// This trait is automatically implemented for all types that implement
/// `BiTransformerOnce<T, T, T>`, so you don't need to implement it manually.
///
/// # Type Parameters
///
/// * `T` - The type of both input values and the output value
///
/// # Examples
///
/// ## Using in generic constraints
///
/// ```rust
/// use qubit_function::{BinaryOperatorOnce, BiTransformerOnce};
///
/// fn combine<T, O>(a: T, b: T, op: O) -> T
/// where
///     O: BinaryOperatorOnce<T>,
/// {
///     op.apply(a, b)
/// }
///
/// let multiply = |x: i32, y: i32| x * y;
/// assert_eq!(combine(6, 7, multiply), 42);
/// ```
///
/// # Author
///
/// Haixing Hu
pub trait BinaryOperatorOnce<T>: BiTransformerOnce<T, T, T> {}

/// Blanket implementation of BinaryOperatorOnce for all BiTransformerOnce<T, T, T>
///
/// This automatically implements `BinaryOperatorOnce<T>` for any type that
/// implements `BiTransformerOnce<T, T, T>`.
///
/// # Author
///
/// Haixing Hu
impl<F, T> BinaryOperatorOnce<T> for F
where
    F: BiTransformerOnce<T, T, T>,
{
    // empty
}

// ============================================================================
// Type Aliases for BinaryOperatorOnce (BiTransformerOnce<T, T, T>)
// ============================================================================

/// Type alias for `BoxBiTransformerOnce<T, T, T>`
///
/// Represents a one-time use binary operator that takes two values of type `T`
/// and produces a value of the same type `T`. Equivalent to Java's
/// `BinaryOperator<T>` with consuming semantics (FnOnce).
///
/// # Examples
///
/// ```rust
/// use qubit_function::{BoxBinaryOperatorOnce, BiTransformerOnce};
///
/// let add: BoxBinaryOperatorOnce<i32> = BoxBinaryOperatorOnce::new(|x, y| x + y);
/// assert_eq!(add.apply(20, 22), 42);
/// ```
///
/// # Author
///
/// Haixing Hu
pub type BoxBinaryOperatorOnce<T> = BoxBiTransformerOnce<T, T, T>;

// ============================================================================
// BoxConditionalBiTransformerOnce - Box-based Conditional BiTransformer
// ============================================================================

/// BoxConditionalBiTransformerOnce struct
///
/// A conditional consuming bi-transformer that only executes when a bi-predicate
/// is satisfied. Uses `BoxBiTransformerOnce` and `BoxBiPredicate` for single
/// ownership semantics.
///
/// This type is typically created by calling `BoxBiTransformerOnce::when()` and
/// is designed to work with the `or_else()` method to create if-then-else logic.
///
/// # Features
///
/// - **Single Ownership**: Not cloneable, consumes `self` on use
/// - **One-time Use**: Can only be called once
/// - **Conditional Execution**: Only transforms when bi-predicate returns `true`
/// - **Chainable**: Can add `or_else` branch to create if-then-else logic
///
/// # Examples
///
/// ## With or_else Branch
///
/// ```rust
/// use qubit_function::{BiTransformerOnce, BoxBiTransformerOnce};
///
/// let add = BoxBiTransformerOnce::new(|x: i32, y: i32| x + y);
/// let multiply = BoxBiTransformerOnce::new(|x: i32, y: i32| x * y);
/// let conditional = add.when(|x: &i32, y: &i32| *x > 0 && *y > 0).or_else(multiply);
/// assert_eq!(conditional.apply(5, 3), 8); // when branch executed
///
/// let add2 = BoxBiTransformerOnce::new(|x: i32, y: i32| x + y);
/// let multiply2 = BoxBiTransformerOnce::new(|x: i32, y: i32| x * y);
/// let conditional2 = add2.when(|x: &i32, y: &i32| *x > 0 && *y > 0).or_else(multiply2);
/// assert_eq!(conditional2.apply(-5, 3), -15); // or_else branch executed
/// ```
///
/// # Author
///
/// Haixing Hu
pub struct BoxConditionalBiTransformerOnce<T, U, R> {
    transformer: BoxBiTransformerOnce<T, U, R>,
    predicate: BoxBiPredicate<T, U>,
}

// Implement BoxConditionalTransformerOnce
impl_box_conditional_transformer!(
    BoxConditionalBiTransformerOnce<T, U, R>,
    BoxBiTransformerOnce,
    BiTransformerOnce
);

// Use macro to generate Debug and Display implementations
impl_conditional_transformer_debug_display!(BoxConditionalBiTransformerOnce<T, U, R>);