klepto 0.1.3

a general purpose extraction and data scraping utility
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

use crate::klepto::Klepto;
use crate::model::*;
pub mod builtin;

pub trait Rule {
    fn code(&self) -> &'static str;
    fn name(&self) -> &'static str;
    fn run(&self, k: &Klepto) -> Vec<Finding>;
}

pub struct RuleRunner<'k> {
    k: &'k Klepto,
    rules: Vec<Box<dyn Rule>>,
}

impl<'k> RuleRunner<'k> {
    pub fn new(k: &'k Klepto) -> Self {
        Self { k, rules: Vec::new() }
    }

    pub fn with_default_rules(mut self) -> Self {
        self.rules.push(Box::new(builtin::UndocumentedPublicApi));
        self.rules.push(Box::new(builtin::UnwrapInPublicApi));
        self.rules.push(Box::new(builtin::StdInNoStdCrate));
        self.rules.push(Box::new(builtin::PanicMacrosInPublicApi));
        self
    }

    pub fn add_rule<R: Rule + 'static>(mut self, r: R) -> Self {
        self.rules.push(Box::new(r));
        self
    }

    pub fn run(self) -> Vec<Finding> {
        let mut all = Vec::new();
        for r in self.rules {
            all.extend(r.run(self.k));
        }
        all
    }
}