Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kx0101/minigrep
MiniGrep is a Rust-based command-line tool, with a (current) size of 588KB that lets users search files for a given query string and shows matching lines with their line numbers.
https://github.com/kx0101/minigrep
boyre-moore cli performance rust rustlang
Last synced: 3 months ago
JSON representation
MiniGrep is a Rust-based command-line tool, with a (current) size of 588KB that lets users search files for a given query string and shows matching lines with their line numbers.
- Host: GitHub
- URL: https://github.com/kx0101/minigrep
- Owner: kx0101
- Created: 2023-11-26T20:30:04.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2023-12-02T16:18:48.000Z (about 1 year ago)
- Last Synced: 2024-09-29T20:41:20.094Z (3 months ago)
- Topics: boyre-moore, cli, performance, rust, rustlang
- Language: Rust
- Homepage: https://crates.io/crates/minigrep_elijahkx
- Size: 126 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MiniGrep
MiniGrep is a simple command-line utility written in Rust for searching text within files. It provides the capability to search for a specified query string in a given file, displaying lines containing the query along with their line numbers.
## Usage
## Command Syntax
```bash
minigrep [query] [file path(s)] [-i]
```
- query: The text string to search for within the file.
- file path(s): The path(s) to the file(s) in which the search will be performed separated by a comma. You can also use "." to search within the current directory.
- -i (Optional): Performs a case-insensitive search. If provided, the search will ignore the case of the query string.
## Example
```bash
# Perform a case-sensitive search for the word "hello" in the file "sample.txt"
minigrep hello sample.txt
# Perform a case-sensitive search for the word "hello" in the files "sample.txt" and "sample2.txt"
minigrep hello sample.txt sample2.txt
# Perform a case-sensitive search for the word "hello" in all the files in your current directory.
minigrep hello .
# Perform a case-insensitive search for the word "world" in the file "sample.txt"
minigrep world sample.txt -i
# Redirects the output to a new file. Error messages are not captured in the output file.
minigrep world sample.txt > output.txt
```
## How It Works
The program uses the following components:
- run: The main function responsible for executing the search based on the provided configurations.
- search: Performs a case-sensitive search for the query within the file's contents, returning a vector of tuples containing line numbers and matching lines. The algorithm that is being used is called [Boyer Moore](https://www.youtube.com/watch?v=PHXAOKQk2dw&ab_channel=MikeSlade)
- Time Complexity: Worst Case O(n * m) - Best Case O(m / n) where *m* is the length of the `query` and *n* is the length of the `contents`
- Space Complexity: O(k) where `k` is the space used for storing the matches.
- search_case_insensitive: Similar to search, but performs a case-insensitive search.
- Config: A structure that holds the query, file path, and a boolean flag to indicate whether the search should be case-insensitive.
- Config::build: Builds the configuration based on the command-line arguments provided.
The program utilizes multiple threads for concurrent file processing to enhance search speed when searching in multiple files. Each file search operation runs in its own thread.
## Running Tests
```bash
cargo test
```
## Notes
The program will display lines containing the query string along with their line numbers within the specified file.
If no matching lines are found, it will indicate that the query was not found in the file.
## Boyer Moore
[Boyer Moore](https://www.youtube.com/watch?v=PHXAOKQk2dw&ab_channel=MikeSlade)
