Crate get_dir

Expand description

§Get Dir

An utility to get directory.

This utility searches for a target directory by checking for any directories or files that match the provided input.

§Usage

Get directory by target with the following code:

use get_dir::{
    Target,
    TargetType,
    get_dir_by_target,
};

get_dir_by_target(Target {
    name: "src",
    ty: TargetType::Dir,
});

Or get directory by target in reverse with the following code:

use get_dir::{
    Target,
    TargetType,
    get_dir_by_target_reverse,
};

get_dir_by_target_reverse(Target {
    name: "LICENSE",
    ty: TargetType::File,
});

Structs§

Target: Target struct for searching functions.

Enums§

TargetType: Enum to determine whether the target is a directory or a file.

Functions§

get_dir_by_target: Search for the first directory containing the specified target from the current directory downwards.
get_dir_by_target_reverse: Search for the first directory containing the specified target from the current directory upwards.
get_dir_by_targets: Search for the first directory containing any of the specified targets from the current directory downwards.
get_dir_by_targets_reverse: Search for the first directory containing any of the specified targets from the current directory upwards.
get_project_root: Get the project root directory by searching for the target folder and the Cargo.lock file. Use get_project_root_directory to handle the error manually.
get_project_root_directory: Get the project root directory by searching for the target folder and the Cargo.lock file. Use get_project_root to handle the error automatically.