mirror of
https://github.com/BurntSushi/ripgrep.git
synced 2024-12-12 19:18:24 +02:00
d9ca529356
libripgrep is not any one library, but rather, a collection of libraries that roughly separate the following key distinct phases in a grep implementation: 1. Pattern matching (e.g., by a regex engine). 2. Searching a file using a pattern matcher. 3. Printing results. Ultimately, both (1) and (3) are defined by de-coupled interfaces, of which there may be multiple implementations. Namely, (1) is satisfied by the `Matcher` trait in the `grep-matcher` crate and (3) is satisfied by the `Sink` trait in the `grep2` crate. The searcher (2) ties everything together and finds results using a matcher and reports those results using a `Sink` implementation. Closes #162
38 lines
1.1 KiB
Markdown
38 lines
1.1 KiB
Markdown
grep-searcher
|
|
-------------
|
|
A high level library for executing fast line oriented searches. This handles
|
|
things like reporting contextual lines, counting lines, inverting a search,
|
|
detecting binary data, automatic UTF-16 transcoding and deciding whether or not
|
|
to use memory maps.
|
|
|
|
[](https://travis-ci.org/BurntSushi/ripgrep)
|
|
[](https://ci.appveyor.com/project/BurntSushi/ripgrep)
|
|
[](https://crates.io/crates/grep-searcher)
|
|
|
|
Dual-licensed under MIT or the [UNLICENSE](http://unlicense.org).
|
|
|
|
### Documentation
|
|
|
|
[https://docs.rs/grep-searcher](https://docs.rs/grep-searcher)
|
|
|
|
**NOTE:** You probably don't want to use this crate directly. Instead, you
|
|
should prefer the facade defined in the
|
|
[`grep`](https://docs.rs/grep)
|
|
crate.
|
|
|
|
|
|
### Usage
|
|
|
|
Add this to your `Cargo.toml`:
|
|
|
|
```toml
|
|
[dependencies]
|
|
grep-searcher = "0.1"
|
|
```
|
|
|
|
and this to your crate root:
|
|
|
|
```rust
|
|
extern crate grep_searcher;
|
|
```
|