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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
//! Timer and delay helper commands
use cratecommands;
use crate;
use Duration;
/// Create a one-time delay command
///
/// This is a simpler alternative to `commands::tick` for one-time delays.
///
/// # Example
/// ```no_run
/// # use hojicha_core::async_helpers::delay;
/// # use std::time::Duration;
/// # #[derive(Clone)]
/// # enum Msg {
/// # DelayComplete,
/// # }
///
/// delay(Duration::from_secs(2), || Msg::DelayComplete)
/// # ;
/// ```
/// Create an interval timer that sends messages repeatedly
///
/// This is a higher-level alternative to `commands::every` that's easier to use.
///
/// # Example
/// ```no_run
/// # use hojicha_core::async_helpers::interval;
/// # use std::time::Duration;
/// # #[derive(Clone)]
/// # enum Msg {
/// # Tick(usize),
/// # }
///
/// // Sends Msg::Tick(0), Msg::Tick(1), Msg::Tick(2), ...
/// interval(Duration::from_secs(1), |count| Msg::Tick(count))
/// # ;
/// ```
/// Create a timeout command that cancels if not completed in time
///
/// # Example
/// ```no_run
/// # use hojicha_core::async_helpers::with_timeout;
/// # use hojicha_core::commands;
/// # use std::time::Duration;
/// # #[derive(Clone)]
/// # enum Msg {
/// # Success(String),
/// # Timeout,
/// # }
///
/// with_timeout(
/// Duration::from_secs(5),
/// commands::spawn(async {
/// // Some long operation
/// tokio::time::sleep(Duration::from_secs(10)).await;
/// Some(Msg::Success("Done".to_string()))
/// }),
/// || Msg::Timeout
/// )
/// # ;
/// ```
/// Create a debounced command that only executes after a period of inactivity
///
/// Useful for search-as-you-type or auto-save features.
///
/// # Example
/// ```no_run
/// # use hojicha_core::async_helpers::debounce;
/// # use std::time::Duration;
/// # #[derive(Clone)]
/// # enum Msg {
/// # Search(String),
/// # }
///
/// debounce(
/// Duration::from_millis(300),
/// "search query".to_string(),
/// |query| Msg::Search(query)
/// )
/// # ;
/// ```
/// Create a throttled command that limits execution rate
///
/// Useful for rate-limiting API calls or expensive operations.
///
/// # Example
/// ```no_run
/// # use hojicha_core::async_helpers::throttle;
/// # use std::time::Duration;
/// # #[derive(Clone)]
/// # enum Msg {
/// # Update,
/// # }
///
/// // Will execute at most once per second
/// throttle(Duration::from_secs(1), || Msg::Update)
/// # ;
/// ```