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

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

//! # Supplier Common Methods Macro
//!
//! Generates common Supplier methods using shared implementations
//! (new, new_with_name, new_with_optional_name, name, set_name, constant)
//!
//! This macro uses `impl_common_new_methods` and `impl_common_name_methods`
//! to generate constructor and name management methods, plus a specialized
//! constant constructor for Supplier structs. This macro should be called
//! inside an impl block.
//!
//! The macro automatically detects the number of generic parameters and
//! generates the appropriate implementations for single-parameter or
//! two-parameter suppliers.
//!
//! # Parameters
//!
//! * `$struct_name<$generics>` - Struct name with generic parameters
//! * `$fn_trait_with_bounds` - Closure trait with complete bounds
//!   (e.g., `Fn() -> T + 'static`)
//! * `$wrapper_expr` - Wrapper expression (uses `f` for the closure)
//!
//! # Usage
//!
//! ```ignore
//! // Single generic parameter - Supplier
//! impl_supplier_common_methods!(
//!     BoxSupplier<T>,
//!     (Fn() -> T + 'static),
//!     |f| Box::new(f)
//! );
//!
//! // Single generic parameter - StatefulSupplier
//! impl_supplier_common_methods!(
//!     ArcStatefulSupplier<T>,
//!     (FnMut() -> T + Send + 'static),
//!     |f| Arc::new(Mutex::new(f))
//! );
//! ```
//!
//! # Generated Methods
//!
//! * `new()` - Creates a new supplier
//! * `new_with_name()` - Creates a named supplier
//! * `new_with_optional_name()` - Creates a supplier with optional name
//! * `name()` - Gets the name of the supplier
//! * `set_name()` - Sets the name of the supplier
//! * `constant()` - Creates a supplier that returns a constant value
//!
//! # Author
//!
//! Haixing Hu

/// Generates common Supplier methods using shared implementations
/// (new, new_with_name, new_with_optional_name, name, set_name, constant)
///
/// This macro uses `impl_common_new_methods` and `impl_common_name_methods`
/// to generate constructor and name management methods, plus a specialized
/// constant constructor for Supplier structs. This macro should be used
/// inside an existing impl block for the target struct.
///
/// The macro automatically detects the number of generic parameters and
/// generates the appropriate implementations for single-parameter or
/// two-parameter suppliers.
///
/// # Parameters
///
/// * `$struct_name<$generics>` - Struct name with generic parameters
/// * `$fn_trait_with_bounds` - Closure trait with complete bounds
///   (e.g., `Fn() -> T + 'static`)
/// * `$wrapper_expr` - Wrapper expression (uses `f` for the closure)
///
/// # Usage
///
/// ```ignore
/// // Single generic parameter - Supplier
/// impl_supplier_common_methods!(
///     BoxSupplier<T>,
///     (Fn() -> T + 'static),
///     |f| Box::new(f)
/// );
///
/// // Single generic parameter - StatefulSupplier
/// impl_supplier_common_methods!(
///     ArcStatefulSupplier<T>,
///     (FnMut() -> T + Send + 'static),
///     |f| Arc::new(Mutex::new(f))
/// );
/// ```
///
/// # Generated Methods
///
/// * `new()` - Creates a new supplier
/// * `new_with_name()` - Creates a named supplier
/// * `new_with_optional_name()` - Creates a supplier with optional name
/// * `name()` - Gets the name of the supplier
/// * `set_name()` - Sets the name of the supplier
/// * `constant()` - Creates a supplier that returns a constant value
///
/// # Author
///
/// Haixing Hu
macro_rules! impl_supplier_common_methods {
    // Single generic parameter - Supplier types
    (
        $struct_name:ident < $t:ident >,
        ($($fn_trait_with_bounds:tt)+),
        |$f:ident| $wrapper_expr:expr
    ) => {
        crate::macros::impl_common_new_methods!(
            ($($fn_trait_with_bounds)+),
            |$f| $wrapper_expr,
            "supplier"
        );

        crate::macros::impl_common_name_methods!("supplier");

        /// Creates a supplier that returns a constant value.
        ///
        /// Creates a supplier that always returns the same value. Useful for
        /// default values or placeholder implementations.
        ///
        /// # Parameters
        ///
        /// * `value` - The constant value to return
        ///
        /// # Returns
        ///
        /// Returns a new supplier instance that returns the constant value.
        #[inline]
        pub fn constant(value: $t) -> Self
        where
            $t: Clone + 'static,
        {
            Self::new(move || value.clone())
        }
    };
}

pub(crate) use impl_supplier_common_methods;