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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
use crate::{Captures, Error, Needle};
/// Expect trait provides common expect functions.
pub trait Expect {
/// Expect waits until a pattern is matched.
///
/// If the method returns [`Ok`] it is guaranteed that at least 1 match was found.
///
/// The match algorthm can be either
/// - gready
/// - lazy
///
/// You can set one via [`Session::set_expect_lazy`].
/// Default version is gready.
///
/// The implications are.
/// Imagine you use [`crate::Regex`] `"\d+"` to find a match.
/// And your process outputs `123`.
/// In case of lazy approach we will match `1`.
/// Where's in case of gready one we will match `123`.
///
/// # Example
///
#[cfg_attr(any(windows, feature = "async"), doc = "```ignore")]
#[cfg_attr(not(any(windows, feature = "async")), doc = "```")]
/// use expectrl::{Expect, spawn, Regex};
///
/// let mut p = spawn("echo 123").unwrap();
/// let m = p.expect(Regex("\\d+")).unwrap();
/// assert_eq!(m.get(0).unwrap(), b"123");
/// ```
///
#[cfg_attr(any(windows, feature = "async"), doc = "```ignore")]
#[cfg_attr(not(any(windows, feature = "async")), doc = "```")]
/// use expectrl::{Expect, spawn, Regex};
///
/// let mut p = spawn("echo 123").unwrap();
/// p.set_expect_lazy(true);
/// let m = p.expect(Regex("\\d+")).unwrap();
/// assert_eq!(m.get(0).unwrap(), b"1");
/// ```
///
/// This behaviour is different from [`Expect::check`].
///
/// It returns an error if timeout is reached.
/// You can specify a timeout value by [`Session::set_expect_timeout`] method.
///
/// [`Session::set_expect_timeout`]: crate::Session::set_expect_timeout
/// [`Session::set_expect_lazy`]: crate::Session::set_expect_lazy
fn expect<N>(&mut self, needle: N) -> Result<Captures, Error>
where
N: Needle;
/// Check verifies if a pattern is matched.
/// Returns empty found structure if nothing found.
///
/// Is a non blocking version of [`Expect::expect`].
/// But its strategy of matching is different from it.
/// It makes search against all bytes available.
///
/// # Example
///
#[cfg_attr(
any(windows, target_os = "macos", feature = "async"),
doc = "```ignore"
)]
#[cfg_attr(not(any(windows, target_os = "macos", feature = "async")), doc = "```")]
/// use expectrl::{spawn, Regex, Expect};
/// use std::time::Duration;
///
/// let mut p = spawn("echo 123").unwrap();
/// #
/// # // wait to guarantee that check echo worked out (most likely)
/// # std::thread::sleep(Duration::from_millis(500));
/// #
/// let m = p.check(Regex("\\d+")).unwrap();
/// assert_eq!(m.get(0).unwrap(), b"123");
/// ```
fn check<N>(&mut self, needle: N) -> Result<Captures, Error>
where
N: Needle;
/// The functions checks if a pattern is matched.
/// It doesn’t consumes bytes from stream.
///
/// Its strategy of matching is different from the one in [`Expect::expect`].
/// It makes search agains all bytes available.
///
/// If you want to get a matched result [`Expect::check`] and [`Expect::expect`] is a better option.
/// Because it is not guaranteed that [`Expect::check`] or [`Expect::expect`] with the same parameters:
/// - will successed even right after Expect::is_matched call.
/// - will operate on the same bytes.
///
/// IMPORTANT:
///
/// If you call this method with [`Eof`] pattern be aware that eof
/// indication MAY be lost on the next interactions.
/// It depends from a process you spawn.
/// So it might be better to use [`Expect::check`] or [`Expect::expect`] with Eof.
///
/// # Example
///
#[cfg_attr(any(windows, feature = "async"), doc = "```ignore")]
#[cfg_attr(not(any(windows, feature = "async")), doc = "```")]
/// use expectrl::{spawn, Regex, Expect};
/// use std::time::Duration;
///
/// let mut p = spawn("cat").unwrap();
/// p.send_line("123");
/// # // wait to guarantee that check echo worked out (most likely)
/// # std::thread::sleep(Duration::from_secs(1));
/// let m = p.is_matched(Regex("\\d+")).unwrap();
/// assert_eq!(m, true);
/// ```
///
/// [`Eof`]: crate::Eof
fn is_matched<N>(&mut self, needle: N) -> Result<bool, Error>
where
N: Needle;
/// Send buffer to the stream.
///
/// You may also use methods from [std::io::Write] instead.
///
/// # Example
///
#[cfg_attr(any(windows, feature = "async"), doc = "```ignore")]
#[cfg_attr(not(any(windows, feature = "async")), doc = "```")]
/// use expectrl::{spawn, ControlCode, Expect};
///
/// let mut proc = spawn("cat").unwrap();
///
/// proc.send("Hello");
/// proc.send(b"World");
/// proc.send(ControlCode::try_from("^C").unwrap());
/// ```
fn send<B>(&mut self, buf: B) -> Result<(), Error>
where
B: AsRef<[u8]>;
/// Send line to the stream.
///
/// # Example
///
#[cfg_attr(any(windows, feature = "async"), doc = "```ignore")]
#[cfg_attr(not(any(windows, feature = "async")), doc = "```")]
/// use expectrl::{spawn, ControlCode, Expect};
///
/// let mut proc = spawn("cat").unwrap();
///
/// proc.send_line("Hello");
/// proc.send_line(b"World");
/// proc.send_line(ControlCode::try_from("^C").unwrap());
/// ```
fn send_line<B>(&mut self, buf: B) -> Result<(), Error>
where
B: AsRef<[u8]>;
}
impl<T> Expect for &mut T
where
T: Expect,
{
fn expect<N>(&mut self, needle: N) -> Result<Captures, Error>
where
N: Needle,
{
T::expect(self, needle)
}
fn check<N>(&mut self, needle: N) -> Result<Captures, Error>
where
N: Needle,
{
T::check(self, needle)
}
fn is_matched<N>(&mut self, needle: N) -> Result<bool, Error>
where
N: Needle,
{
T::is_matched(self, needle)
}
fn send<B>(&mut self, buf: B) -> Result<(), Error>
where
B: AsRef<[u8]>,
{
T::send(self, buf)
}
fn send_line<B>(&mut self, buf: B) -> Result<(), Error>
where
B: AsRef<[u8]>,
{
T::send_line(self, buf)
}
}
#[cfg(feature = "async")]
/// Expect trait provides common expect functions.
pub trait AsyncExpect {
/// Expect waits until a pattern is matched.
///
/// If the method returns [Ok] it is guaranteed that at least 1 match was found.
///
/// The match algorthm can be either
/// - gready
/// - lazy
///
/// You can set one via [Session::set_expect_lazy].
/// Default version is gready.
///
/// The implications are.
///
/// Imagine you use [crate::Regex] `"\d+"` to find a match.
/// And your process outputs `123`.
/// In case of lazy approach we will match `1`.
/// Where's in case of gready one we will match `123`.
///
/// # Example
///
#[cfg_attr(windows, doc = "```no_run")]
#[cfg_attr(unix, doc = "```")]
/// # futures_lite::future::block_on(async {
/// use expectrl::{AsyncExpect, spawn, Regex};
///
/// let mut p = spawn("echo 123").unwrap();
/// let m = p.expect(Regex("\\d+")).await.unwrap();
/// assert_eq!(m.get(0).unwrap(), b"123");
/// # });
/// ```
///
#[cfg_attr(windows, doc = "```no_run")]
#[cfg_attr(unix, doc = "```")]
/// # futures_lite::future::block_on(async {
/// use expectrl::{AsyncExpect, spawn, Regex};
///
/// let mut p = spawn("echo 123").unwrap();
/// p.set_expect_lazy(true);
/// let m = p.expect(Regex("\\d+")).await.unwrap();
/// assert_eq!(m.get(0).unwrap(), b"1");
/// # });
/// ```
///
/// This behaviour is different from [Session::check].
///
/// It returns an error if timeout is reached.
/// You can specify a timeout value by [Session::set_expect_timeout] method.
async fn expect<N>(&mut self, needle: N) -> Result<Captures, Error>
where
N: Needle;
/// Check checks if a pattern is matched.
/// Returns empty found structure if nothing found.
///
/// Is a non blocking version of [Session::expect].
/// But its strategy of matching is different from it.
/// It makes search agains all bytes available.
///
#[cfg_attr(any(target_os = "macos", windows), doc = "```no_run")]
#[cfg_attr(not(any(target_os = "macos", windows)), doc = "```")]
/// # futures_lite::future::block_on(async {
/// use expectrl::{AsyncExpect, spawn, Regex};
///
/// let mut p = spawn("echo 123").unwrap();
/// // wait to guarantee that check will successed (most likely)
/// std::thread::sleep(std::time::Duration::from_secs(1));
/// let m = p.check(Regex("\\d+")).await.unwrap();
/// assert_eq!(m.get(0).unwrap(), b"123");
/// # });
/// ```
async fn check<N>(&mut self, needle: N) -> Result<Captures, Error>
where
N: Needle;
/// Is matched checks if a pattern is matched.
/// It doesn't consumes bytes from stream.
async fn is_matched<N>(&mut self, needle: N) -> Result<bool, Error>
where
N: Needle;
/// Send text to child’s STDIN.
///
/// You can also use methods from [std::io::Write] instead.
///
/// # Example
///
/// ```
/// use expectrl::{spawn, ControlCode, AsyncExpect};
///
/// let mut proc = spawn("cat").unwrap();
///
/// # futures_lite::future::block_on(async {
/// proc.send("Hello").await;
/// proc.send(b"World").await;
/// proc.send(ControlCode::try_from("^C").unwrap()).await;
/// # });
/// ```
async fn send<B>(&mut self, buf: B) -> Result<(), Error>
where
B: AsRef<[u8]>;
/// Send a line to child’s STDIN.
///
/// # Example
///
/// ```
/// use expectrl::{spawn, ControlCode, AsyncExpect};
///
/// let mut proc = spawn("cat").unwrap();
///
/// # futures_lite::future::block_on(async {
/// proc.send_line("Hello").await;
/// proc.send_line(b"World").await;
/// proc.send_line(ControlCode::try_from("^C").unwrap()).await;
/// # });
/// ```
async fn send_line<B>(&mut self, buf: B) -> Result<(), Error>
where
B: AsRef<[u8]>;
}
#[cfg(feature = "async")]
impl<T> AsyncExpect for &mut T
where
T: AsyncExpect,
{
async fn expect<N>(&mut self, needle: N) -> Result<Captures, Error>
where
N: Needle,
{
T::expect(self, needle).await
}
async fn check<N>(&mut self, needle: N) -> Result<Captures, Error>
where
N: Needle,
{
T::check(self, needle).await
}
async fn is_matched<N>(&mut self, needle: N) -> Result<bool, Error>
where
N: Needle,
{
T::is_matched(self, needle).await
}
async fn send<B>(&mut self, buf: B) -> Result<(), Error>
where
B: AsRef<[u8]>,
{
T::send(self, buf).await
}
async fn send_line<B>(&mut self, buf: B) -> Result<(), Error>
where
B: AsRef<[u8]>,
{
T::send_line(self, buf).await
}
}