ieql 0.1.4

An open standard and implementation for monitoring Internet content
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

//! This file provides functionality related to triggers.

use common::pattern::{Pattern, CompiledPattern, PatternMatch};
use common::compilation::CompilableTo;
use common::validation::Issue;

/// Represents a trigger, which is itself mostly a smart 
/// wrapper for JSON expressions.
#[derive(Clone, Serialize, Deserialize, Debug, PartialEq)]
pub struct Trigger {
    /// The pattern that will be evaluated on the text
    pub pattern: Pattern,
    /// The ID of the Trigger (used for `Threshold` evaluation)
    pub id: String,
}

#[derive(Clone)]
pub struct CompiledTrigger {
    pub pattern: CompiledPattern,
    pub id: String,
}

impl CompilableTo<CompiledTrigger> for Trigger {
    fn compile(&self) -> Result<CompiledTrigger, Issue> {
        match self.pattern.compile() {
            Ok(compiled_pattern) => Ok(CompiledTrigger {
                pattern: compiled_pattern,
                id: self.id.clone()
            }),
            Err(issue) => Err(issue)
        }
    }
}

impl CompiledTrigger {
    /// Checks if the `Trigger` matches the given string
    /// without extracting any type of excerpt.
    /// 
    /// This is typically much faster than performing a
    /// `full_check()`.
    pub fn quick_check(&self, other: &String) -> bool {
        self.pattern.quick_check(other)
    }

    /// Checks if the `Trigger` matches the given string
    /// and extracts an excerpt.
    /// 
    /// This is typically slower than `quick_check()`, and
    /// in most scenarios it makes sense to run `quick_check()`
    /// first before running this function.
    pub fn full_check(&self, other: &String) -> Option<PatternMatch> {
        self.pattern.full_check(other)
    }
}