https://github.com/pythonbyte/grep-command-rust
Implementation of the famous GREP command using Rust 🦀
https://github.com/pythonbyte/grep-command-rust
Last synced: 11 months ago
JSON representation
Implementation of the famous GREP command using Rust 🦀
- Host: GitHub
- URL: https://github.com/pythonbyte/grep-command-rust
- Owner: pythonbyte
- Created: 2024-08-18T01:49:43.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-18T02:16:19.000Z (almost 2 years ago)
- Last Synced: 2025-03-05T11:35:27.786Z (over 1 year ago)
- Language: Rust
- Size: 5.86 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rust Grep-like Tool
## Introduction
This project implements a simple grep-like tool in Rust. It provides basic regular expression matching functionality, allowing users to search for patterns in text input. This tool is designed as an educational project to demonstrate regex matching algorithms and Rust programming concepts.
## Features
- Basic regex pattern matching
- Support for the following regex features:
- `^` for start of string anchor
- `$` for end of string anchor
- `.` for any character
- `*` for zero or more repetitions of the previous character
- Command-line interface similar to grep
## Installation
To use this tool, you need to have Rust installed on your system. If you don't have Rust installed, you can get it from [https://www.rust-lang.org/tools/install](https://www.rust-lang.org/tools/install).
Once Rust is installed, follow these steps:
1. Clone the repository:
```
git clone https://github.com/yourusername/rust-grep-tool.git
cd rust-grep-tool
```
2. Build the project:
```
cargo build --release
```
The executable will be available in the `target/release` directory.
## Usage
The basic usage of the tool is as follows:
```
./rust-grep-tool -E
```
The tool reads input from stdin and prints whether the input matches the given pattern.
### Examples
1. Search for a simple string:
```
echo "Hello, World" | ./rust-grep-tool -E "World"
```
2. Use a start-of-line anchor:
```
echo "Hello, World" | ./rust-grep-tool -E "^Hello"
```
3. Use a wildcard and repetition:
```
echo "aaabbb" | ./rust-grep-tool -E "a*b"
```
## Limitations
This is a basic implementation and does not support all features of a full-fledged regex engine. It's primarily intended for educational purposes and may not be suitable for complex pattern matching tasks.
## Contributing
Contributions to improve the tool or extend its functionality are welcome. Please feel free to submit issues or pull requests on the project's GitHub page.
## Acknowledgements
This project was inspired by the regex matching algorithm described in "Beautiful Code" by Brian Kernighan, which was originally based on Rob Pike's implementation.