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 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462
/*!
# Path Absolutize
This is a library for extending `Path` and `PathBuf` in order to get an absolute path and remove the containing dots.
The difference between `absolutize` and `canonicalize` methods is that `absolutize` does not care about whether the file exists and what the file really is.
Please read the following examples to know the parsing rules.
## Examples
There are two methods you can use.
### absolutize
Get an absolute path.
The dots in a path will be parsed even if it is already an absolute path (which means the path starts with a `MAIN_SEPARATOR` on Unix-like systems).
```rust
use std::path::Path;
use path_absolutize::*;
let p = Path::new("/path/to/123/456");
# if cfg!(unix) {
# #[cfg(feature = "unsafe_cache")]
# {
# unsafe {
# update_cwd();
# }
# }
assert_eq!("/path/to/123/456", p.absolutize().unwrap().to_str().unwrap());
# }
```
```rust
use std::path::Path;
use path_absolutize::*;
let p = Path::new("/path/to/./123/../456");
# if cfg!(unix) {
# #[cfg(feature = "unsafe_cache")]
# {
# unsafe {
# update_cwd();
# }
# }
assert_eq!("/path/to/456", p.absolutize().unwrap().to_str().unwrap());
# }
```
If a path starts with a single dot, the dot means your program's **current working directory** (CWD).
```rust
use std::path::Path;
use std::env;
use path_absolutize::*;
let p = Path::new("./path/to/123/456");
# if cfg!(unix) {
# #[cfg(feature = "unsafe_cache")]
# {
# unsafe {
# update_cwd();
# }
# }
assert_eq!(Path::join(env::current_dir().unwrap().as_path(), Path::new("path/to/123/456")).to_str().unwrap(), p.absolutize().unwrap().to_str().unwrap());
# }
```
If a path starts with a pair of dots, the dots means the parent of the CWD. If the CWD is **root**, the parent is still **root**.
```rust
use std::path::Path;
use std::env;
use path_absolutize::*;
let p = Path::new("../path/to/123/456");
let cwd = env::current_dir().unwrap();
let cwd_parent = cwd.parent();
# if cfg!(unix) {
# #[cfg(feature = "unsafe_cache")]
# {
# unsafe {
# update_cwd();
# }
# }
match cwd_parent {
Some(cwd_parent) => {
assert_eq!(Path::join(&cwd_parent, Path::new("path/to/123/456")).to_str().unwrap(), p.absolutize().unwrap().to_str().unwrap());
}
None => {
assert_eq!(Path::join(Path::new("/"), Path::new("path/to/123/456")).to_str().unwrap(), p.absolutize().unwrap().to_str().unwrap());
}
}
# }
```
A path which does not start with a `MAIN_SEPARATOR`, **Single Dot** and **Double Dots**, will act like having a single dot at the start when `absolutize` method is used.
```rust
use std::path::Path;
use std::env;
use path_absolutize::*;
let p = Path::new("path/to/123/456");
# if cfg!(unix) {
# #[cfg(feature = "unsafe_cache")]
# {
# unsafe {
# update_cwd();
# }
# }
assert_eq!(Path::join(env::current_dir().unwrap().as_path(), Path::new("path/to/123/456")).to_str().unwrap(), p.absolutize().unwrap().to_str().unwrap());
# }
```
```rust
use std::path::Path;
use std::env;
use path_absolutize::*;
let p = Path::new("path/../../to/123/456");
let cwd = env::current_dir().unwrap();
let cwd_parent = cwd.parent();
# if cfg!(unix) {
# #[cfg(feature = "unsafe_cache")]
# {
# unsafe {
# update_cwd();
# }
# }
match cwd_parent {
Some(cwd_parent) => {
assert_eq!(Path::join(&cwd_parent, Path::new("to/123/456")).to_str().unwrap(), p.absolutize().unwrap().to_str().unwrap());
}
None => {
assert_eq!(Path::join(Path::new("/"), Path::new("to/123/456")).to_str().unwrap(), p.absolutize().unwrap().to_str().unwrap());
}
}
# }
```
### Starting from a given current working directory
With the `absolutize_from` function, you can provide the current working directory that the relative paths should be resolved from.
```rust
use std::env;
use std::path::Path;
use path_absolutize::*;
let p = Path::new("../path/to/123/456");
let cwd = env::current_dir().unwrap();
println!("{}", p.absolutize_from(cwd).unwrap().to_str().unwrap());
```
### absolutize_virtually
Get an absolute path **only under a specific directory**.
The dots in a path will be parsed even if it is already an absolute path (which means the path starts with a `MAIN_SEPARATOR` on Unix-like systems).
```rust
use std::path::Path;
use path_absolutize::*;
let p = Path::new("/path/to/123/456");
# if cfg!(unix) {
# #[cfg(feature = "unsafe_cache")]
# {
# unsafe {
# update_cwd();
# }
# }
assert_eq!("/path/to/123/456", p.absolutize_virtually("/").unwrap().to_str().unwrap());
# }
```
```rust
use std::path::Path;
use path_absolutize::*;
let p = Path::new("/path/to/./123/../456");
# if cfg!(unix) {
# #[cfg(feature = "unsafe_cache")]
# {
# unsafe {
# update_cwd();
# }
# }
assert_eq!("/path/to/456", p.absolutize_virtually("/").unwrap().to_str().unwrap());
# }
```
Every absolute path should under the virtual root.
```rust
use std::path::Path;
use std::io::ErrorKind;
use path_absolutize::*;
let p = Path::new("/path/to/123/456");
# if cfg!(unix) {
# #[cfg(feature = "unsafe_cache")]
# {
# unsafe {
# update_cwd();
# }
# }
assert_eq!(ErrorKind::InvalidInput, p.absolutize_virtually("/virtual/root").unwrap_err().kind());
# }
```
Every relative path should under the virtual root.
```rust
use std::path::Path;
use std::io::ErrorKind;
use path_absolutize::*;
let p = Path::new("./path/to/123/456");
# if cfg!(unix) {
# #[cfg(feature = "unsafe_cache")]
# {
# unsafe {
# update_cwd();
# }
# }
assert_eq!(ErrorKind::InvalidInput, p.absolutize_virtually("/virtual/root").unwrap_err().kind());
# }
```
```rust
use std::path::Path;
use std::io::ErrorKind;
use path_absolutize::*;
let p = Path::new("../path/to/123/456");
# if cfg!(unix) {
# #[cfg(feature = "unsafe_cache")]
# {
# unsafe {
# update_cwd();
# }
# }
assert_eq!(ErrorKind::InvalidInput, p.absolutize_virtually("/virtual/root").unwrap_err().kind());
# }
```
A path which does not start with a `MAIN_SEPARATOR`, **Single Dot** and **Double Dots**, will be located in the virtual root after the `absolutize_virtually` method is used.
```rust
use std::path::Path;
use path_absolutize::*;
let p = Path::new("path/to/123/456");
# if cfg!(unix) {
# #[cfg(feature = "unsafe_cache")]
# {
# unsafe {
# update_cwd();
# }
# }
assert_eq!("/virtual/root/path/to/123/456", p.absolutize_virtually("/virtual/root").unwrap().to_str().unwrap());
# }
```
```rust
use std::path::Path;
use path_absolutize::*;
let p = Path::new("path/to/../../../../123/456");
# if cfg!(unix) {
# #[cfg(feature = "unsafe_cache")]
# {
# unsafe {
# update_cwd();
# }
# }
assert_eq!("/virtual/root/123/456", p.absolutize_virtually("/virtual/root").unwrap().to_str().unwrap());
# }
```
## Caching
By default, the `absolutize` method and the `absolutize_virtually` method create a new `PathBuf` instance of the CWD every time in their operation. The overhead is obvious. Although it allows us to safely change the CWD at runtime by the program itself (e.g. using the `std::env::set_current_dir` function) or outside controls (e.g. using gdb to call `chdir`), we don't need that in most cases.
In order to parse paths with better performance, this crate provides three ways to cache the CWD.
### once_cell_cache
Enabling the `once_cell_cache` feature can let this crate use `once_cell` to cache the CWD. It's thread-safe and does not need to modify any code, but once the CWD is cached, it cannot be changed anymore at runtime.
```toml
[dependencies.path-absolutize]
version = "*"
features = ["once_cell_cache"]
```
### lazy_static_cache
Enabling the `lazy_static_cache` feature can let this crate use `lazy_static` to cache the CWD. It's thread-safe and does not need to modify any code, but once the CWD is cached, it cannot be changed anymore at runtime.
```toml
[dependencies.path-absolutize]
version = "*"
features = ["lazy_static_cache"]
```
### unsafe_cache
Enabling the `unsafe_cache` feature can let this crate use a mutable static variable to cache the CWD. It allows the program to change the CWD at runtime by the program itself, but it's not thread-safe.
You need to use the `update_cwd` function to initialize the CWD first. The function should also be used to update the CWD after the CWD is changed.
```toml
[dependencies.path-absolutize]
version = "*"
features = ["unsafe_cache"]
```
```rust
use std::path::Path;
use path_absolutize::*;
# #[cfg(feature = "unsafe_cache")]
unsafe {
update_cwd();
}
let p = Path::new("./path/to/123/456");
println!("{}", p.absolutize().unwrap().to_str().unwrap());
std::env::set_current_dir("/").unwrap();
# #[cfg(feature = "unsafe_cache")]
unsafe {
update_cwd();
}
println!("{}", p.absolutize().unwrap().to_str().unwrap());
```
## Benchmark
#### No-cache
```bash
cargo bench
```
#### once_cell_cache
```bash
cargo bench --features once_cell_cache
```
#### lazy_static_cache
```bash
cargo bench --features lazy_static_cache
```
#### unsafe_cache
```bash
cargo bench --features unsafe_cache
```
*/
#[cfg(any(
all(feature = "lazy_static_cache", feature = "unsafe_cache"),
all(feature = "once_cell_cache", feature = "unsafe_cache"),
all(feature = "lazy_static_cache", feature = "once_cell_cache")
))]
compile_error!("You can only enable at most one caching mechanism for `path-absolutize`.");
pub extern crate path_dedot;
use std::{
borrow::Cow,
io,
path::{Path, PathBuf},
};
#[cfg(feature = "unsafe_cache")]
pub use path_dedot::update_cwd;
#[cfg(any(
feature = "once_cell_cache",
feature = "lazy_static_cache",
feature = "unsafe_cache"
))]
pub use path_dedot::CWD;
mod absolutize;
#[macro_use]
mod macros;
#[cfg(any(unix, all(target_family = "wasm", feature = "use_unix_paths_on_wasm")))]
mod unix;
#[cfg(windows)]
mod windows;
pub use absolutize::*;
impl Absolutize for PathBuf {
#[inline]
fn absolutize(&self) -> io::Result<Cow<Path>> {
self.as_path().absolutize()
}
#[inline]
fn absolutize_from(&self, cwd: impl AsRef<Path>) -> io::Result<Cow<'_, Path>> {
self.as_path().absolutize_from(cwd)
}
#[inline]
fn absolutize_virtually(&self, virtual_root: impl AsRef<Path>) -> io::Result<Cow<Path>> {
self.as_path().absolutize_virtually(virtual_root)
}
}