sift-core 0.5.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

use crate::Candidate;
use crate::search::output::SearchOutput;
use crate::search::output::style::SearchSeparators;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum LinkTraversal {
    DoNotFollow,
    Follow,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct WalkOptions {
    pub links: LinkTraversal,
    pub max_depth: Option<usize>,
    pub max_filesize: Option<u64>,
    pub one_file_system: bool,
}

impl Default for WalkOptions {
    fn default() -> Self {
        Self {
            links: LinkTraversal::DoNotFollow,
            max_depth: None,
            max_filesize: None,
            one_file_system: false,
        }
    }
}

#[derive(Clone)]
pub struct SearchExecution<'a> {
    pub candidates: Vec<Candidate>,
    pub output: SearchOutput,
    pub separators: &'a SearchSeparators,
    pub collect: SearchCollection,
}

/// Optional artifacts gathered during search beyond primary output.
#[must_use]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct SearchCollection {
    pub stats: bool,
    pub hits: bool,
}

impl Default for SearchCollection {
    fn default() -> Self {
        Self::none()
    }
}

impl SearchCollection {
    pub const fn none() -> Self {
        Self {
            stats: false,
            hits: false,
        }
    }

    pub const fn stats() -> Self {
        Self {
            stats: true,
            hits: false,
        }
    }

    pub const fn hits() -> Self {
        Self {
            stats: false,
            hits: true,
        }
    }

    pub const fn stats_and_hits() -> Self {
        Self {
            stats: true,
            hits: true,
        }
    }

    pub const fn with_stats(self, stats: bool) -> Self {
        Self {
            stats,
            hits: self.hits,
        }
    }

    pub const fn with_hits(self, hits: bool) -> Self {
        Self {
            stats: self.stats,
            hits,
        }
    }
}