Struct SequenceWatcher

pub struct SequenceWatcher<T>
where
    T: PartialEq + Clone + Debug,
{ /* private fields */ }

Monitors a stream of data for a sequence.

Examples

use seq_watcher::SequenceWatcher;

const CTRL_C: u8 = 3;

// Watch the input stream for two consecutive <CTRL-C> characters.
let watcher = SequenceWatcher::new(&[CTRL_C, CTRL_C]);

for b in b'a'..=b'z' {
    assert_eq!(false, watcher.check(&b));   // Send single ASCII byte
    assert_eq!(false, watcher.check(&CTRL_C));   // Send single <Ctrl-C>
}
assert_eq!(true, watcher.check(&CTRL_C));    // Send a second <Ctrl-C>

Implementations

impl<T: PartialEq + Clone + Debug> SequenceWatcher<T>

pub fn new(seq: &[T]) -> Self

Create a new SequenceWatcher from a slice of data. The data type can be anything with PartialEq, Debug, and Clone traits.

Internally, the SequenceWatcher structure contains a vector of the sequence it monitors and an index indicating where in the sequence it is expecting next.

Examples

let watcher = SequenceWatcher::new(&['q', 'u', 'i', 't']);

assert_eq!(false, watcher.check(&'q'));
assert_eq!(false, watcher.check(&'u'));
assert_eq!(false, watcher.check(&'i'));
assert_eq!(true, watcher.check(&'t'));

Panics

SequenceWatcher::new will panic if the sequence slice is empty.

pub fn check(&self, value: &T) -> bool

Tells the SequenceWatcher of a new input item and checks to see if a sequence has been completed. Returns true when the sequence is completed.

Examples

let watcher = SequenceWatcher::new(&[Some("found")]);

assert_eq!(false, watcher.check(&None));
assert_eq!(false, watcher.check(&Some("something")));
assert_eq!(false, watcher.check(&Some("anything")));
assert_eq!(true, watcher.check(&Some("found")));

pub fn expects(&self) -> &T

Returns the a reference to the data value that the SequenceWatcher is expecting next.

Examples

let watcher = SequenceWatcher::new(&[1, 2]);

assert_eq!(1, *watcher.expects());
assert_eq!(false, watcher.check(&0));
assert_eq!(1, *watcher.expects());
assert_eq!(false, watcher.check(&1));
assert_eq!(2, *watcher.expects());
assert_eq!(true, watcher.check(&2));
assert_eq!(1, *watcher.expects());

pub fn index(&self) -> usize

Returns the index in the sequence that the SequenceWatcher is expecting next. The index will never be greater than or equal to the sequence length.

Examples

let watcher = SequenceWatcher::new(&[1, 2]);

assert_eq!(0, watcher.index());
assert_eq!(false, watcher.check(&0));
assert_eq!(0, watcher.index());
assert_eq!(false, watcher.check(&1));
assert_eq!(1, watcher.index());
assert_eq!(true, watcher.check(&2));
assert_eq!(0, watcher.index());

pub fn reset(&self)

Resets the SequenceWatcher so it doesn’t remember if it has seen any protions of the sequence.

Examples

let watcher = SequenceWatcher::new(&[1, 2]);

assert_eq!(false, watcher.check(&1));
assert_eq!(1, watcher.index());
watcher.reset();
assert_eq!(false, watcher.check(&2));
assert_eq!(false, watcher.check(&1));
assert_eq!(true, watcher.check(&2));

pub fn sequence(&self) -> &[T]

Returns a reference to the sequence.

Examples

let watcher = SequenceWatcher::new(&[Ok(()), Err(())]);

assert_eq!(&[Ok(()), Err(())], watcher.sequence());

pub fn len(&self) -> usize

Returns the length of the sequence.

Examples

let watcher = SequenceWatcher::new(&[false, true, false, true]);

assert_eq!(4, watcher.len());

Trait Implementations

impl<T> Clone for SequenceWatcher<T>

where T: PartialEq + Clone + Debug + Clone,

fn clone(&self) -> SequenceWatcher<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for SequenceWatcher<T>

where T: PartialEq + Clone + Debug + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: PartialEq + Debug + Clone> From<&[T]> for SequenceWatcher<T>

Creates a new SequenceWatcher from a slice.

Examples

let watcher = SequenceWatcher::from(&[b'X'][..]);   // This is treated as a slice.

assert_eq!(true, watcher.check(&b'X'));

This also works for array references for arrays of up to 32 itmes.

let watcher = SequenceWatcher::from(&[b'X']);   // This is treated as an array reference.

assert_eq!(true, watcher.check(&b'X'));

There is no support for a zero length array reference, so when using the array version, it will fail to compile.

let watcher: SequenceWatcher<u8> = SequenceWatcher::from(&[]);

fn from(src: &[T]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 1]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 1]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 10]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 10]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 11]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 11]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 12]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 12]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 13]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 13]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 14]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 14]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 15]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 15]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 16]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 16]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 17]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 17]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 18]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 18]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 19]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 19]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 2]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 2]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 20]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 20]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 21]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 21]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 22]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 22]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 23]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 23]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 24]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 24]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 25]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 25]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 26]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 26]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 27]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 27]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 28]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 28]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 29]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 29]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 3]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 3]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 30]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 30]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 31]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 31]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 32]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 32]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 4]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 4]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 5]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 5]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 6]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 6]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 7]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 7]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 8]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 8]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<&[T; 9]> for SequenceWatcher<T>

Creates a new SequenceWatcher from an array.

fn from(src: &[T; 9]) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Debug + Clone> From<Vec<T>> for SequenceWatcher<T>

Creates a new SequenceWatcher from a Vec.

Examples

let seq = vec![b'X'];
let watcher = SequenceWatcher::from(seq);

assert_eq!(true, watcher.check(&b'X'));

fn from(src: Vec<T>) -> Self

Converts to this type from the input type.