Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/parthjadhav/rust_search
Blazingly fast file search library built in Rust
https://github.com/parthjadhav/rust_search
crate fast filesearch filesystem hacktoberfest library recursive-algorithm rust rust-lang rust-search rustsearch search search-algorithm search-engine
Last synced: 1 day ago
JSON representation
Blazingly fast file search library built in Rust
- Host: GitHub
- URL: https://github.com/parthjadhav/rust_search
- Owner: ParthJadhav
- License: mit
- Created: 2022-10-29T06:55:19.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-12-26T06:41:03.000Z (12 months ago)
- Last Synced: 2024-12-14T16:07:56.714Z (8 days ago)
- Topics: crate, fast, filesearch, filesystem, hacktoberfest, library, recursive-algorithm, rust, rust-lang, rust-search, rustsearch, search, search-algorithm, search-engine
- Language: Rust
- Homepage:
- Size: 33.2 KB
- Stars: 144
- Watchers: 4
- Forks: 15
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
Blazingly fast file search crate built in Rust 🔥
[](https://crates.io/crates/rust_search)
[](https://docs.rs/rust_search)
[](https://github.com/parthjadhav/rust_search/blob/master/LICENSE-MIT)
## 📦 Usage
Please report any problems you encounter when using rust search here: [Issues](https://github.com/ParthJadhav/rust_search/issues)
Add `rust_search = "2.0.0"` in Cargo.toml.
```toml
[dependencies]
rust_search = "2.0.0"
```
## Examples
- General use
```rust
use rust_search::SearchBuilder;
fn main(){
let search: Vec = SearchBuilder::default()
.location("~/path/to/directory")
.search_input("what to search")
.more_locations(vec!["/anotherPath/to/search", "/keepAddingIfYouWant/"])
.limit(1000) // results to return
.ext("extension")
.strict()
.depth(1)
.ignore_case()
.hidden()
.build()
.collect();
for path in search {
println!("{}", path);
}
}
```
- Sort the output by similarity with the input
```rust
use rust_search::{SearchBuilder, similarity_sort};
fn main() {
let search_input = "fly";
let mut search: Vec = SearchBuilder::default()
.location("~/Desktop/")
.search_input(search_input)
.depth(1)
.ignore_case()
.build()
.collect();
similarity_sort(&mut search, &search_input);
for path in search {
println!("{:?}", path);
}
}
```
> search **without** similarity sort
`["afly.txt", "bfly.txt", "flyer.txt", "fly.txt"]`
> search **with** similarity sort
`["fly.txt", "flyer.txt", "afly.txt", "bfly.txt",]`
- To get all the files with a specific extension in a directory, use:
```rust
use rust_search::SearchBuilder;
let files: Vec = SearchBuilder::default()
.location("/path/to/directory")
.ext("file_extension")
.build()
.collect();
```
- To get all the files in a directory, use:
```rust
use rust_search::SearchBuilder;
let files: Vec = SearchBuilder::default()
.location("/path/to/directory")
.depth(1)
.build()
.collect();
```
To filter files by date_created, date_modified, file_size and/or custom_filter, use:
```rust
use rust_search::{FileSize, FilterExt, SearchBuilder};
use std::time::{Duration, SystemTime};
let search: Vec = SearchBuilder::default()
.location("~/path/to/directory")
.file_size_greater(FileSize::Kilobyte(200.0))
.file_size_smaller(FileSize::Megabyte(10.0))
.created_after(SystemTime::now() - Duration::from_secs(3600 * 24 * 10))
.created_before(SystemTime::now())
.modified_after(SystemTime::now() - Duration::from_secs(3600 * 24 * 5))
.custom_filter(|dir| dir.metadata().unwrap().is_file())
.custom_filter(|dir| !dir.metadata().unwrap().permissions().readonly())
.build()
.collect();
```
👉 For more examples, please refer to the [Documentation](https://docs.rs/rust_search/latest/rust_search/)
## ⚙️ Benchmarks
The difference in sample size is due to the fact that fd and glob are different tools and have different use cases. fd is a command line tool that searches for files and directories. glob is a library that can be used to search for files and directories. The benchmark is done on a MacBook Air M2, 16 GB Unified memory.
Benchmarks are done using [hyperfine](https://github.com/sharkdp/hyperfine),
Benchmarks files are available in the [benchmarks](https://drive.google.com/drive/folders/1ug6ojNixS5jAe6Lh6M0o2d3tku73zQ9w?usp=sharing) drive folder.
### - Rust Search vs Glob
The benchmark was done on a directories containing 300K files.
| Command / Library | Mean [s] | Min [s] | Max [s] | Relative |
|:---|---:|---:|---:|---:|
| `rust_search` | 1.317 ± 0.002 | 1.314 | 1.320 | 1.00 |
| `glob` | 22.728 ± 0.023 | 22.690 | 22.746 | 17.25 ± 0.03 |
---
### - Rust Search vs FD
The benchmark was done on a directories containing 45K files.
| Command / Library | Mean [ms] | Min [ms] | Max [ms] | Relative |
|:---|---:|---:|---:|---:|
| `rust_search` | 680.5 ± 2.1 | 678.3 | 683.6 | 1.00 |
| `fd -e .js` | 738.7 ± 10.2 | 720.8 | 746.7 | 1.09 ± 0.02 |
---
### Results:-
```diff
+ rust_search is 17.25 times faster than Glob.
+ rust_search** is 1.09 times faster than FD.
```
## 👨💻 Contributors
Any contributions would be greatly valued as this library is still in its early stages.
- Documentation
- Benchmarks
- Implementation guidelines
- Code Improvement
If you want to contribute to this project, please follow the steps below:
1. Fork the project
2. Clone the forked repository
3. Create a feature branch
4. Make changes to the code
5. Commit the changes
6. Push the changes to the forked repository
7. Create a pull request
8. Wait for the pull request to be reviewed and merged (if approved)
## License
This project is licensed under the terms of the MIT license.
## Discord server & Linkedin
Click the button below to join the discord server or Linkedin
