parthjadhav/rust_search

Blazingly fast file search library built in Rust

Hi there, I'm Parth Jadhav 👋

Passionate full-stack developer skilled in Rust, TypeScript, Node.js, React.js, and cloud integration, creating innovative solutions for real-world problems, collaborative and driven, always up for a challenge, and loves the outdoors and trying new coffee shops.

👉 Explore all my projects, including those that aren't open source, on my Bento profile.

rust_search's Issues

Is there any example using this library in c++?

This is a cool library. I want to using this library in my c++ project, but I cannot find any example. I know I can use rust cxx to embed rust library to c++, but that's not easy to return string vector from rust to c++.
So hope any cxx/c++ exmaple using this library. Have you ever tired cxx? It will be awsome to have an example of that.

Possibility to set a limit for upcoming files

^ Title

I will work on it

[Feature Request]: Add search filters (Date Created, Date Modified, File Size)

Hi ,Support for increasing file size, establishment time and modification time.

Low speed on x86_64-unknown-linux-musl

Why so different speed for some targets?
For x86_64-unknown-linux-gnu

./target/release/walk    
Time elapsed: 1.022172369s
Found 11 files

and x7 slow for x86_64-unknown-linux-musl

./target/x86_64-unknown-linux-musl/release/walk
Time elapsed: 7.560947213s
Found 11 files

Why?

[Feature Request]: Make `Search` struct easier

Breaking changes

I think add search instance function to Search struct will make it easier. This will make it easier to do something like this

use rust_search::Search;

fn main() {
    let mains = Search::default().input("main").search();
    let readmes = Search::default().input("readme")
    .ignore_case() // will ignore ascii case
    .extension("md")
    .search();
}

[Feature]: Sort the paths by file names

Currently the results are scattered & random.

Eg:

Current output:
Search input: "a"
Search output: ["man", "cat", "ant", "ban", "tan"]

Expected result with .sort(true) :
Search input: "a"
Search output: ["ant", "ban", "cat", "man", "tan"]

Replace `~` with home directory in unix-like system

^ Title

I can claim it, will work in it after merge #9

[Bug]: Search work without file extension, but with it's not

^ Title

For example i have file it's name is some_random_word_yes_it_is.md in /home/User/foo/bar/

use rust_search::Search;

fn main(){
    let search = Search::new(
        "/home/User/foo/bar/",
        Some("yes"),
        None,
        None);

    for path in search {
        println!("{}", path);
    }
}

This will work, but when i add the file extinction it's not, for example

use rust_search::Search;

fn main(){
    let search = Search::new(
        "/home/User/foo/bar/",
        Some("yes"),
        Some(".md"), // also "md"
        None);

    for path in search {
        println!("{}", path);
    }
}

Return &Path or OsString object from iter

I am very impressed with the simplicity and speed of your solution!

Are you planning to abandon the use of String as a return value in the future? On Linux, this can create some problems, as far as I can tell.

[Feature Request]: Implement Caching

Question:

Should we? I'm not sure about this... Suggestions are open

Receiving the file extension without a dot

This will make it easier to solve #4 , and also to understand

[Documentation]: Add benchmarks

Benchmarks requests:

1. Glob Vs Rust_Search
2. FD vs Rust_Search
   ...
   More suggestions are welcome 😄

How to ?

Using hyperfine you can easily create benchmarks

[Bug]: Search input includes `location` to search for

let search: Vec<String> = SearchBuilder::default()
        .location("/System/")
        .search_input("Syste")
        .depth(1)
        .ignore_case()
        .build()
        .collect();

This will return everything contained in /System/ directory because the Regex will be matched with the path input i.e /System/ and return everything.

This could be solved by adding: .split("/").last().unwrap() to path

reg_exp.is_match(&path.split("/").last().unwrap())

@TheAwiteb , Is there a better way to do this? Or are there any implications using this approach ?

[request] Add example of returning results

I'm a total newb to Rust. Trying to figure out how to use this library in the context of https://github.com/tauri-apps/tauri but am having trouble getting the return value right. Trying to have it return the file paths in a simple array (to be used in JS).

Based on the example code:

use rust_search::SearchBuilder;

fn main(){
    let search: Vec<String> = 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);
    }

   // How to return `search` here as a simple array?
}

I've tried simply adding:

return search;

But that returns "expected (), found struct Vec".

I know that for Rust developers this is likely embarrassingly simple. Please forgive my ignorance! I've done quite a bit of searching and tested different things but nothing has worked.

Add it to Rust Awesome

Of course because it's awesome. https://github.com/rust-unofficial/awesome-rust

Is it possible to exclude directories?

This would help performance when using a high depth value and knowing that desired results are not in directories {...}. For example, node_modules (which often have deeply nested structures with lots of files).

rust_search::Filesize cannot be imported

error[E0432]: unresolved import rust_search::FileType
--> src/main.rs:3:5
|
3 | use rust_search::FileType;
| ^^^^^^^^^^^^^^^^^^^^^ no FileType in the root
|
help: consider importing this struct instead
|
3 | use std::fs::FileType;
| ~~~~~~~~~~~~~~~~~~

error[E0433]: failed to resolve: use of undeclared type FileSize