nami 0.11.0

A powerful, lightweight reactive framework.
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

//! # Addition Operations for Signal Types
//!
//! This module provides functionality for adding two `Signal` values together.
//! It leverages the `zip` and `map` operations to combine computations and apply
//! the addition operation to their results.
//!
//! The addition is performed using the standard `Add` trait from Rust's core library,
//! allowing for flexible addition semantics depending on the types involved.

use core::ops::{Add, BitAnd, BitOr, BitXor, Div, Mul, Rem, Shl, Shr, Sub};

use crate::{
    Signal,
    map::{Map, map},
    zip::{Zip, zip},
};

macro_rules! define_binary_op {
    ($fn_name:ident, $trait:ident, $method:ident) => {
        #[doc = concat!(
                                                    "Combines two `Signal` sources using the `",
                                                    stringify!($method),
                                                    "` operator."
                                                )]
        #[allow(clippy::type_complexity)]
        pub fn $fn_name<A, B>(
            a: A,
            b: B,
        ) -> Map<
            Zip<A, B>,
            fn((A::Output, B::Output)) -> <A::Output as $trait<B::Output>>::Output,
            <A::Output as $trait<B::Output>>::Output,
        >
        where
            A: Signal + 'static,
            B: Signal + 'static,
            A::Output: $trait<B::Output> + Clone,
            B::Output: Clone,
        {
            let zip = zip(a, b);
            map(zip, |(a, b)| a.$method(b))
        }
    };
}

define_binary_op!(add, Add, add);
define_binary_op!(sub, Sub, sub);
define_binary_op!(mul, Mul, mul);
define_binary_op!(div, Div, div);
define_binary_op!(rem, Rem, rem);
define_binary_op!(bitand, BitAnd, bitand);
define_binary_op!(bitor, BitOr, bitor);
define_binary_op!(bitxor, BitXor, bitxor);
define_binary_op!(shl, Shl, shl);
define_binary_op!(shr, Shr, shr);

/// Returns the maximum value between two `Signal` values.
///
/// This function takes two values implementing the `Signal` trait with the same output type
/// and returns a new computation that, when executed, will produce the maximum of the outputs
/// from the two input computations.
///
/// # Type Parameters
///
/// * `A`: The first computation type that implements `Signal<Output = T>`.
/// * `B`: The second computation type that implements `Signal<Output = T>`.
/// * `T`: The output type that must implement `Ord` for comparison.
///
/// # Constraints
///
/// * Both `A` and `B` must have the same output type `T`.
/// * `T` must implement `Ord` to enable comparison operations.
/// * `T` must be `'static` for lifetime requirements.
///
/// # Returns
///
/// A new computation that will yield the maximum value between the outputs from computations `a` and `b`.
///
/// # Examples
///
/// ```
/// # use nami::{Signal, utils::max, binding, Binding};
/// let a: Binding<i32> = binding(10);
/// let b: Binding<i32> = binding(5);
/// let maximum = max(a, b);
/// assert_eq!(maximum.get(), 10);
/// ```
#[allow(clippy::type_complexity)]
pub fn max<A, B, T>(a: A, b: B) -> Map<Zip<A, B>, fn((T, T)) -> T, T>
where
    A: Signal<Output = T>,
    B: Signal<Output = T>,
    T: Ord + Clone + 'static,
{
    let zip = zip(a, b);
    map(zip, |(a, b)| core::cmp::max(a, b))
}

/// Returns the minimum value between two `Signal` values.
///
/// This function takes two values implementing the `Signal` trait with the same output type
/// and returns a new computation that, when executed, will produce the minimum of the outputs
/// from the two input computations.
///
/// # Type Parameters
///
/// * `A`: The first computation type that implements `Signal<Output = T>`.
/// * `B`: The second computation type that implements `Signal<Output = T>`.
/// * `T`: The output type that must implement `Ord` for comparison.
///
/// # Constraints
///
/// * Both `A` and `B` must have the same output type `T`.
/// * `T` must implement `Ord` to enable comparison operations.
/// * `T` must be `'static` for lifetime requirements.
///
/// # Returns
///
/// A new computation that will yield the minimum value between the outputs from computations `a` and `b`.
///
/// # Examples
///
/// ```
/// # use nami::{Signal, utils::min, binding, Binding};
/// let a: Binding<i32> = binding(10);
/// let b: Binding<i32> = binding(5);
/// let minimum = min(a, b);
/// assert_eq!(minimum.get(), 5);
/// ```
#[allow(clippy::type_complexity)]
pub fn min<A, B, T>(a: A, b: B) -> Map<Zip<A, B>, fn((T, T)) -> T, T>
where
    A: Signal<Output = T>,
    B: Signal<Output = T>,
    T: Ord + Clone + 'static,
{
    let zip = zip(a, b);
    map(zip, |(a, b)| core::cmp::min(a, b))
}

#[cfg(feature = "timer")]
pub(crate) async fn sleep(duration: core::time::Duration) {
    #[cfg(target_arch = "wasm32")]
    {
        use gloo_timers::future::sleep;
        sleep(duration).await;
    }
    #[cfg(not(target_arch = "wasm32"))]
    {
        use async_io::Timer;
        Timer::after(duration).await;
    }
}