workspace_root 0.2.0

A utility to get workspace root
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
125
126

//! # Workspace Root
//!
//! A utility to get workspace root.
//!
//! The functions will try to get the workspace root by searching for the `Cargo.lock` file.
//! Then it will return the directory that contains the file.
//! If the file is not found, an error will be returned instead.
//!
//! ## Usage
//!
//! Get workspace root with the following code:
//!
//! ```no_run
//! use std::path::PathBuf;
//!
//! use workspace_root::get_workspace_root;
//!
//! let root: PathBuf = get_workspace_root();
//! ```
//!
//! Async version also available with `async_std`, `smol` and `tokio` features:
//!
//! ```no_run
//! // This is a `async_std` example
//!
//! use async_std::path::PathBuf;
//!
//! use workspace_root::async_std::get_workspace_root_async;
//!
//! # async fn example() {
//! let root: PathBuf = get_workspace_root_async().await;
//! # }
//! ```
//!
//! ```no_run
//! // This is a `smol` example
//!
//! use std::path::PathBuf;
//!
//! use workspace_root::smol::get_workspace_root_async;
//!
//! # async fn example() {
//! let root: PathBuf = get_workspace_root_async().await;
//! # }
//! ```
//!
//! ```no_run
//! // This is a `tokio` example
//!
//! use std::path::PathBuf;
//!
//! use workspace_root::tokio::get_workspace_root_async;
//!
//! # async fn example() {
//! let root: PathBuf = get_workspace_root_async().await;
//! # }
//! ```

/// Async functions available with `async_std` feature.
///
/// To use it, add the following code to the `Cargo.toml` file:
///
/// ```toml
/// [dependencies]
/// workspace_root = { version = "*", features = ["async_std"] }
/// ```
#[cfg(feature = "async_std")]
pub mod async_std;

/// Async functions available with `smol` feature.
///
/// To use it, add the following code to the `Cargo.toml` file:
///
/// ```toml
/// [dependencies]
/// workspace_root = { version = "*", features = ["smol"] }
/// ```
#[cfg(feature = "smol")]
pub mod smol;

/// Async functions available with `tokio` feature.
///
/// To use it, add the following code to the `Cargo.toml` file:
///
/// ```toml
/// [dependencies]
/// workspace_root = { version = "*", features = ["tokio"] }
/// ```
#[cfg(feature = "tokio")]
pub mod tokio;

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

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

/// Get the workspace root directory by searching for the `Cargo.lock` file.
///
/// Use [`get_workspace_root`] to handle the error automatically.
///
/// ```no_run
/// use std::path::PathBuf;
///
/// use workspace_root::get_workspace_root_directory;
///
/// let root: PathBuf = get_workspace_root_directory().unwrap();
/// ```
pub fn get_workspace_root_directory() -> io::Result<PathBuf> {
    GetDir::new()
        .target(Target::File(FileTarget::new("Cargo.lock")))
        .run_reverse()
}

/// Get the workspace root directory by searching for the `Cargo.lock` file.
///
/// Use [`get_workspace_root_directory`] to handle the error manually.
///
/// ```no_run
/// use std::path::PathBuf;
///
/// use workspace_root::get_workspace_root;
///
/// let root: PathBuf = get_workspace_root();
/// ```
pub fn get_workspace_root() -> PathBuf {
    get_workspace_root_directory().expect("Failed to get workspace root")
}