expectrl 0.8.0

A tool for automating terminal applications in Unix like Don libes expect
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

//! The module contains [`Lookup`].

use crate::{Captures, Error, Needle};

/// A helper action for an [`InteractSession`]
///
/// It holds a buffer to be able to run different checks using [`Needle`],
/// via [`Lookup::on`].
///
/// [`InteractSession`]: crate::interact::InteractSession
#[derive(Debug, Clone)]
pub struct Lookup {
    buf: Vec<u8>,
}

impl Lookup {
    /// Create a lookup object.
    pub fn new() -> Self {
        Self { buf: Vec::new() }
    }

    /// Checks whethere the buffer will be matched and returns [`Captures`] in such case.
    pub fn on<N>(&mut self, buf: &[u8], eof: bool, pattern: N) -> Result<Option<Captures>, Error>
    where
        N: Needle,
    {
        self.buf.extend(buf);
        check(&mut self.buf, pattern, eof)
    }

    /// Cleans internal buffer.
    ///
    /// So the next [`Lookup::on`] can be called with no other data involved.
    pub fn clear(&mut self) {
        self.buf.clear();
    }
}

impl Default for Lookup {
    fn default() -> Self {
        Self::new()
    }
}

fn check<N>(buf: &mut Vec<u8>, needle: N, eof: bool) -> Result<Option<Captures>, Error>
where
    N: Needle,
{
    // we ignore the check if buf is empty in just in case someone is matching 0 bytes.

    let found = needle.check(buf, eof)?;
    if found.is_empty() {
        return Ok(None);
    }

    let end_index = Captures::right_most_index(&found);
    let involved_bytes = buf[..end_index].to_vec();
    let found = Captures::new(involved_bytes, found);
    let _ = buf.drain(..end_index);

    Ok(Some(found))
}