Enum find_folder::Search

pub enum Search {
    Parents(ParentsDepth),
    Kids(KidsDepth),
    ParentsThenKids(ParentsDepth, KidsDepth),
    KidsThenParents(KidsDepth, ParentsDepth),
}

The direction in which find_folder should search for the folder.

Variants

Parents(ParentsDepth)

Search recursively through parent directories with the given depth.

Kids(KidsDepth)

Search recursively through children directories with the given depth.

ParentsThenKids(ParentsDepth, KidsDepth)

Search parents and then kids (same as Both).

KidsThenParents(KidsDepth, ParentsDepth)

Search kids and then parents.

Implementations

impl Search

pub fn for_folder(&self, target: &str) -> Result<PathBuf, Error>

An easy API method for finding a folder with a given name. i.e. Search::Kids(u8).for_folder("assets")

pub fn of(self, start: PathBuf) -> SearchFolder

Use this to search in a specific folder.

This method transforms a Search into a SearchFolder, but that detail is mostly irrelevant. See the example for recommended usage.

Example

use find_folder::Search;

let mut exe_folder = std::env::current_exe().unwrap();
exe_folder.pop(); // Remove the executable's name, leaving the path to the containing folder
let resource_path = Search::KidsThenParents(1, 2).of(exe_folder).for_folder("resources");

Trait Implementations

impl Clone for Search

fn clone(&self) -> Search

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Search

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Search

fn eq(&self, other: &Search) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Search

impl Eq for Search

impl StructuralEq for Search

impl StructuralPartialEq for Search