sift-core 0.6.0

Indexed regex search over codebases (library + grep-like CLI)
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
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

bitflags::bitflags! {
    /// Flags modifying how a query is interpreted by the search engine and index layer.
    #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
    pub struct QueryFlags: u8 {
        const FIXED_STRINGS    = 1 << 0;
        const CASE_INSENSITIVE = 1 << 1;
        const WORD_REGEXP      = 1 << 2;
        const LINE_REGEXP      = 1 << 3;
        const INVERT_MATCH     = 1 << 4;
    }
}

/// Index-agnostic query description.
///
/// Describes what the user is searching for (patterns + flags) without
/// referencing any specific index type. Each index kind interprets the
/// spec independently to narrow candidates.
#[derive(Debug, Clone)]
pub struct QuerySpec<'a> {
    pub patterns: &'a [String],
    pub flags: QueryFlags,
}

impl QuerySpec<'_> {
    #[must_use]
    pub const fn fixed_strings(&self) -> bool {
        self.flags.contains(QueryFlags::FIXED_STRINGS)
    }

    #[must_use]
    pub const fn case_insensitive(&self) -> bool {
        self.flags.contains(QueryFlags::CASE_INSENSITIVE)
    }

    #[must_use]
    pub const fn word_regexp(&self) -> bool {
        self.flags.contains(QueryFlags::WORD_REGEXP)
    }

    #[must_use]
    pub const fn line_regexp(&self) -> bool {
        self.flags.contains(QueryFlags::LINE_REGEXP)
    }

    #[must_use]
    pub const fn invert_match(&self) -> bool {
        self.flags.contains(QueryFlags::INVERT_MATCH)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn empty_flags_all_return_false() {
        let spec = QuerySpec {
            patterns: &[],
            flags: QueryFlags::empty(),
        };
        assert!(!spec.fixed_strings());
        assert!(!spec.case_insensitive());
        assert!(!spec.word_regexp());
        assert!(!spec.line_regexp());
        assert!(!spec.invert_match());
    }

    #[test]
    fn fixed_strings_flag_returns_true() {
        let spec = QuerySpec {
            patterns: &[],
            flags: QueryFlags::FIXED_STRINGS,
        };
        assert!(spec.fixed_strings());
    }

    #[test]
    fn case_insensitive_flag_returns_true() {
        let spec = QuerySpec {
            patterns: &[],
            flags: QueryFlags::CASE_INSENSITIVE,
        };
        assert!(spec.case_insensitive());
    }

    #[test]
    fn word_regexp_flag_returns_true() {
        let spec = QuerySpec {
            patterns: &[],
            flags: QueryFlags::WORD_REGEXP,
        };
        assert!(spec.word_regexp());
    }

    #[test]
    fn line_regexp_flag_returns_true() {
        let spec = QuerySpec {
            patterns: &[],
            flags: QueryFlags::LINE_REGEXP,
        };
        assert!(spec.line_regexp());
    }

    #[test]
    fn invert_match_flag_returns_true() {
        let spec = QuerySpec {
            patterns: &[],
            flags: QueryFlags::INVERT_MATCH,
        };
        assert!(spec.invert_match());
    }

    #[test]
    fn multiple_flags_all_return_true() {
        let mut flags = QueryFlags::empty();
        flags |= QueryFlags::FIXED_STRINGS;
        flags |= QueryFlags::CASE_INSENSITIVE;
        flags |= QueryFlags::WORD_REGEXP;
        let spec = QuerySpec {
            patterns: &["test".to_string()],
            flags,
        };
        assert!(spec.fixed_strings());
        assert!(spec.case_insensitive());
        assert!(spec.word_regexp());
        assert!(!spec.line_regexp());
        assert!(!spec.invert_match());
    }
}