get_dir 0.5.0

A utility to get directory
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

//! # Get Dir
//!
//! A 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:
//!
//! ```rust
//! use std::path::PathBuf;
//!
//! use get_dir::{
//!     GetDir,
//!     Target,
//!     DirTarget,
//! };
//!
//! let path: PathBuf = GetDir::new()
//!     .target(
//!         Target::Dir(DirTarget::new("src")),
//!     )
//!     .run()
//!     .unwrap();
//! ```
//!
//! Or get directory by target in reverse with the following code:
//!
//! ```rust
//! use std::path::PathBuf;
//!
//! use get_dir::{
//!     GetDir,
//!     Target,
//!     FileTarget,
//! };
//!
//! let path: PathBuf = GetDir::new()
//!     .target(
//!         Target::File(FileTarget::new("LICENSE")),
//!     )
//!     .run_reverse()
//!     .unwrap();
//! ```
//!     
//! Async version also available with `async_std`, `smol` and `tokio` features:
//!
//! ```ignore
//! use std::path::PathBuf;
//!
//! use get_dir::{
//!     GetDir,
//!     Target,
//!     DirTarget,
//!     // async_std,
//!     async_std::GetDirAsyncExt,
//!     // smol
//!     smol::GetDirAsyncExt,
//!     // tokio
//!     tokio::GetDirAsyncExt,
//! };
//!
//! # async fn example() {
//! let path: PathBuf = GetDir::new()
//!     .target(
//!         Target::Dir(DirTarget::new("src")),
//!     )
//!     .run_async()
//!     .await
//!     .unwrap();
//! # }
//! ```

pub(crate) mod structs;

pub(crate) mod util;

pub use crate::structs::target::dir::DirTarget;

pub use crate::structs::target::file::FileTarget;

pub use crate::structs::target::Target;

pub use crate::util::GetDir;

/// Run asynchronously with `async_std` feature.
///
/// To use it, add the following code to the `Cargo.toml` file:
///
/// ```toml
/// [dependencies]
/// get_dir = { version = "*", features = ["async_std"] }
/// ```
#[cfg(feature = "async_std")]
pub mod async_std {
    pub use crate::util::async_std::GetDirAsyncExt;
}

/// Run asynchronously with `smol` feature.
///
/// To use it, add the following code to the `Cargo.toml` file:
///
/// ```toml
/// [dependencies]
/// get_dir = { version = "*", features = ["smol"] }
/// ```
#[cfg(feature = "smol")]
pub mod smol {
    pub use crate::util::smol::GetDirAsyncExt;
}

/// Run asynchronously with `tokio` feature.
///
/// To use it, add the following code to the `Cargo.toml` file:
///
/// ```toml
/// [dependencies]
/// get_dir = { version = "*", features = ["tokio"] }
/// ```
#[cfg(feature = "tokio")]
pub mod tokio {
    pub use crate::util::tokio::GetDirAsyncExt;
}