File size: 60,417 Bytes
24918f7
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
{"repo": "ripgrep", "file": "ci/utils.sh", "line": 12, "symbol": "target_dir", "task": "This works by finding the most recent stamp file, which is produced by every ripgrep build.", "query": "this works finding", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/cli/src/decompress.rs", "line": 76, "symbol": "defaults", "task": "When enabled, the default matching rules will be compiled into this matcher before any other associations.", "query": "when enabled default", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/cli/src/decompress.rs", "line": 96, "symbol": "associate", "task": "into an absolute path internally before being executed by the current platform.", "query": "into absolute path", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/cli/src/decompress.rs", "line": 125, "symbol": "try_associate", "task": "The `program` given is resolved with respect to `PATH` and turned into an absolute path internally before being executed by the current platform.", "query": "program given resolved", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/cli/src/decompress.rs", "line": 221, "symbol": "build", "task": "command, but is executing in an environment where the decompression command is not available.", "query": "command executing environment", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/cli/src/decompress.rs", "line": 448, "symbol": "try_resolve_binary", "task": "Note that this could still return a relative path if PATH contains a relative path.", "query": "note that this", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/cli/src/escape.rs", "line": 33, "symbol": "escape_os", "task": "Escapes an OS string into a human readable string.", "query": "escapes string into", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/cli/src/process.rs", "line": 23, "symbol": "io", "task": "Create an error from an I/O error.", "query": "create error from", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/cli/src/process.rs", "line": 195, "symbol": "new", "task": "If there was a problem spawning the given command, then its error is returned.", "query": "there problem spawning", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/cli/src/process.rs", "line": 280, "symbol": "r#async", "task": "Create a reader for stderr that reads contents asynchronously.", "query": "create reader stderr", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/cli/src/process.rs", "line": 287, "symbol": "sync", "task": "Create a reader for stderr that reads contents synchronously.", "query": "create reader stderr", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/cli/src/process.rs", "line": 295, "symbol": "read_to_end", "task": "Consumes all of stderr on to the heap and returns it as an error.", "query": "consumes stderr heap", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/cli/src/wtr.rs", "line": 7, "symbol": "StandardStream", "task": "A writer that supports coloring with either line or block buffering.", "query": "writer that supports", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/cli/src/wtr.rs", "line": 23, "symbol": "stdout", "task": "If you need more fine grained control over the buffering mode, then use one of `stdout_buffered_line` or `stdout_buffered_block`.", "query": "need more fine", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/cli/src/wtr.rs", "line": 39, "symbol": "stdout_buffered_line", "task": "This writer is useful when printing results directly to a tty such that users see output as soon as it's written.", "query": "this writer useful", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/cli/src/wtr.rs", "line": 54, "symbol": "stdout_buffered_block", "task": "This writer is useful when printing results to a file since it amortizes the cost of writing data.", "query": "this writer useful", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/flags/config.rs", "line": 16, "symbol": "args", "task": "Return a sequence of arguments derived from ripgrep rc configuration files.", "query": "return sequence arguments", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/flags/config.rs", "line": 63, "symbol": "parse", "task": "On success, this returns a set of shell arguments, in order, that should be pre-pended to the arguments given to ripgrep at the command line.", "query": "success this returns", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/flags/config.rs", "line": 84, "symbol": "parse_reader", "task": "On success, this returns a set of shell arguments, in order, that should be pre-pended to the arguments given to ripgrep at the command line.", "query": "success this returns", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/flags/config.rs", "line": 139, "symbol": "error", "task": "We test that we can handle invalid UTF-8 on Unix-like systems.", "query": "test that handle", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/flags/doc/mod.rs", "line": 18, "symbol": "render_custom_markup", "task": "The first argument given to `replacement` is the tag value, `...`.", "query": "first argument given", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/flags/hiargs.rs", "line": 342, "symbol": "buffer_writer", "task": "This is intended to be used from multiple threads.", "query": "this intended used", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/flags/hiargs.rs", "line": 697, "symbol": "quit_after_match", "task": "This is useful for example when quiet mode is enabled.", "query": "this useful example", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/flags/hiargs.rs", "line": 773, "symbol": "sort", "task": "Once special case is when sorting by path in ascending order has been requested.", "query": "once special case", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/flags/hiargs.rs", "line": 872, "symbol": "types", "task": "Returns the file type matcher that was built.", "query": "returns file type", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/flags/hiargs.rs", "line": 968, "symbol": "State", "task": "conversions as a way to communicate changes to other conversions.", "query": "conversions communicate changes", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/flags/hiargs.rs", "line": 986, "symbol": "new", "task": "Initialize state to some sensible defaults.", "query": "initialize state some", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/flags/hiargs.rs", "line": 1215, "symbol": "is_none", "task": "Returns true when both implicit and explicit binary detection is disabled.", "query": "returns true when", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/flags/hiargs.rs", "line": 1222, "symbol": "types", "task": "Builds the file type matcher from low level arguments.", "query": "builds file type", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/flags/lowargs.rs", "line": 452, "symbol": "ContextModeLimited", "task": "the default value and occurs when no value is specified.", "query": "default value occurs", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/flags/lowargs.rs", "line": 464, "symbol": "get", "task": "Returns the specific number of contextual lines that should be shown around each match.", "query": "returns specific number", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/flags/lowargs.rs", "line": 507, "symbol": "disabled", "task": "Creates a new separator that instructs the printer to disable contextual separators entirely.", "query": "creates separator that", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/flags/lowargs.rs", "line": 637, "symbol": "MmapMode", "task": "Indicates when to use memory maps.", "query": "indicates when memory", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/flags/lowargs.rs", "line": 675, "symbol": "SortModeKind", "task": "The criteria to use for sorting.", "query": "criteria sorting", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/flags/mod.rs", "line": 152, "symbol": "doc_choices", "task": "If this is a non-switch flag that accepts a small set of specific values, then this should list them.", "query": "this switch flag", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/flags/mod.rs", "line": 180, "symbol": "update", "task": "ensures that \"doing something\" occurs a minimal number of times.", "query": "ensures that doing", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/flags/mod.rs", "line": 228, "symbol": "as_str", "task": "Returns a string representation of this category.", "query": "returns string representation", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/flags/mod.rs", "line": 244, "symbol": "CompletionType", "task": "The kind of argument a flag accepts, to be used for shell completions.", "query": "kind argument flag", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/flags/mod.rs", "line": 268, "symbol": "FlagValue", "task": "Note that the CLI doesn't directly support negated switches.", "query": "note that doesn", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/flags/mod.rs", "line": 301, "symbol": "unwrap_value", "task": "If this flag is a switch, then this panics.", "query": "this flag switch", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/flags/parse.rs", "line": 116, "symbol": "set_log_levels", "task": "Sets global state flags that control logging based on low-level arguments.", "query": "sets global state", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/flags/parse.rs", "line": 148, "symbol": "lookup", "task": "Return the metadata for the flag of the given name.", "query": "return metadata flag", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/flags/parse.rs", "line": 393, "symbol": "find", "task": "Look for a match of `name` in the given Aho-Corasick automaton.", "query": "look match name", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/flags/parse.rs", "line": 404, "symbol": "suggest", "task": "Possibly return a message suggesting flags similar in the name to the one given.", "query": "possibly return message", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/flags/parse.rs", "line": 466, "symbol": "ngrams", "task": "Returns all 3-grams in the slice given.", "query": "returns grams slice", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/main.rs", "line": 44, "symbol": "main", "task": "Then, as it was, then again it will be.", "query": "then then again", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/main.rs", "line": 78, "symbol": "run", "task": "result should be the result of parsing CLI arguments in a low level representation, and then followed by an attempt to convert them into a higher level representation.", "query": "result should result", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/main.rs", "line": 166, "symbol": "search_parallel", "task": "The parallelism is itself achieved by the recursive directory traversal.", "query": "parallelism itself achieved", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/main.rs", "line": 241, "symbol": "files", "task": "The top-level entry point for file listing without searching.", "query": "level entry point", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/main.rs", "line": 335, "symbol": "types", "task": "The top-level entry point for `--type-list`.", "query": "level entry point", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/main.rs", "line": 420, "symbol": "eprint_nothing_searched", "task": "This can happen if an applicable ignore file has one or more rules that are too broad and cause ripgrep to ignore everything.", "query": "this happen applicable", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/main.rs", "line": 440, "symbol": "print_stats", "task": "If an error occurs while writing, then writing stops and the error is returned.", "query": "error occurs while", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/messages.rs", "line": 124, "symbol": "set_ignore_messages", "task": "By default, they are not shown.", "query": "default they shown", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/messages.rs", "line": 129, "symbol": "errored", "task": "Returns true if and only if ripgrep came across a non-fatal error.", "query": "returns true only", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/messages.rs", "line": 137, "symbol": "set_errored", "task": "Indicate that ripgrep has come across a non-fatal error.", "query": "indicate that ripgrep", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/search.rs", "line": 123, "symbol": "search_zip", "task": "When enabled, if a particular file path is recognized as a compressed file, then it is decompressed before searching.", "query": "when enabled particular", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/core/search.rs", "line": 215, "symbol": "get_mut", "task": "Return a mutable reference to the underlying printer's writer.", "query": "return mutable reference", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/globset/src/glob.rs", "line": 16, "symbol": "MatchStrategy", "task": "This provides a way to more quickly determine whether a pattern matches a particular file path in a way that scales with a large number of patterns.", "query": "this provides more", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/globset/src/glob.rs", "line": 51, "symbol": "new", "task": "Returns a matching strategy for the given pattern.", "query": "returns matching strategy", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/globset/src/glob.rs", "line": 142, "symbol": "is_match", "task": "Tests whether the given path matches this pattern or not.", "query": "tests whether given", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/globset/src/glob.rs", "line": 147, "symbol": "is_match_candidate", "task": "Tests whether the given path matches this pattern or not.", "query": "tests whether given", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/globset/src/glob.rs", "line": 170, "symbol": "is_match", "task": "Tests whether the given path matches this pattern or not.", "query": "tests whether given", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/globset/src/glob.rs", "line": 175, "symbol": "is_match_candidate", "task": "Tests whether the given path matches this pattern or not.", "query": "tests whether given", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/globset/src/glob.rs", "line": 353, "symbol": "ext", "task": "if the file path has the extension returned.", "query": "file path extension", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/globset/src/glob.rs", "line": 636, "symbol": "backslash_escape", "task": "prevent `\\` from being interpreted as a path separator on all platforms.", "query": "prevent from being", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/globset/src/lib.rs", "line": 309, "symbol": "GlobSet", "task": "represents a group of globs that can be matched together in a single pass.", "query": "represents group globs", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/globset/src/lib.rs", "line": 337, "symbol": "len", "task": "Returns the number of globs in this set.", "query": "returns number globs", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/globset/src/lib.rs", "line": 342, "symbol": "is_match", "task": "Returns true if any glob in this set matches the path given.", "query": "returns true glob", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/globset/src/lib.rs", "line": 350, "symbol": "is_match_candidate", "task": "Returns true if any glob in this set matches the path given.", "query": "returns true glob", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/globset/src/lib.rs", "line": 566, "symbol": "GlobSetBuilder", "task": "builds a group of patterns that can be used to simultaneously match a file path.", "query": "builds group patterns", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/globset/src/lib.rs", "line": 581, "symbol": "build", "task": "Builds a new matcher from all of the glob patterns added so far.", "query": "builds matcher from", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/dir.rs", "line": 94, "symbol": "Ignore", "task": "is a matcher useful for recursively walking one or more directories.", "query": "matcher useful recursively", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/dir.rs", "line": 176, "symbol": "is_root", "task": "Return true if this matcher has no parent.", "query": "return true this", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/dir.rs", "line": 268, "symbol": "add_child", "task": "Since building the matcher may require reading from multiple files, it's possible that this method partially succeeds.", "query": "since building matcher", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/dir.rs", "line": 500, "symbol": "matched", "task": "Returns a match indicating whether the given file path should be ignored or not.", "query": "returns match indicating", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/dir.rs", "line": 688, "symbol": "parents", "task": "Returns an iterator over parent ignore matchers, including this one.", "query": "returns iterator over", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/dir.rs", "line": 946, "symbol": "parents", "task": "Enables reading ignore files from parent directories.", "query": "enables reading ignore", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/dir.rs", "line": 1061, "symbol": "resolve_git_commondir", "task": "This is the directory that may contain a private ignore file \"info/exclude\".", "query": "this directory that", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/gitignore.rs", "line": 47, "symbol": "from", "task": "Returns the file path that defined this glob.", "query": "returns file path", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/gitignore.rs", "line": 63, "symbol": "is_whitelist", "task": "Whether this was a whitelisted glob or not.", "query": "whether this whitelisted", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/gitignore.rs", "line": 68, "symbol": "is_only_dir", "task": "Whether this glob must match a directory or not.", "query": "whether this glob", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/gitignore.rs", "line": 103, "symbol": "new", "task": "This always returns a valid matcher, even if it's empty.", "query": "this always returns", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/gitignore.rs", "line": 141, "symbol": "global", "task": "Git's config file location is `$HOME/.gitconfig`.", "query": "config file location", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/gitignore.rs", "line": 182, "symbol": "num_ignores", "task": "Returns the total number of ignore globs.", "query": "returns total number", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/gitignore.rs", "line": 187, "symbol": "num_whitelists", "task": "Returns the total number of whitelisted globs.", "query": "returns total number", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/gitignore.rs", "line": 349, "symbol": "build", "task": "Builds a new matcher from the globs added so far.", "query": "builds matcher from", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/gitignore.rs", "line": 690, "symbol": "expand_tilde", "task": "Expands ~ in file paths to the value of $HOME.", "query": "expands file paths", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/incremental.rs", "line": 155, "symbol": "normalize", "task": "Note also that this may reject paths that only differ in casing.", "query": "note also that", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/incremental.rs", "line": 486, "symbol": "is_none", "task": "Returns true if the match result didn't match anything.", "query": "returns true match", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/incremental.rs", "line": 491, "symbol": "is_ignore", "task": "Returns true if the match result implies the path should be ignored.", "query": "returns true match", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/incremental.rs", "line": 497, "symbol": "is_whitelist", "task": "Returns true if the match result implies the path should be whitelisted.", "query": "returns true match", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/incremental.rs", "line": 717, "symbol": "glob_overrides_apply_to_ancestors", "task": "Test that an override-ignored directory prevents matching rules below it, just as it prevents a traversal from descending into the directory.", "query": "test that override", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/incremental.rs", "line": 811, "symbol": "compiled_matchers_are_reused", "task": "Test that when a gitignore matcher in a parent directory is created, we reuse that matcher from memory even if it's changed on disk.", "query": "test that when", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/incremental.rs", "line": 881, "symbol": "compiled_multi_matchers_are_reused", "task": "Like `compiled_matchers_are_reused`, but with multiple roots.", "query": "like compiled matchers", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/incremental.rs", "line": 1009, "symbol": "multiple_roots_keep_their_own_context", "task": "Tests that two matchers in two different directories correctly interpret the same parent gitignore file.", "query": "tests that matchers", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/incremental.rs", "line": 1064, "symbol": "symlink_path_stays_under_lexical_root", "task": "Tests that ignore matching works lexically, and doesn't accidentally resolve symbolic links.", "query": "tests that ignore", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/lib.rs", "line": 173, "symbol": "is_io", "task": "Returns true if this error is exclusively an I/O error.", "query": "returns true this", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/lib.rs", "line": 429, "symbol": "is_none", "task": "Returns true if the match result didn't match any globs.", "query": "returns true match", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/lib.rs", "line": 437, "symbol": "is_ignore", "task": "Returns true if the match result implies the path should be ignored.", "query": "returns true match", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/lib.rs", "line": 446, "symbol": "is_whitelist", "task": "Returns true if the match result implies the path should be whitelisted.", "query": "returns true match", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/lib.rs", "line": 464, "symbol": "inner", "task": "Return the value inside this match if it exists.", "query": "return value inside", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/lib.rs", "line": 475, "symbol": "map", "task": "Apply the given function to the value inside this match.", "query": "apply given function", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/lib.rs", "line": 484, "symbol": "or", "task": "Return the match if it is not none.", "query": "return match none", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/lib.rs", "line": 512, "symbol": "TempDir", "task": "A simple wrapper for creating a temporary directory that is automatically deleted when it's dropped.", "query": "simple wrapper creating", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/overrides.rs", "line": 58, "symbol": "path", "task": "Returns the directory of this override set.", "query": "returns directory this", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/overrides.rs", "line": 70, "symbol": "num_ignores", "task": "Returns the total number of ignore globs.", "query": "returns total number", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/overrides.rs", "line": 75, "symbol": "num_whitelists", "task": "Returns the total number of whitelisted globs.", "query": "returns total number", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/overrides.rs", "line": 132, "symbol": "build", "task": "Builds a new override matcher from the globs added so far.", "query": "builds override matcher", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/pathutil.rs", "line": 56, "symbol": "is_hidden_entry", "task": "* The base name of the path starts with a `.`.", "query": "base name path", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/types.rs", "line": 111, "symbol": "Glob", "task": "For example, if there are one or more selections and a file path doesn't match any of those selections, then the file path is considered to be ignored.", "query": "example there more", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/types.rs", "line": 227, "symbol": "empty", "task": "Creates a new file type matcher that never matches any path and contains no file type definitions.", "query": "creates file type", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/types.rs", "line": 241, "symbol": "is_empty", "task": "Returns true if and only if this matcher has zero selections.", "query": "returns true only", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/types.rs", "line": 246, "symbol": "len", "task": "Returns the number of selections used in this matcher.", "query": "returns number selections", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/types.rs", "line": 263, "symbol": "matched", "task": "Returns a match for the given path against this file type matcher.", "query": "returns match given", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/types.rs", "line": 307, "symbol": "TypesBuilder", "task": "builds a type matcher from a set of file type definitions and a set of file type selections.", "query": "builds type matcher", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/types.rs", "line": 399, "symbol": "negate", "task": "Ignore the file type given by `name`.", "query": "ignore file type", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/types.rs", "line": 446, "symbol": "add_def", "task": "given name with the given glob.", "query": "given name with", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/walk.rs", "line": 49, "symbol": "path_is_symlink", "task": "Whether this entry corresponds to a symbolic link or not.", "query": "whether this entry", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/walk.rs", "line": 89, "symbol": "ino", "task": "Returns the underlying inode number if one exists.", "query": "returns underlying inode", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/walk.rs", "line": 103, "symbol": "is_dir", "task": "Returns true if and only if this entry points to a directory.", "query": "returns true only", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/walk.rs", "line": 230, "symbol": "is_dir", "task": "Returns true if and only if this entry points to a directory.", "query": "returns true only", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/walk.rs", "line": 238, "symbol": "DirEntryRaw", "task": "is essentially copied from the walkdir crate so that we can build `DirEntry`s from whole cloth in the parallel iterator.", "query": "essentially copied from", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/walk.rs", "line": 488, "symbol": "WalkBuilder", "task": "* Fifth, if the path hasn't been whitelisted and it is hidden, then the path is skipped.", "query": "fifth path hasn", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/ignore/src/walk.rs", "line": 762, "symbol": "max_filesize", "task": "Whether to ignore files above the specified limit.", "query": "whether ignore files", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/matcher/src/interpolate.rs", "line": 14, "symbol": "interpolate", "task": "The `append` function given is responsible for writing the replacement to the `dst` buffer.", "query": "append function given", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/matcher/src/interpolate.rs", "line": 73, "symbol": "Ref", "task": "A reference to a capture group in some text.", "query": "reference capture group", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/matcher/src/interpolate.rs", "line": 97, "symbol": "find_cap_ref", "task": "Parses a possible reference to a capture group name in the given text, starting at the beginning of `replacement`.", "query": "parses possible reference", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/matcher/src/interpolate.rs", "line": 138, "symbol": "is_valid_cap_letter", "task": "Returns true if and only if the given byte is allowed in a capture name.", "query": "returns true only", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/matcher/src/lib.rs", "line": 147, "symbol": "len", "task": "Returns the number of bytes in this match.", "query": "returns number bytes", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/matcher/src/lib.rs", "line": 220, "symbol": "crlf", "task": "Return a new line terminator represented by `\\r\\n`.", "query": "return line terminator", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/matcher/src/lib.rs", "line": 263, "symbol": "is_suffix", "task": "Returns true if and only if the given slice ends with this line terminator.", "query": "returns true only", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/matcher/src/lib.rs", "line": 357, "symbol": "contains", "task": "Return true if and only if the given byte is in this set.", "query": "return true only", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/matcher/src/lib.rs", "line": 382, "symbol": "len", "task": "Return the total number of capturing groups.", "query": "return total number", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/matcher/src/lib.rs", "line": 390, "symbol": "get", "task": "Return the capturing group match at the given index.", "query": "return capturing group", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/matcher/src/lib.rs", "line": 473, "symbol": "new", "task": "Create an empty set of capturing groups.", "query": "create empty capturing", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/matcher/src/lib.rs", "line": 571, "symbol": "find_at", "task": "The text encoding of `haystack` is not strictly specified.", "query": "text encoding haystack", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/matcher/src/lib.rs", "line": 597, "symbol": "capture_count", "task": "If a matcher does not support capturing groups, then this should always return 0.", "query": "matcher does support", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/matcher/src/lib.rs", "line": 621, "symbol": "find", "task": "Returns the start and end byte range of the first match in `haystack`.", "query": "returns start byte", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/matcher/src/lib.rs", "line": 629, "symbol": "find_iter", "task": "Executes the given function over successive non-overlapping matches in `haystack`.", "query": "executes given function", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/matcher/src/lib.rs", "line": 692, "symbol": "try_find_iter_at", "task": "then it is converted to `E`.", "query": "then converted", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/matcher/src/lib.rs", "line": 740, "symbol": "captures", "task": "Populates the first set of capture group matches from `haystack` into `caps`.", "query": "populates first capture", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/matcher/src/lib.rs", "line": 753, "symbol": "captures_iter", "task": "Executes the given function over successive non-overlapping matches in `haystack` with capture groups extracted from each match.", "query": "executes given function", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/matcher/src/lib.rs", "line": 774, "symbol": "captures_iter_at", "task": "match exists, then the given function is never called.", "query": "match exists then", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/pcre2/src/matcher.rs", "line": 45, "symbol": "build_many", "task": "Compile all of the given patterns into a single regex that matches when at least one of the patterns matches.", "query": "compile given patterns", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/pcre2/src/matcher.rs", "line": 94, "symbol": "caseless", "task": "If the `utf` option is also set, then Unicode case folding is used to determine case insensitivity.", "query": "option also then", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/pcre2/src/matcher.rs", "line": 127, "symbol": "dotall", "task": "When enabled, the `.` metacharacter in the pattern matches any character, include `\\n`.", "query": "when enabled metacharacter", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/pcre2/src/matcher.rs", "line": 258, "symbol": "jit", "task": "can increase the time it takes to compile a pattern.", "query": "increase time takes", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/color.rs", "line": 180, "symbol": "OutType", "task": "The set of configurable portions of ripgrep's output.", "query": "configurable portions ripgrep", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/color.rs", "line": 199, "symbol": "Style", "task": "The set of available styles for use in the terminal.", "query": "available styles terminal", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/counter.rs", "line": 24, "symbol": "count", "task": "Returns the total number of bytes written since construction or the last time `reset` was called.", "query": "returns total number", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/counter.rs", "line": 36, "symbol": "reset_count", "task": "Resets the number of bytes written to `0`.", "query": "resets number bytes", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/counter.rs", "line": 55, "symbol": "write", "task": "A high match count ad hoc benchmark flagged this as a hot spot.", "query": "high match count", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/hyperlink/mod.rs", "line": 235, "symbol": "find", "task": "Looks for the hyperlink alias defined by the given name.", "query": "looks hyperlink alias", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/hyperlink/mod.rs", "line": 409, "symbol": "append_var", "task": "Appends a variable with the given name.", "query": "appends variable with", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/hyperlink/mod.rs", "line": 626, "symbol": "Interpolator", "task": "Interpolation of variables occurs through two different sources.", "query": "interpolation variables occurs", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/hyperlink/mod.rs", "line": 646, "symbol": "begin", "task": "This returns an interpolator status which indicates whether the hyperlink was written.", "query": "this returns interpolator", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/hyperlink/mod.rs", "line": 675, "symbol": "finish", "task": "The status given should be returned from a corresponding `Interpolator::begin` call.", "query": "status given should", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/hyperlink/mod.rs", "line": 946, "symbol": "hyperlink_aliases", "task": "The list returned is guaranteed to be sorted lexicographically by the alias name.", "query": "list returned guaranteed", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/json.rs", "line": 54, "symbol": "JSONBuilder", "task": "Some configuration options, such as whether line numbers are included or whether contextual lines are shown, are drawn directly from the `grep_searcher::Searcher`'s configuration.", "query": "some configuration options", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/json.rs", "line": 571, "symbol": "get_mut", "task": "Return a mutable reference to the underlying writer.", "query": "return mutable reference", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/json.rs", "line": 577, "symbol": "into_inner", "task": "Consume this printer and return back ownership of the underlying writer.", "query": "consume this printer", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/json.rs", "line": 621, "symbol": "match_count", "task": "Return the total number of matches reported to this sink.", "query": "return total number", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/json.rs", "line": 686, "symbol": "replace", "task": "If the configuration specifies a replacement, then this executes the replacement, lazily allocating memory if necessary.", "query": "configuration specifies replacement", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/path.rs", "line": 13, "symbol": "Config", "task": "A configuration for describing how paths should be written.", "query": "configuration describing paths", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/path.rs", "line": 89, "symbol": "hyperlink", "task": "is provided to `build`, then no hyperlinks will ever be printed regardless of the format provided here.", "query": "provided build then", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/standard.rs", "line": 99, "symbol": "StandardBuilder", "task": "Some configuration options, such as the display of line numbers or contextual lines, are drawn directly from the `grep_searcher::Searcher`'s configuration.", "query": "some configuration options", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/standard.rs", "line": 127, "symbol": "build", "task": "`termcolor::Ansi` or `termcolor::NoColor` wrappers, which always enable colors via ANSI escapes or always disable colors, respectively.", "query": "termcolor ansi termcolor", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/standard.rs", "line": 180, "symbol": "hyperlink", "task": "is provided to `build`, then no hyperlinks will ever be printed regardless of the format provided here.", "query": "provided build then", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/standard.rs", "line": 203, "symbol": "stats", "task": "When this is enabled, this printer may need to do extra work in order to compute certain statistics, which could cause the search to take longer.", "query": "when this enabled", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/standard.rs", "line": 306, "symbol": "max_columns", "task": "If a line is found which exceeds this maximum, then it is replaced with a message indicating that the line has been omitted.", "query": "line found which", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/standard.rs", "line": 335, "symbol": "column", "task": "line for every match along with the starting offset for that match.", "query": "line every match", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/standard.rs", "line": 407, "symbol": "separator_field_match", "task": "For example, when the searcher has line numbers enabled, this printer will print the line number before each matching line.", "query": "example when searcher", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/standard.rs", "line": 480, "symbol": "Standard", "task": "This type is generic over `W`, which represents any implementation of the `termcolor::WriteColor` trait.", "query": "this type generic", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/standard.rs", "line": 605, "symbol": "get_mut", "task": "Return a mutable reference to the underlying writer.", "query": "return mutable reference", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/standard.rs", "line": 611, "symbol": "into_inner", "task": "Consume this printer and return back ownership of the underlying writer.", "query": "consume this printer", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/standard.rs", "line": 669, "symbol": "match_count", "task": "This corresponds to the number of times `Sink::matched` is called on the previous search.", "query": "this corresponds number", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/standard.rs", "line": 741, "symbol": "replace", "task": "If the configuration specifies a replacement, then this executes the replacement, lazily allocating memory if necessary.", "query": "configuration specifies replacement", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/standard.rs", "line": 886, "symbol": "new", "task": "Bundle self with a searcher and return the core implementation of Sink.", "query": "bundle self with", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/standard.rs", "line": 900, "symbol": "from_match", "task": "Bundle self with a searcher and return the core implementation of Sink for use with handling matching lines.", "query": "bundle self with", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/standard.rs", "line": 915, "symbol": "from_context", "task": "Bundle self with a searcher and return the core implementation of Sink for use with handling contextual lines.", "query": "bundle self with", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/stats.rs", "line": 13, "symbol": "Stats", "task": "Summary statistics produced at the end of a search.", "query": "summary statistics produced", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/summary.rs", "line": 175, "symbol": "build", "task": "`termcolor::Ansi` or `termcolor::NoColor` wrappers, which always enable colors via ANSI escapes or always disable colors, respectively.", "query": "termcolor ansi termcolor", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/summary.rs", "line": 196, "symbol": "kind", "task": "Set the output mode for this printer.", "query": "output mode this", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/summary.rs", "line": 236, "symbol": "hyperlink", "task": "is provided to `build`, then no hyperlinks will ever be printed regardless of the format provided here.", "query": "provided build then", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/summary.rs", "line": 264, "symbol": "stats", "task": "will continue after the first match in order to compute statistics.", "query": "will continue after", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/summary.rs", "line": 290, "symbol": "exclude_zero", "task": "When enabled and the mode is either `Count` or `CountMatches`, then results are not printed if no matches were found.", "query": "when enabled mode", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/summary.rs", "line": 364, "symbol": "new", "task": "The writer should be an implementation of `termcolor::WriteColor` and not just a bare implementation of `io::Write`.", "query": "writer should implementation", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/summary.rs", "line": 390, "symbol": "sink", "task": "This does not associate the printer with a file path, which means this implementation will never print a file path.", "query": "this does associate", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/summary.rs", "line": 459, "symbol": "get_mut", "task": "Return a mutable reference to the underlying writer.", "query": "return mutable reference", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/summary.rs", "line": 465, "symbol": "into_inner", "task": "Consume this printer and return back ownership of the underlying writer.", "query": "consume this printer", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/util.rs", "line": 14, "symbol": "Replacer", "task": "A type for handling replacements while amortizing allocation.", "query": "type handling replacements", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/util.rs", "line": 169, "symbol": "Sunk", "task": "While this serves as a convenient mechanism to abstract over `SinkMatch` and `SinkContext`, this also provides a way to abstract over replacements.", "query": "while this serves", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/util.rs", "line": 415, "symbol": "DecimalFormatter", "task": "This avoids going through the formatting machinery which seems to substantially slow things down.", "query": "this avoids going", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/util.rs", "line": 442, "symbol": "as_bytes", "task": "Return the decimal formatted as an ASCII byte string.", "query": "return decimal formatted", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/printer/src/util.rs", "line": 557, "symbol": "replace_with_captures_in_context", "task": "Like `Matcher::replace_with_captures_at`, but accepts an end bound.", "query": "like matcher replace", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/regex/src/ban.rs", "line": 8, "symbol": "check", "task": "Returns an error when a sub-expression in `expr` must match `byte`.", "query": "returns error when", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/regex/src/ban.rs", "line": 61, "symbol": "check", "task": "Returns true when the given pattern is detected to contain the given banned byte.", "query": "returns true when", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/regex/src/config.rs", "line": 102, "symbol": "is_fixed_strings", "task": "in that if the knob is false, this will still return true in some cases if the patterns are themselves indistinguishable from literals.", "query": "that knob false", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/regex/src/config.rs", "line": 166, "symbol": "new", "task": "Parse the given patterns into a single HIR expression that represents an alternation of the patterns given.", "query": "parse given patterns", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/regex/src/config.rs", "line": 232, "symbol": "config", "task": "Return a reference to the underlying configuration.", "query": "return reference underlying", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/regex/src/literal.rs", "line": 96, "symbol": "none", "task": "Returns a infinite set of inner literals, such that it can never produce a matcher.", "query": "returns infinite inner", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/regex/src/literal.rs", "line": 169, "symbol": "extract", "task": "Execute the extractor and return a sequence of literals.", "query": "execute extractor return", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/regex/src/literal.rs", "line": 264, "symbol": "extract_repetition", "task": "The key here really is making sure we get the 'inexact' vs 'exact' attributes correct on each of the literals we add.", "query": "here really making", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/regex/src/literal.rs", "line": 587, "symbol": "choose", "task": "Compare the two sequences and return the one that is believed to be best according to a hodge podge of heuristics.", "query": "compare sequences return", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/regex/src/matcher.rs", "line": 199, "symbol": "octal", "task": "syntax like `\\0` invokes a backreference, which is explicitly unsupported in Rust's regex engine.", "query": "syntax like invokes", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/regex/src/matcher.rs", "line": 300, "symbol": "ban_byte", "task": "This is useful when binary detection is enabled.", "query": "this useful when", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/searcher/src/lines.rs", "line": 49, "symbol": "LineStep", "task": "callers to explicitly provide the bytes when moving through the iterator.", "query": "callers explicitly provide", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/searcher/src/searcher/mmap.rs", "line": 13, "symbol": "MmapChoice", "task": "If a searcher is called in circumstances where it is possible to use memory maps, and memory maps are enabled, then it will attempt to do so if it believes it will make the search faster.", "query": "searcher called circumstances", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/searcher/src/searcher/mmap.rs", "line": 49, "symbol": "auto", "task": "The specific contract the caller is required to uphold isn't precise, but it basically amounts to something like, \"the caller guarantees that the underlying file won't be mutated.\" This, of course, isn't feasible in many environments.", "query": "specific contract caller", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/searcher/src/searcher/mmap.rs", "line": 65, "symbol": "open", "task": "memory from the given file succeeded and if memory maps are believed to be advantageous for performance.", "query": "memory from given", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/searcher/src/searcher/mmap.rs", "line": 118, "symbol": "is_enabled", "task": "Whether this strategy may employ memory maps or not.", "query": "whether this strategy", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/searcher/src/searcher/mod.rs", "line": 79, "symbol": "quit", "task": "When searching is performed with the entire contents mapped into memory, then binary detection is more conservative.", "query": "when searching performed", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/searcher/src/searcher/mod.rs", "line": 95, "symbol": "convert", "task": "contents of that buffer are always searched for the presence of this byte and replaced with the line terminator.", "query": "contents that buffer", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/searcher/src/searcher/mod.rs", "line": 151, "symbol": "Config", "task": "The internal configuration of a searcher.", "query": "internal configuration searcher", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/searcher/src/searcher/mod.rs", "line": 431, "symbol": "passthru", "task": "requesting an unbounded number of before and after contextual lines.", "query": "requesting unbounded number", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/searcher/src/searcher/mod.rs", "line": 583, "symbol": "max_matches", "task": "limit, regardless of how many lines it spans.", "query": "limit regardless many", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/searcher/src/searcher/mod.rs", "line": 885, "symbol": "max_matches", "task": "If multi line search is enabled and a match spans multiple lines, then that match is counted exactly once for the purposes of enforcing this limit, regardless of how many lines it spans.", "query": "multi line search", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/searcher/src/sink.rs", "line": 18, "symbol": "SinkError", "task": "Unless you have a specialized use case, you probably don't need to implement this trait explicitly.", "query": "unless have specialized", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/searcher/src/sink.rs", "line": 124, "symbol": "matched", "task": "If this returns `true`, then searching continues.", "query": "this returns true", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/searcher/src/sink.rs", "line": 143, "symbol": "context", "task": "If this returns `true`, then searching continues.", "query": "this returns true", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/searcher/src/sink.rs", "line": 167, "symbol": "context_break", "task": "If this returns `true`, then searching continues.", "query": "this returns true", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/searcher/src/sink.rs", "line": 188, "symbol": "binary_data", "task": "If this returns an error, then searching is stopped immediately, `finish` is not called and the error is bubbled back up to the caller of the searcher.", "query": "this returns error", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/searcher/src/sink.rs", "line": 206, "symbol": "begin", "task": "If this returns `true`, then searching continues.", "query": "this returns true", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/searcher/src/sink.rs", "line": 216, "symbol": "finish", "task": "This method is called when a search has completed.", "query": "this method called", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/searcher/src/sink.rs", "line": 340, "symbol": "SinkFinish", "task": "This reports data such as the total number of bytes searched and the absolute offset of the first occurrence of binary data, if any were found.", "query": "this reports data", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/searcher/src/sink.rs", "line": 348, "symbol": "byte_count", "task": "Return the total number of bytes searched.", "query": "return total number", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/searcher/src/sink.rs", "line": 442, "symbol": "SinkContext", "task": "A type that describes a contextual line reported by a searcher.", "query": "type that describes", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/searcher/src/testutil.rs", "line": 123, "symbol": "as_bytes", "task": "Return the data written to this sink.", "query": "return data written", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/searcher/src/testutil.rs", "line": 204, "symbol": "SearcherTester", "task": "means there is no obviously direct way to ask that a specific code path be exercised.", "query": "means there obviously", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/searcher/src/testutil.rs", "line": 392, "symbol": "invert_match", "task": "Whether to perform an inverted search or not.", "query": "whether perform inverted", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "crates/searcher/src/testutil.rs", "line": 505, "symbol": "include", "task": "Returns true if and only if the given label should be included as part of executing `test`.", "query": "returns true only", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "tests/util.rs", "line": 47, "symbol": "cmd_exists", "task": "Returns true if and only if the given program can be successfully executed with a `--help` flag.", "query": "returns true only", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "tests/util.rs", "line": 58, "symbol": "Dir", "task": "represents a directory in which tests should be run.", "query": "represents directory which", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "tests/util.rs", "line": 179, "symbol": "bin", "task": "Returns the path to the ripgrep executable.", "query": "returns path ripgrep", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "tests/util.rs", "line": 203, "symbol": "link_dir", "task": "Creates a directory symlink to the src with the given target name in this directory.", "query": "creates directory symlink", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "tests/util.rs", "line": 214, "symbol": "link_dir", "task": "Creates a directory symlink to the src with the given target name in this directory.", "query": "creates directory symlink", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "tests/util.rs", "line": 261, "symbol": "cmd", "task": "Returns a mutable reference to the underlying command.", "query": "returns mutable reference", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "tests/util.rs", "line": 266, "symbol": "arg", "task": "Add an argument to pass to the command.", "query": "argument pass command", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "tests/util.rs", "line": 272, "symbol": "args", "task": "Add any number of arguments to the command.", "query": "number arguments command", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "tests/util.rs", "line": 282, "symbol": "env", "task": "Set an environment variable for this command.", "query": "environment variable this", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "tests/util.rs", "line": 299, "symbol": "current_dir", "task": "The path given is interpreted relative to the directory that this command was created for.", "query": "path given interpreted", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "tests/util.rs", "line": 345, "symbol": "assert_err", "task": "Runs the command and asserts that it resulted in an error exit code.", "query": "runs command asserts", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "tests/util.rs", "line": 465, "symbol": "dir_list", "task": "Return a recursive listing of all files and directories in the given directory.", "query": "return recursive listing", "lang": "en", "source": "docs"}
{"repo": "ripgrep", "file": "tests/util.rs", "line": 523, "symbol": "strip_jemalloc_nonsense", "task": "In theory this only happens under qemu, which is where our tests run under `cross`.", "query": "theory this only", "lang": "en", "source": "docs"}