Struct SearchBuilder

Source

pub struct SearchBuilder { /* private fields */ }

Expand description

Builder for a Search instance, allowing for more complex searches.

Implementations§

Source §

impl SearchBuilder

Source

pub fn build(&self) -> Search ⓘ

Build a new Search instance.

Source

pub fn location(self, location: impl AsRef<Path>) -> Self

Set the search location to search in.

§Notes

Will replace ~ with home directory

§Arguments

location - The location to search in.

§Examples

use rust_search::SearchBuilder;

let search: Vec<String> = SearchBuilder::default()
    .location("src")
    .build()
    .collect();

Source

pub fn search_input(self, input: impl Into<String>) -> Self

Set the search input.

§Arguments

input - The search input.

§Examples

use rust_search::SearchBuilder;

let search: Vec<String> = SearchBuilder::default()
    .search_input("Search")
    .build()
    .collect();

Source

pub fn ext(self, ext: impl Into<String>) -> Self

Set the file extension to search for.

§Arguments

ext - The file extension to search for.

§Examples

use rust_search::SearchBuilder;

let search: Vec<String> = SearchBuilder::default()
    .ext("rs")
    .build()
    .collect();

Source

pub fn filter(self, filter: FilterType) -> Self

Add a filter to the search function.

§Arguments

filter - Closure getting dir: DirEntry variable to modify

§Examples

use rust_search::{FileSize, FilterExt, SearchBuilder};
use std::time::{Duration, SystemTime};

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

Source

pub fn depth(self, depth: usize) -> Self

Set the depth to search to, meaning how many subdirectories to search in.

§Arguments

depth - The depth to search to.

§Examples

use rust_search::SearchBuilder;

let search: Vec<String> = SearchBuilder::default()
    .depth(1)
    .build()
    .collect();

Source

pub fn limit(self, limit: usize) -> Self

Set the limit of results to return. This will limit the amount of results returned.

§Arguments

limit - The limit of results to return.

§Examples

use rust_search::SearchBuilder;

let search: Vec<String> = SearchBuilder::default()
    .limit(5)
    .build()
    .collect();

Source

pub fn strict(self) -> Self

Searches for exact match.

For example, if the search input is “Search”, the file “Search.rs” will be found, but not “Searcher.rs”.

§Examples

use rust_search::SearchBuilder;

let search: Vec<String> = SearchBuilder::default()
    .search_input("name")
    .strict()
    .build()
    .collect();

Source

pub fn ignore_case(self) -> Self

Set search option to be case insensitive.

For example, if the search input is “Search”, the file “search.rs” will be found.

§Examples

use rust_search::SearchBuilder;

let search: Vec<String> = SearchBuilder::default()
    .search_input("name")
    .ignore_case()
    .build()
    .collect();

Source

pub fn hidden(self) -> Self

Searches for hidden files.

§Examples

use rust_search::SearchBuilder;

let search: Vec<String> = SearchBuilder::default()
    .with_hidden()
    .build()
    .collect();

Source

pub fn more_locations(self, more_locations: Vec<impl AsRef<Path>>) -> Self

Add extra locations to search in, in addition to the main location.

§Notes

Will replace ~ with home directory

§Arguments

more_locations - locations to search in.

§Examples

use rust_search::SearchBuilder;

let search: Vec<String> = SearchBuilder::default()
    .more_locations(vec!["/Users/username/b/", "/Users/username/c/"])
    .build()
    .collect();