Struct GetDir 

pub struct GetDir {
    pub dir: PathBuf,
    pub depth: usize,
    pub targets: Vec<Target>,
}

Utility to get directory.

Example

use std::path::PathBuf;

use get_dir::{
    GetDir,
    Target,
    DirTarget,
};

let path: PathBuf = GetDir::new()
    .target(
        Target::Dir(DirTarget::new("src")),
    )
    .run()
    .unwrap();

Fields

dir: PathBuf

The directory to run the process.

depth: usize

The depth of the search.

targets: Vec<Target>

The targets to search.

Implementations

impl GetDir

pub fn new() -> Self

Create a new GetDir instance.

Example

use std::path::PathBuf;

use get_dir::GetDir;

let path: PathBuf = GetDir::new()
    .run()
    .unwrap();

pub fn directory<D: Into<PathBuf>>(self, dir: D) -> Self

Specific the directory to run the process.

By default, it runs in current directory.

Example

use std::path::{
    Path,
    PathBuf,
};

use get_dir::GetDir;

let path: PathBuf = GetDir::new()
    .directory(Path::new(".").join("src"))
    .run()
    .unwrap();

pub fn dir<D: Into<PathBuf>>(self, dir: D) -> Self

Alias for GetDir::directory function.

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

Set the depth of the search.

By default, it is usize::MAX.

Example

use std::path::PathBuf;

use get_dir::GetDir;

let path: PathBuf = GetDir::new()
    .depth(2)
    .run()
    .unwrap();

pub fn targets<TS, T>(self, targets: TS) -> Self

where TS: IntoIterator<Item = T>, T: Into<Target>,

Add targets to the search.

Example

use std::path::PathBuf;

use get_dir::{
    GetDir,
    Target,
    DirTarget,
    FileTarget,
};

let path: PathBuf = GetDir::new()
    .targets([
        Target::Dir(DirTarget::new("src")),
        Target::File(FileTarget::new("Cargo.toml")),
    ])
    .run()
    .unwrap();

pub fn target(self, target: Target) -> Self

Add a target to the search.

Example

use std::path::PathBuf;

use get_dir::{
    GetDir,
    Target,
    DirTarget,
};

let path: PathBuf = GetDir::new()
    .target(Target::Dir(DirTarget::new("src")))
    .run()
    .unwrap();

pub fn run(self) -> Result<PathBuf>

Get the first directory containing any of the specified targets.

Example

use std::path::PathBuf;

use get_dir::GetDir;

let path: PathBuf = GetDir::new()
    .run()
    .unwrap();

pub fn run_reverse(self) -> Result<PathBuf>

Get the first directory containing any of the specified targets in reverse.

Example

use std::path::PathBuf;

use get_dir::GetDir;

let path: PathBuf = GetDir::new()
    .run_reverse()
    .unwrap();

Trait Implementations

impl Clone for GetDir

fn clone(&self) -> GetDir

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetDir

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

Formats the value using the given formatter.

impl Default for GetDir

fn default() -> Self

Returns the “default value” for a type.

impl GetDirAsyncExt for GetDir

async fn run_async(self) -> Result<PathBuf>

Get directory asynchronously.

async fn run_reverse_async(self) -> Result<PathBuf>

Get directory in reverse asynchronously.

impl GetDirAsyncExt for GetDir

async fn run_async(self) -> Result<PathBuf>

Get directory asynchronously.

async fn run_reverse_async(self) -> Result<PathBuf>

Get directory in reverse asynchronously.

impl GetDirAsyncExt for GetDir

async fn run_async(self) -> Result<PathBuf>

Get directory asynchronously.

async fn run_reverse_async(self) -> Result<PathBuf>

Get directory in reverse asynchronously.