Expand description
Cross-platform path manipulation.
This module is an async version of std::path
.
This module provides two types, PathBuf
and Path
(akin to String
and str
), for working with paths abstractly. These types are thin wrappers
around OsString
and OsStr
respectively, meaning that they work directly
on strings according to the local platform’s path syntax.
Paths can be parsed into Component
s by iterating over the structure
returned by the components
method on Path
. Component
s roughly
correspond to the substrings between path separators (/
or \
). You can
reconstruct an equivalent path from components with the push
method on
PathBuf
; note that the paths may differ syntactically by the
normalization described in the documentation for the components
method.
Simple usage
Path manipulation includes both parsing components from slices and building new owned paths.
To parse a path, you can create a Path
slice from a str
slice and start asking questions:
use async_std::path::Path;
use std::ffi::OsStr;
let path = Path::new("/tmp/foo/bar.txt");
let parent = path.parent();
assert_eq!(parent, Some(Path::new("/tmp/foo")));
let file_stem = path.file_stem();
assert_eq!(file_stem, Some(OsStr::new("bar")));
let extension = path.extension();
assert_eq!(extension, Some(OsStr::new("txt")));
To build or modify paths, use PathBuf
:
use async_std::path::PathBuf;
// This way works...
let mut path = PathBuf::from("c:\\");
path.push("windows");
path.push("system32");
path.set_extension("dll");
// ... but push is best used if you don't know everything up
// front. If you do, this way is better:
let path: PathBuf = ["c:\\", "windows", "system32.dll"].iter().collect();
Structs
A slice of a path.
This struct is an async version of std::path::PathBuf
.
A structure wrapping a Windows path prefix as well as its unparsed string representation.
An error returned from Path::strip_prefix
if the prefix was not found.
Enums
Constants
The primary separator of path components for the current platform.
Functions
Determines whether the character is one of the permitted path separators for the current platform.