📦 Usage

Please report any problems you encounter when using rust search here: 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") .searchinput("what to search") .morelocations(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);
}

} ```

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(); ```

👉 For more examples, please refer to the Documentation

⚙️ 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, Benchmarks files are available in the benchmarks 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