ferroui-dynamic-data 0.3.0

A port of DynamicData for FerroUI: reactive collections, change sets, observable caches and lists with their operators, independent of the user interface
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

//! `BatchIf` (`Cache/ObservableCacheEx.BatchIf.cs`).

macro_rules! batch_if_methods {
    () => {
        /// The change sets, held back while `pause_if_true_selector` last gave `true` and delivered
        /// as one when it gives `false` (`BatchIf(IObservable<bool>)`).
        fn batch_if(&self, pause_if_true_selector: std::rc::Rc<dyn ferroui_system::IObservable<bool>>) -> std::rc::Rc<dyn ferroui_system::IObservable<crate::cache::ChangeSet<T, K>>> {
            crate::cache::internal::batch_if(self.change_sets(), pause_if_true_selector, None, false, None, None)
        }

        /// [`batch_if`](Self::batch_if) with the timers on `scheduler` (`BatchIf(IObservable<bool>,
        /// IScheduler?)`).
        fn batch_if_on(
            &self,
            pause_if_true_selector: std::rc::Rc<dyn ferroui_system::IObservable<bool>>,
            scheduler: std::rc::Rc<dyn ferroui_reactive::concurrency::IScheduler>,
        ) -> std::rc::Rc<dyn ferroui_system::IObservable<crate::cache::ChangeSet<T, K>>> {
            crate::cache::internal::batch_if(self.change_sets(), pause_if_true_selector, None, false, None, Some(scheduler))
        }

        /// [`batch_if`](Self::batch_if), paused from the start when `initial_pause_state` is true
        /// (`BatchIf(IObservable<bool>, bool, IScheduler? = null)`).
        fn batch_if_with_initial(
            &self,
            pause_if_true_selector: std::rc::Rc<dyn ferroui_system::IObservable<bool>>,
            initial_pause_state: bool,
        ) -> std::rc::Rc<dyn ferroui_system::IObservable<crate::cache::ChangeSet<T, K>>> {
            crate::cache::internal::batch_if(self.change_sets(), pause_if_true_selector, None, initial_pause_state, None, None)
        }

        /// [`batch_if_with_initial`](Self::batch_if_with_initial) on `scheduler`.
        fn batch_if_with_initial_on(
            &self,
            pause_if_true_selector: std::rc::Rc<dyn ferroui_system::IObservable<bool>>,
            initial_pause_state: bool,
            scheduler: std::rc::Rc<dyn ferroui_reactive::concurrency::IScheduler>,
        ) -> std::rc::Rc<dyn ferroui_system::IObservable<crate::cache::ChangeSet<T, K>>> {
            crate::cache::internal::batch_if(self.change_sets(), pause_if_true_selector, None, initial_pause_state, None, Some(scheduler))
        }

        /// [`batch_if`](Self::batch_if) whose pause ends by itself after `time_out`
        /// (`BatchIf(IObservable<bool>, TimeSpan?, IScheduler? = null)`).
        fn batch_if_with_time_out(
            &self,
            pause_if_true_selector: std::rc::Rc<dyn ferroui_system::IObservable<bool>>,
            time_out: Option<std::time::Duration>,
        ) -> std::rc::Rc<dyn ferroui_system::IObservable<crate::cache::ChangeSet<T, K>>> {
            crate::cache::internal::batch_if(self.change_sets(), pause_if_true_selector, time_out, false, None, None)
        }

        /// [`batch_if_with_time_out`](Self::batch_if_with_time_out) on `scheduler`.
        fn batch_if_with_time_out_on(
            &self,
            pause_if_true_selector: std::rc::Rc<dyn ferroui_system::IObservable<bool>>,
            time_out: Option<std::time::Duration>,
            scheduler: std::rc::Rc<dyn ferroui_reactive::concurrency::IScheduler>,
        ) -> std::rc::Rc<dyn ferroui_system::IObservable<crate::cache::ChangeSet<T, K>>> {
            crate::cache::internal::batch_if(self.change_sets(), pause_if_true_selector, time_out, false, None, Some(scheduler))
        }

        /// [`batch_if_with_time_out`](Self::batch_if_with_time_out), paused from the start when
        /// `initial_pause_state` is true (`BatchIf(IObservable<bool>, bool, TimeSpan?, IScheduler? =
        /// null)`).
        fn batch_if_with_initial_and_time_out(
            &self,
            pause_if_true_selector: std::rc::Rc<dyn ferroui_system::IObservable<bool>>,
            initial_pause_state: bool,
            time_out: Option<std::time::Duration>,
        ) -> std::rc::Rc<dyn ferroui_system::IObservable<crate::cache::ChangeSet<T, K>>> {
            crate::cache::internal::batch_if(self.change_sets(), pause_if_true_selector, time_out, initial_pause_state, None, None)
        }

        /// [`batch_if_with_initial_and_time_out`](Self::batch_if_with_initial_and_time_out) on
        /// `scheduler`.
        fn batch_if_with_initial_and_time_out_on(
            &self,
            pause_if_true_selector: std::rc::Rc<dyn ferroui_system::IObservable<bool>>,
            initial_pause_state: bool,
            time_out: Option<std::time::Duration>,
            scheduler: std::rc::Rc<dyn ferroui_reactive::concurrency::IScheduler>,
        ) -> std::rc::Rc<dyn ferroui_system::IObservable<crate::cache::ChangeSet<T, K>>> {
            crate::cache::internal::batch_if(self.change_sets(), pause_if_true_selector, time_out, initial_pause_state, None, Some(scheduler))
        }

        /// [`batch_if`](Self::batch_if) that also delivers, and pauses again, at each value of
        /// `timer`; the pause ends when `timer` ends (`BatchIf(IObservable<bool>, IScheduler?,
        /// IObservable<Unit>?)`).
        fn batch_if_with_timer(
            &self,
            pause_if_true_selector: std::rc::Rc<dyn ferroui_system::IObservable<bool>>,
            timer: Option<std::rc::Rc<dyn ferroui_system::IObservable<()>>>,
        ) -> std::rc::Rc<dyn ferroui_system::IObservable<crate::cache::ChangeSet<T, K>>> {
            crate::cache::internal::batch_if(self.change_sets(), pause_if_true_selector, None, false, timer, None)
        }

        /// [`batch_if_with_timer`](Self::batch_if_with_timer) on `scheduler`.
        fn batch_if_with_timer_on(
            &self,
            pause_if_true_selector: std::rc::Rc<dyn ferroui_system::IObservable<bool>>,
            timer: Option<std::rc::Rc<dyn ferroui_system::IObservable<()>>>,
            scheduler: std::rc::Rc<dyn ferroui_reactive::concurrency::IScheduler>,
        ) -> std::rc::Rc<dyn ferroui_system::IObservable<crate::cache::ChangeSet<T, K>>> {
            crate::cache::internal::batch_if(self.change_sets(), pause_if_true_selector, None, false, timer, Some(scheduler))
        }

        /// [`batch_if_with_timer`](Self::batch_if_with_timer), paused from the start when
        /// `initial_pause_state` is true (`BatchIf(IObservable<bool>, bool, IObservable<Unit>?,
        /// IScheduler? = null)`).
        fn batch_if_with_initial_and_timer(
            &self,
            pause_if_true_selector: std::rc::Rc<dyn ferroui_system::IObservable<bool>>,
            initial_pause_state: bool,
            timer: Option<std::rc::Rc<dyn ferroui_system::IObservable<()>>>,
        ) -> std::rc::Rc<dyn ferroui_system::IObservable<crate::cache::ChangeSet<T, K>>> {
            crate::cache::internal::batch_if(self.change_sets(), pause_if_true_selector, None, initial_pause_state, timer, None)
        }

        /// [`batch_if_with_initial_and_timer`](Self::batch_if_with_initial_and_timer) on `scheduler`.
        fn batch_if_with_initial_and_timer_on(
            &self,
            pause_if_true_selector: std::rc::Rc<dyn ferroui_system::IObservable<bool>>,
            initial_pause_state: bool,
            timer: Option<std::rc::Rc<dyn ferroui_system::IObservable<()>>>,
            scheduler: std::rc::Rc<dyn ferroui_reactive::concurrency::IScheduler>,
        ) -> std::rc::Rc<dyn ferroui_system::IObservable<crate::cache::ChangeSet<T, K>>> {
            crate::cache::internal::batch_if(self.change_sets(), pause_if_true_selector, None, initial_pause_state, timer, Some(scheduler))
        }
    };
}
pub(crate) use batch_if_methods;