ripgrep-api 0.1.4

Dev-friendly API wrapper around the ripgrep implementation to be used directly in Rust projects.
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

# ripgrep-api

Coder-friendly Rust API wrapper around ripgrep's core crates.

## Install

Crates.io:

```toml
ripgrep-api = "0.1"
```

Git dependency (current repo):

```toml
ripgrep-api = { git = "https://github.com/AlextheYounga/ripgrep-api.git" }
```

## Quickstart

```rust
use ripgrep_api::SearchBuilder;

let matches: Vec<_> = SearchBuilder::new("todo")
    .path(".")
    .glob("**/*.rs")
    .smart_case()
    .context(2)
    .build()?
    .collect();

for mat in matches {
    println!("{}:{}:{}", mat.path.display(), mat.line.unwrap_or(0), mat.line_text);
}
# Ok::<(), ripgrep_api::SearchError>(())
```

## Streaming callbacks

```rust
use ripgrep_api::{Match, SearchBuilder};

let root = ".";
SearchBuilder::new("alpha")
    .path(root)
    .for_each(|mat: &Match| {
        println!("{}:{}", mat.path.display(), mat.line.unwrap_or(0));
        true
    })?;
# Ok::<(), ripgrep_api::SearchError>(())
```

## In-memory search

```rust
use ripgrep_api::SearchBuilder;

let haystack = b"zero\nmatch\nthree\n";
let matches = SearchBuilder::new("match")
    .search_slice(haystack)?;

assert_eq!(matches.len(), 1);
# Ok::<(), ripgrep_api::SearchError>(())
```

## PCRE2 (feature flag)

```rust
# #[cfg(feature = "pcre2")]
# {
use ripgrep_api::SearchBuilder;

let matches = SearchBuilder::new(r"(foo)(bar)\1")
    .pcre2()
    .search_slice(b"foobarfoo")?;

assert_eq!(matches.len(), 1);
# Ok::<(), ripgrep_api::SearchError>(())
# }
```

Enable the feature in Cargo:

```toml
ripgrep-api = { version = "0.1", features = ["pcre2"] }
```

## Performance knobs

```rust
use ripgrep_api::SearchBuilder;
use grep_searcher::MmapChoice;

let matches = SearchBuilder::new("alpha")
    .path(".")
    .threads(4)
    .memory_map(unsafe { MmapChoice::auto() })
    .heap_limit(64 * 1024)
    .build()?
    .collect::<Vec<_>>();
# Ok::<(), ripgrep_api::SearchError>(())
```

## Custom file types and overrides

```rust
use ripgrep_api::SearchBuilder;

let matches = SearchBuilder::new("alpha")
    .path(".")
    .type_add("notes", "*.note")
    .type_("notes")
    .glob("!ignored.note")
    .build()?
    .collect::<Vec<_>>();
# Ok::<(), ripgrep_api::SearchError>(())
```

## Walk-only file listing

```rust
use ripgrep_api::SearchBuilder;

let files = SearchBuilder::new("irrelevant")
    .path(".")
    .glob("**/*.rs")
    .walk_files()?;

assert!(!files.is_empty());
# Ok::<(), ripgrep_api::SearchError>(())
```

## rg flag -> API method

| rg flag | API method |
| --- | --- |
| `-g/--glob` | `glob(...)` |
| `-t/--type` | `type_(...)` |
| `-T/--type-not` | `type_not(...)` |
| `-d/--max-depth` | `max_depth(...)` |
| `--max-filesize` | `max_filesize(...)` |
| `-i/--ignore-case` | `ignore_case()` |
| `-S/--smart-case` | `smart_case()` |
| `-w/--word-regexp` | `word()` |
| `-x/--line-regexp` | `line_regexp()` |
| `-A/--after-context` | `after_context(...)` |
| `-B/--before-context` | `before_context(...)` |
| `-C/--context` | `context(...)` |
| `-m/--max-count` | `max_count(...)` |
| `-uuu` | `hidden()` + `ignore(false)` |
| `-P/--pcre2` | `pcre2()` (feature: `pcre2`) |
| `-j/--threads` | `threads(...)` |
| `--mmap` | `memory_map(...)` |
| `--no-mmap` | `memory_map(MmapChoice::never())` |
| `--heap-limit` | `heap_limit(...)` |