pub struct PathBuf { /* private fields */ }Expand description
An owned, mutable path (akin to String).
This type provides methods like push and set_extension that mutate
the path in place. It also implements Deref to Path, meaning that
all methods on Path slices are available on PathBuf values as well.
More details about the overall approach can be found in the crate documentation.
§Examples
You can use push to build up a PathBuf from
components:
use unix_path::PathBuf;
let mut path = PathBuf::new();
path.push("/");
path.push("feel");
path.push("the");
path.set_extension("force");However, push is best used for dynamic situations. This is a better way
to do this when you know all of the components ahead of time:
use unix_path::PathBuf;
let path: PathBuf = ["/", "feel", "the.force"].iter().collect();We can still do better than this! Since these are all strings, we can use
From::from:
use unix_path::PathBuf;
let path = PathBuf::from(r"/feel/the.force");Which method works best depends on what kind of situation you’re in.
Implementations§
Source§impl PathBuf
impl PathBuf
Sourcepub fn with_capacity(capacity: usize) -> PathBuf
pub fn with_capacity(capacity: usize) -> PathBuf
Creates a new PathBuf with a given capacity used to create the
internal UnixString. See with_capacity defined on UnixString.
§Examples
use unix_path::PathBuf;
let mut path = PathBuf::with_capacity(10);
let capacity = path.capacity();
// This push is done without reallocating
path.push("/");
assert_eq!(capacity, path.capacity());Sourcepub fn push<P: AsRef<Path>>(&mut self, path: P)
pub fn push<P: AsRef<Path>>(&mut self, path: P)
Extends self with path.
If path is absolute, it replaces the current path.
§Examples
Pushing a relative path extends the existing path:
use unix_path::PathBuf;
let mut path = PathBuf::from("/tmp");
path.push("file.bk");
assert_eq!(path, PathBuf::from("/tmp/file.bk"));Pushing an absolute path replaces the existing path:
use unix_path::PathBuf;
let mut path = PathBuf::from("/tmp");
path.push("/etc");
assert_eq!(path, PathBuf::from("/etc"));Sourcepub fn pop(&mut self) -> bool
pub fn pop(&mut self) -> bool
Truncates self to self.parent.
Returns false and does nothing if self.parent is None.
Otherwise, returns true.
§Examples
use unix_path::{Path, PathBuf};
let mut p = PathBuf::from("/test/test.rs");
p.pop();
assert_eq!(Path::new("/test"), p);
p.pop();
assert_eq!(Path::new("/"), p);Sourcepub fn set_file_name<S: AsRef<UnixStr>>(&mut self, file_name: S)
pub fn set_file_name<S: AsRef<UnixStr>>(&mut self, file_name: S)
Updates self.file_name to file_name.
If self.file_name was None, this is equivalent to pushing
file_name.
Otherwise it is equivalent to calling pop and then pushing
file_name. The new path will be a sibling of the original path.
(That is, it will have the same parent.)
§Examples
use unix_path::PathBuf;
let mut buf = PathBuf::from("/");
assert!(buf.file_name() == None);
buf.set_file_name("bar");
assert!(buf == PathBuf::from("/bar"));
assert!(buf.file_name().is_some());
buf.set_file_name("baz.txt");
assert!(buf == PathBuf::from("/baz.txt"));Sourcepub fn set_extension<S: AsRef<UnixStr>>(&mut self, extension: S) -> bool
pub fn set_extension<S: AsRef<UnixStr>>(&mut self, extension: S) -> bool
Updates self.extension to extension.
Returns false and does nothing if self.file_name is None,
returns true and updates the extension otherwise.
If self.extension is None, the extension is added; otherwise
it is replaced.
§Examples
use unix_path::{Path, PathBuf};
let mut p = PathBuf::from("/feel/the");
p.set_extension("force");
assert_eq!(Path::new("/feel/the.force"), p.as_path());
p.set_extension("dark_side");
assert_eq!(Path::new("/feel/the.dark_side"), p.as_path());Sourcepub fn into_unix_string(self) -> UnixString
pub fn into_unix_string(self) -> UnixString
Consumes the PathBuf, yielding its internal UnixString storage.
§Examples
use unix_path::PathBuf;
let p = PathBuf::from("/the/head");
let bytes = p.into_unix_string();Sourcepub fn into_boxed_path(self) -> Box<Path>
pub fn into_boxed_path(self) -> Box<Path>
Converts this PathBuf into a boxed Path.
Sourcepub fn reserve(&mut self, additional: usize)
pub fn reserve(&mut self, additional: usize)
Invokes reserve on the underlying instance of UnixString.
Sourcepub fn reserve_exact(&mut self, additional: usize)
pub fn reserve_exact(&mut self, additional: usize)
Invokes reserve_exact on the underlying instance of UnixString.
Sourcepub fn shrink_to_fit(&mut self)
pub fn shrink_to_fit(&mut self)
Invokes shrink_to_fit on the underlying instance of UnixString.
Methods from Deref<Target = Path>§
Sourcepub fn as_unix_str(&self) -> &UnixStr
pub fn as_unix_str(&self) -> &UnixStr
Yields the underlying bytes.
§Examples
use unix_path::Path;
use unix_str::UnixStr;
let os_str = Path::new("foo.txt").as_unix_str();
assert_eq!(os_str, UnixStr::new("foo.txt"));Sourcepub fn to_str(&self) -> Option<&str>
pub fn to_str(&self) -> Option<&str>
Yields a &str slice if the Path is valid unicode.
This conversion may entail doing a check for UTF-8 validity. Note that validation is performed because non-UTF-8 strings are perfectly valid for some OS.
§Examples
use unix_path::Path;
let path = Path::new("foo.txt");
assert_eq!(path.to_str(), Some("foo.txt"));Sourcepub fn to_string_lossy(&self) -> Cow<'_, str>
pub fn to_string_lossy(&self) -> Cow<'_, str>
Converts a Path to a Cow<str>.
Any non-Unicode sequences are replaced with
U+FFFD REPLACEMENT CHARACTER.
§Examples
Calling to_string_lossy on a Path with valid unicode:
use unix_path::Path;
let path = Path::new("foo.txt");
assert_eq!(path.to_string_lossy(), "foo.txt");Had path contained invalid unicode, the to_string_lossy call might
have returned "fo�.txt".
Sourcepub fn to_path_buf(&self) -> PathBuf
pub fn to_path_buf(&self) -> PathBuf
Sourcepub fn is_absolute(&self) -> bool
pub fn is_absolute(&self) -> bool
Sourcepub fn is_relative(&self) -> bool
pub fn is_relative(&self) -> bool
Returns true if the Path is relative, i.e., not absolute.
See is_absolute’s documentation for more details.
§Examples
use unix_path::Path;
assert!(Path::new("foo.txt").is_relative());Sourcepub fn has_root(&self) -> bool
pub fn has_root(&self) -> bool
Returns true if the Path has a root.
A path has a root if it begins with /.
§Examples
use unix_path::Path;
assert!(Path::new("/etc/passwd").has_root());Sourcepub fn parent(&self) -> Option<&Path>
pub fn parent(&self) -> Option<&Path>
Returns the Path without its final component, if there is one.
Returns None if the path terminates in a root or prefix.
§Examples
use unix_path::Path;
let path = Path::new("/foo/bar");
let parent = path.parent().unwrap();
assert_eq!(parent, Path::new("/foo"));
let grand_parent = parent.parent().unwrap();
assert_eq!(grand_parent, Path::new("/"));
assert_eq!(grand_parent.parent(), None);Sourcepub fn ancestors(&self) -> Ancestors<'_> ⓘ
pub fn ancestors(&self) -> Ancestors<'_> ⓘ
Produces an iterator over Path and its ancestors.
The iterator will yield the Path that is returned if the parent method is used zero
or more times. That means, the iterator will yield &self, &self.parent().unwrap(),
&self.parent().unwrap().parent().unwrap() and so on. If the parent method returns
None, the iterator will do likewise. The iterator will always yield at least one value,
namely &self.
§Examples
use unix_path::Path;
let mut ancestors = Path::new("/foo/bar").ancestors();
assert_eq!(ancestors.next(), Some(Path::new("/foo/bar")));
assert_eq!(ancestors.next(), Some(Path::new("/foo")));
assert_eq!(ancestors.next(), Some(Path::new("/")));
assert_eq!(ancestors.next(), None);Sourcepub fn file_name(&self) -> Option<&UnixStr>
pub fn file_name(&self) -> Option<&UnixStr>
Returns the final component of the Path, if there is one.
If the path is a normal file, this is the file name. If it’s the path of a directory, this is the directory name.
Returns None if the path terminates in ...
§Examples
use unix_path::Path;
use unix_str::UnixStr;
assert_eq!(Some(UnixStr::new("bin")), Path::new("/usr/bin/").file_name());
assert_eq!(Some(UnixStr::new("foo.txt")), Path::new("tmp/foo.txt").file_name());
assert_eq!(Some(UnixStr::new("foo.txt")), Path::new("foo.txt/.").file_name());
assert_eq!(Some(UnixStr::new("foo.txt")), Path::new("foo.txt/.//").file_name());
assert_eq!(None, Path::new("foo.txt/..").file_name());
assert_eq!(None, Path::new("/").file_name());Sourcepub fn strip_prefix<P>(&self, base: P) -> Result<&Path, StripPrefixError>
pub fn strip_prefix<P>(&self, base: P) -> Result<&Path, StripPrefixError>
Returns a path that, when joined onto base, yields self.
§Errors
If base is not a prefix of self (i.e., starts_with
returns false), returns Err.
§Examples
use unix_path::{Path, PathBuf};
let path = Path::new("/test/haha/foo.txt");
assert_eq!(path.strip_prefix("/"), Ok(Path::new("test/haha/foo.txt")));
assert_eq!(path.strip_prefix("/test"), Ok(Path::new("haha/foo.txt")));
assert_eq!(path.strip_prefix("/test/"), Ok(Path::new("haha/foo.txt")));
assert_eq!(path.strip_prefix("/test/haha/foo.txt"), Ok(Path::new("")));
assert_eq!(path.strip_prefix("/test/haha/foo.txt/"), Ok(Path::new("")));
assert_eq!(path.strip_prefix("test").is_ok(), false);
assert_eq!(path.strip_prefix("/haha").is_ok(), false);
let prefix = PathBuf::from("/test/");
assert_eq!(path.strip_prefix(prefix), Ok(Path::new("haha/foo.txt")));Sourcepub fn starts_with<P: AsRef<Path>>(&self, base: P) -> bool
pub fn starts_with<P: AsRef<Path>>(&self, base: P) -> bool
Determines whether base is a prefix of self.
Only considers whole path components to match.
§Examples
use unix_path::Path;
let path = Path::new("/etc/passwd");
assert!(path.starts_with("/etc"));
assert!(path.starts_with("/etc/"));
assert!(path.starts_with("/etc/passwd"));
assert!(path.starts_with("/etc/passwd/"));
assert!(!path.starts_with("/e"));Sourcepub fn ends_with<P: AsRef<Path>>(&self, child: P) -> bool
pub fn ends_with<P: AsRef<Path>>(&self, child: P) -> bool
Determines whether child is a suffix of self.
Only considers whole path components to match.
§Examples
use unix_path::Path;
let path = Path::new("/etc/passwd");
assert!(path.ends_with("passwd"));Sourcepub fn file_stem(&self) -> Option<&UnixStr>
pub fn file_stem(&self) -> Option<&UnixStr>
Extracts the stem (non-extension) portion of self.file_name.
The stem is:
None, if there is no file name;- The entire file name if there is no embedded
.; - The entire file name if the file name begins with
.and has no other.s within; - Otherwise, the portion of the file name before the final
.
§Examples
use unix_path::Path;
let path = Path::new("foo.rs");
assert_eq!("foo", path.file_stem().unwrap());Sourcepub fn extension(&self) -> Option<&UnixStr>
pub fn extension(&self) -> Option<&UnixStr>
Extracts the extension of self.file_name, if possible.
The extension is:
None, if there is no file name;None, if there is no embedded.;None, if the file name begins with.and has no other.s within;- Otherwise, the portion of the file name after the final
.
§Examples
use unix_path::Path;
use unix_str::UnixStr;
let path = Path::new("foo.rs");
assert_eq!(UnixStr::new("rs"), path.extension().unwrap());Sourcepub fn join<P: AsRef<Path>>(&self, path: P) -> PathBuf
pub fn join<P: AsRef<Path>>(&self, path: P) -> PathBuf
Creates an owned PathBuf with path adjoined to self.
See PathBuf::push for more details on what it means to adjoin a path.
§Examples
use unix_path::{Path, PathBuf};
assert_eq!(Path::new("/etc").join("passwd"), PathBuf::from("/etc/passwd"));Sourcepub fn with_file_name<S: AsRef<UnixStr>>(&self, file_name: S) -> PathBuf
pub fn with_file_name<S: AsRef<UnixStr>>(&self, file_name: S) -> PathBuf
Creates an owned PathBuf like self but with the given file name.
See PathBuf::set_file_name for more details.
§Examples
use unix_path::{Path, PathBuf};
let path = Path::new("/tmp/foo.txt");
assert_eq!(path.with_file_name("bar.txt"), PathBuf::from("/tmp/bar.txt"));
let path = Path::new("/tmp");
assert_eq!(path.with_file_name("var"), PathBuf::from("/var"));Sourcepub fn with_extension<S: AsRef<UnixStr>>(&self, extension: S) -> PathBuf
pub fn with_extension<S: AsRef<UnixStr>>(&self, extension: S) -> PathBuf
Creates an owned PathBuf like self but with the given extension.
See PathBuf::set_extension for more details.
§Examples
use unix_path::{Path, PathBuf};
let path = Path::new("foo.rs");
assert_eq!(path.with_extension("txt"), PathBuf::from("foo.txt"));Sourcepub fn components(&self) -> Components<'_> ⓘ
pub fn components(&self) -> Components<'_> ⓘ
Produces an iterator over the Components of the path.
When parsing the path, there is a small amount of normalization:
-
Repeated separators are ignored, so
a/banda//bboth haveaandbas components. -
Occurrences of
.are normalized away, except if they are at the beginning of the path. For example,a/./b,a/b/,a/b/.anda/ball haveaandbas components, but./a/bstarts with an additionalCurDircomponent. -
A trailing slash is normalized away,
/a/band/a/b/are equivalent.
Note that no other normalization takes place; in particular, a/c
and a/b/../c are distinct, to account for the possibility that b
is a symbolic link (so its parent isn’t a).
§Examples
use unix_path::{Path, Component};
use unix_str::UnixStr;
let mut components = Path::new("/tmp/foo.txt").components();
assert_eq!(components.next(), Some(Component::RootDir));
assert_eq!(components.next(), Some(Component::Normal(UnixStr::new("tmp"))));
assert_eq!(components.next(), Some(Component::Normal(UnixStr::new("foo.txt"))));
assert_eq!(components.next(), None)Sourcepub fn iter(&self) -> Iter<'_> ⓘ
pub fn iter(&self) -> Iter<'_> ⓘ
Produces an iterator over the path’s components viewed as UnixStr
slices.
For more information about the particulars of how the path is separated
into components, see components.
§Examples
use unix_path::{self, Path};
use unix_str::UnixStr;
let mut it = Path::new("/tmp/foo.txt").iter();
assert_eq!(it.next(), Some(UnixStr::new("/")));
assert_eq!(it.next(), Some(UnixStr::new("tmp")));
assert_eq!(it.next(), Some(UnixStr::new("foo.txt")));
assert_eq!(it.next(), None)Trait Implementations§
Source§impl<P: AsRef<Path>> Extend<P> for PathBuf
impl<P: AsRef<Path>> Extend<P> for PathBuf
Source§fn extend<I: IntoIterator<Item = P>>(&mut self, iter: I)
fn extend<I: IntoIterator<Item = P>>(&mut self, iter: I)
Source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one)Source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one)Source§impl From<PathBuf> for UnixString
impl From<PathBuf> for UnixString
Source§impl From<UnixString> for PathBuf
impl From<UnixString> for PathBuf
Source§fn from(s: UnixString) -> Self
fn from(s: UnixString) -> Self
Converts a UnixString into a PathBuf
This conversion does not allocate or copy memory.