pub struct PathBuf<Form: PathForm = Any> { /* private fields */ }Expand description
A wrapper around std::path::PathBuf with extra invariants determined by its Form.
The possible path forms are Any, Relative, Absolute, or Canonical.
To learn more, view the documentation on PathForm or any of the individual forms.
There are also several type aliases available, corresponding to each PathForm:
RelativePathBuf(same asPathBuf<Relative>)AbsolutePathBuf(same asPathBuf<Absolute>)CanonicalPathBuf(same asPathBuf<Canonical>)
If the Form is not specified, then it defaults to Any,
so PathBuf and PathBuf<Any> are one in the same.
§Examples
To create a PathBuf with Any form, you can use the same techniques as when creating
a std::path::PathBuf.
use nu_path::PathBuf;
let path = PathBuf::from(r"C:\windows\system32.dll");
let mut path1 = PathBuf::new();
path1.push(r"C:\");
path1.push("windows");
path1.push("system32");
path1.set_extension("dll");
let path2: PathBuf = [r"C:\", "windows", "system32.dll"].iter().collect();
assert_eq!(path1, path2);§Converting to std::path types
PathBufs with form Any cannot be easily referenced as a std::path::Path
or converted to a std::path::PathBuf by design.
Other Nushell crates need to account for the emulated current working directory
before passing a path to functions in std or other third party crates.
You can join a Path onto an AbsolutePath or a CanonicalPath.
This will return an AbsolutePathBuf which can be easily referenced as a std::path::Path.
If you really mean it, you can instead use as_relative_std_path
or into_relative_std_path_buf
to get the underlying std::path::Path or std::path::PathBuf from a PathBuf.
But this may cause third-party code to use std::env::current_dir to resolve
the path which is almost always incorrect behavior. Extra care is needed to ensure that this
is not the case after using as_relative_std_path
or into_relative_std_path_buf.
Implementations§
Source§impl<Form: PathForm> PathBuf<Form>
impl<Form: PathForm> PathBuf<Form>
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 nu_path::{Path, PathBuf};
let mut p = PathBuf::from("/spirited/away.rs");
p.pop();
assert_eq!(Path::new("/spirited"), p);
p.pop();
assert_eq!(Path::new("/"), p);Sourcepub fn into_os_string(self) -> OsString
pub fn into_os_string(self) -> OsString
Sourcepub fn try_reserve(&mut self, additional: usize) -> Result<(), TryReserveError>
pub fn try_reserve(&mut self, additional: usize) -> Result<(), TryReserveError>
Invokes try_reserve on the underlying OsString.
Sourcepub fn reserve_exact(&mut self, additional: usize)
pub fn reserve_exact(&mut self, additional: usize)
Invokes reserve_exact on the underlying OsString.
Sourcepub fn try_reserve_exact(
&mut self,
additional: usize,
) -> Result<(), TryReserveError>
pub fn try_reserve_exact( &mut self, additional: usize, ) -> Result<(), TryReserveError>
Invokes try_reserve_exact on the underlying OsString.
Sourcepub fn shrink_to_fit(&mut self)
pub fn shrink_to_fit(&mut self)
Invokes shrink_to_fit on the underlying OsString.
Sourcepub fn cast_into<To>(self) -> PathBuf<To>
pub fn cast_into<To>(self) -> PathBuf<To>
Consumes a PathBuf, returning it with a different form.
PathForms can be converted to one another based on PathCast implementations.
Namely, the following form conversions are possible:
§Examples
use nu_path::{PathBuf, RelativePathBuf};
let p = RelativePathBuf::try_from("test.txt").unwrap();
let p: PathBuf = p.cast_into();
assert_eq!(PathBuf::from("test.txt"), p);Source§impl PathBuf
impl PathBuf
Sourcepub fn with_capacity(capacity: usize) -> Self
pub fn with_capacity(capacity: usize) -> Self
Creates a new PathBuf with a given capacity used to create the internal OsString.
See with_capacity defined on OsString.
§Examples
use nu_path::PathBuf;
let mut path = PathBuf::with_capacity(10);
let capacity = path.capacity();
// This push is done without reallocating
path.push(r"C:\");
assert_eq!(capacity, path.capacity());Sourcepub fn as_mut_os_string(&mut self) -> &mut OsString
pub fn as_mut_os_string(&mut self) -> &mut OsString
Returns a mutable reference to the underlying OsString.
§Examples
use nu_path::{Path, PathBuf};
let mut path = PathBuf::from("/foo");
path.push("bar");
assert_eq!(path, Path::new("/foo/bar"));
// OsString's `push` does not add a separator.
path.as_mut_os_string().push("baz");
assert_eq!(path, Path::new("/foo/barbaz"));Sourcepub fn try_into_relative(self) -> Result<RelativePathBuf, Self>
pub fn try_into_relative(self) -> Result<RelativePathBuf, Self>
Consumes a PathBuf, returning an Ok RelativePathBuf if the PathBuf
is relative. Otherwise, returns the original PathBuf as an Err.
§Examples
use nu_path::PathBuf;
assert!(PathBuf::from("test.txt").try_into_relative().is_ok());Sourcepub fn try_into_absolute(self) -> Result<AbsolutePathBuf, Self>
pub fn try_into_absolute(self) -> Result<AbsolutePathBuf, Self>
Consumes a PathBuf, returning an Ok AbsolutePathBuf if the PathBuf
is absolute. Otherwise, returns the original PathBuf as an Err.
§Examples
use nu_path::PathBuf;
assert!(PathBuf::from("test.txt").try_into_absolute().is_err());Source§impl<Form: PathPush> PathBuf<Form>
impl<Form: PathPush> PathBuf<Form>
Sourcepub fn push(&mut self, path: impl AsRef<Path>)
pub fn push(&mut self, path: impl AsRef<Path>)
Extends self with path.
If path is absolute, it replaces the current path.
On Windows:
- if
pathhas a root but no prefix (e.g.,\windows), it replaces everything except for the prefix (if any) ofself. - if
pathhas a prefix but no root, it replacesself. - if
selfhas a verbatim prefix (e.g.\\?\C:\windows) andpathis not empty, the new path is normalized: all references to.and..are removed.
Consider using Path::join if you need a new PathBuf instead of
using this function on a cloned PathBuf.
§Examples
Pushing a relative path extends the existing path:
use nu_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 nu_path::PathBuf;
let mut path = PathBuf::from("/tmp");
path.push("/etc");
assert_eq!(path, PathBuf::from("/etc"));Source§impl<Form: PathSet> PathBuf<Form>
impl<Form: PathSet> PathBuf<Form>
Sourcepub fn set_file_name(&mut self, file_name: impl AsRef<OsStr>)
pub fn set_file_name(&mut self, file_name: impl AsRef<OsStr>)
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 nu_path::PathBuf;
let mut buf = PathBuf::from("/");
assert!(buf.file_name() == None);
buf.set_file_name("foo.txt");
assert!(buf == PathBuf::from("/foo.txt"));
assert!(buf.file_name().is_some());
buf.set_file_name("bar.txt");
assert!(buf == PathBuf::from("/bar.txt"));
buf.set_file_name("baz");
assert!(buf == PathBuf::from("/baz"));Sourcepub fn set_extension(&mut self, extension: impl AsRef<OsStr>) -> bool
pub fn set_extension(&mut self, extension: impl AsRef<OsStr>) -> bool
Updates self.extension to Some(extension) or to None if
extension is empty.
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.
If extension is the empty string, self.extension will be None
afterwards, not Some("").
§Caveats
The new extension may contain dots and will be used in its entirety,
but only the part after the final dot will be reflected in
self.extension.
If the file stem contains internal dots and extension is empty, part of the
old file stem will be considered the new self.extension.
§Examples
use nu_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());
p.set_extension("cookie");
assert_eq!(Path::new("/feel/the.dark.cookie"), p.as_path());
p.set_extension("");
assert_eq!(Path::new("/feel/the.dark"), p.as_path());
p.set_extension("");
assert_eq!(Path::new("/feel/the"), p.as_path());
p.set_extension("");
assert_eq!(Path::new("/feel/the"), p.as_path());Source§impl<Form: MaybeRelative> PathBuf<Form>
impl<Form: MaybeRelative> PathBuf<Form>
Sourcepub fn into_relative_std_path_buf(self) -> PathBuf
pub fn into_relative_std_path_buf(self) -> PathBuf
Consumes a PathBuf and returns the, potentially relative,
underlying std::path::PathBuf.
§Note
Caution should be taken when using this function. Nushell keeps track of an emulated current
working directory, and using the std::path::PathBuf returned from this method
will likely use std::env::current_dir to resolve the path instead of
using the emulated current working directory.
Instead, you should probably join this path onto the emulated current working directory.
Any AbsolutePath or CanonicalPath will also suffice.
§Examples
use nu_path::PathBuf;
let p = PathBuf::from("test.txt");
assert_eq!(std::path::PathBuf::from("test.txt"), p.into_relative_std_path_buf());Source§impl<Form: IsAbsolute> PathBuf<Form>
impl<Form: IsAbsolute> PathBuf<Form>
Sourcepub fn into_std_path_buf(self) -> PathBuf
pub fn into_std_path_buf(self) -> PathBuf
Consumes a PathBuf and returns the underlying std::path::PathBuf.
§Examples
use nu_path::AbsolutePathBuf;
let p = AbsolutePathBuf::try_from("/test").unwrap();
assert_eq!(std::path::PathBuf::from("/test"), p.into_std_path_buf());Source§impl PathBuf<Canonical>
impl PathBuf<Canonical>
Sourcepub fn into_absolute(self) -> AbsolutePathBuf
pub fn into_absolute(self) -> AbsolutePathBuf
Consumes a CanonicalPathBuf and returns an AbsolutePathBuf.
§Examples
use nu_path::AbsolutePathBuf;
let absolute = AbsolutePathBuf::try_from("/test").unwrap();
let p = absolute.canonicalize().unwrap();
assert_eq!(absolute, p.into_absolute());Methods from Deref<Target = Path<Form>>§
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 nu_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<Form>
pub fn to_path_buf(&self) -> PathBuf<Form>
Sourcepub fn parent(&self) -> Option<&Self>
pub fn parent(&self) -> Option<&Self>
Returns the Path without its final component, if there is one.
This means it returns Some("") for relative paths with one component.
Returns None if the path terminates in a root or prefix, or if it’s
the empty string.
§Examples
use nu_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);
let relative_path = Path::new("foo/bar");
let parent = relative_path.parent();
assert_eq!(parent, Some(Path::new("foo")));
let grand_parent = parent.and_then(Path::parent);
assert_eq!(grand_parent, Some(Path::new("")));
let great_grand_parent = grand_parent.and_then(Path::parent);
assert_eq!(great_grand_parent, None);Sourcepub fn ancestors(&self) -> Ancestors<'_, Form> ⓘ
pub fn ancestors(&self) -> Ancestors<'_, Form> ⓘ
Produces an iterator over a 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 nu_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);
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(), Some(Path::new("")));
assert_eq!(ancestors.next(), None);Sourcepub fn file_name(&self) -> Option<&OsStr>
pub fn file_name(&self) -> Option<&OsStr>
Returns the final component of a 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 nu_path::Path;
use std::ffi::OsStr;
assert_eq!(Some(OsStr::new("bin")), Path::new("/usr/bin/").file_name());
assert_eq!(Some(OsStr::new("foo.txt")), Path::new("tmp/foo.txt").file_name());
assert_eq!(Some(OsStr::new("foo.txt")), Path::new("foo.txt/.").file_name());
assert_eq!(Some(OsStr::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(
&self,
base: impl AsRef<Path>,
) -> Result<&RelativePath, StripPrefixError>
pub fn strip_prefix( &self, base: impl AsRef<Path>, ) -> Result<&RelativePath, StripPrefixError>
Returns a relative path that, when joined onto base, yields self.
§Examples
use nu_path::{Path, PathBuf};
let path = Path::new("/test/haha/foo.txt");
assert_eq!(path.strip_prefix("/").unwrap(), Path::new("test/haha/foo.txt"));
assert_eq!(path.strip_prefix("/test").unwrap(), Path::new("haha/foo.txt"));
assert_eq!(path.strip_prefix("/test/").unwrap(), Path::new("haha/foo.txt"));
assert_eq!(path.strip_prefix("/test/haha/foo.txt").unwrap(), Path::new(""));
assert_eq!(path.strip_prefix("/test/haha/foo.txt/").unwrap(), Path::new(""));
assert!(path.strip_prefix("test").is_err());
assert!(path.strip_prefix("/haha").is_err());
let prefix = PathBuf::from("/test/");
assert_eq!(path.strip_prefix(prefix).unwrap(), Path::new("haha/foo.txt"));Sourcepub fn starts_with(&self, base: impl AsRef<Path>) -> bool
pub fn starts_with(&self, base: impl AsRef<Path>) -> bool
Determines whether base is a prefix of self.
Only considers whole path components to match.
§Examples
use nu_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/")); // extra slash is okay
assert!(path.starts_with("/etc/passwd///")); // multiple extra slashes are okay
assert!(!path.starts_with("/e"));
assert!(!path.starts_with("/etc/passwd.txt"));
assert!(!Path::new("/etc/foo.rs").starts_with("/etc/foo"));Sourcepub fn ends_with(&self, child: impl AsRef<Path>) -> bool
pub fn ends_with(&self, child: impl AsRef<Path>) -> bool
Determines whether child is a suffix of self.
Only considers whole path components to match.
§Examples
use nu_path::Path;
let path = Path::new("/etc/resolv.conf");
assert!(path.ends_with("resolv.conf"));
assert!(path.ends_with("etc/resolv.conf"));
assert!(path.ends_with("/etc/resolv.conf"));
assert!(!path.ends_with("/resolv.conf"));
assert!(!path.ends_with("conf")); // use .extension() insteadSourcepub fn file_stem(&self) -> Option<&OsStr>
pub fn file_stem(&self) -> Option<&OsStr>
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 nu_path::Path;
assert_eq!("foo", Path::new("foo.rs").file_stem().unwrap());
assert_eq!("foo.tar", Path::new("foo.tar.gz").file_stem().unwrap());Sourcepub fn extension(&self) -> Option<&OsStr>
pub fn extension(&self) -> Option<&OsStr>
Extracts the extension (without the leading dot) 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 nu_path::Path;
assert_eq!("rs", Path::new("foo.rs").extension().unwrap());
assert_eq!("gz", Path::new("foo.tar.gz").extension().unwrap());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 nu_path::Path;
use std::path::Component;
use std::ffi::OsStr;
let mut components = Path::new("/tmp/foo.txt").components();
assert_eq!(components.next(), Some(Component::RootDir));
assert_eq!(components.next(), Some(Component::Normal(OsStr::new("tmp"))));
assert_eq!(components.next(), Some(Component::Normal(OsStr::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 OsStr slices.
For more information about the particulars of how the path is separated into components,
see components.
§Examples
use nu_path::Path;
use std::ffi::OsStr;
let mut it = Path::new("/tmp/foo.txt").iter();
assert_eq!(it.next(), Some(OsStr::new(&std::path::MAIN_SEPARATOR.to_string())));
assert_eq!(it.next(), Some(OsStr::new("tmp")));
assert_eq!(it.next(), Some(OsStr::new("foo.txt")));
assert_eq!(it.next(), None)Sourcepub fn display(&self) -> Display<'_>
pub fn display(&self) -> Display<'_>
Returns an object that implements Display for safely printing paths
that may contain non-Unicode data. This may perform lossy conversion,
depending on the platform. If you would like an implementation which escapes the path
please use Debug instead.
§Examples
use nu_path::Path;
let path = Path::new("/tmp/foo.rs");
println!("{}", path.display());Sourcepub fn cast<To>(&self) -> &Path<To>
pub fn cast<To>(&self) -> &Path<To>
Returns a reference to the same Path in a different form.
PathForms can be converted to one another based on PathCast implementations.
Namely, the following form conversions are possible:
§Examples
use nu_path::{Path, RelativePath};
let relative = RelativePath::try_new("test.txt").unwrap();
let p: &Path = relative.cast();
assert_eq!(p, relative);Sourcepub fn as_mut_os_str(&mut self) -> &mut OsStr
pub fn as_mut_os_str(&mut self) -> &mut OsStr
Sourcepub fn is_absolute(&self) -> bool
pub fn is_absolute(&self) -> bool
Returns true if the Path is absolute, i.e., if it is independent of
the current directory.
-
On Unix, a path is absolute if it starts with the root, so
is_absoluteandhas_rootare equivalent. -
On Windows, a path is absolute if it has a prefix and starts with the root:
c:\windowsis absolute, whilec:tempand\tempare not.
§Examples
use nu_path::Path;
assert!(!Path::new("foo.txt").is_absolute());Sourcepub fn is_relative(&self) -> bool
pub fn is_relative(&self) -> bool
See is_absolute’s documentation for more details.
§Examples
use nu_path::Path;
assert!(Path::new("foo.txt").is_relative());Sourcepub fn try_absolute(&self) -> Result<&AbsolutePath, &RelativePath>
pub fn try_absolute(&self) -> Result<&AbsolutePath, &RelativePath>
Returns an Ok AbsolutePath if the Path is absolute.
Otherwise, returns an Err RelativePath.
§Examples
use nu_path::Path;
assert!(Path::new("test.txt").try_absolute().is_err());Sourcepub fn try_relative(&self) -> Result<&RelativePath, &AbsolutePath>
pub fn try_relative(&self) -> Result<&RelativePath, &AbsolutePath>
Returns an Ok RelativePath if the Path is relative.
Otherwise, returns an Err AbsolutePath.
§Examples
use nu_path::Path;
assert!(Path::new("test.txt").try_relative().is_ok());Sourcepub fn join(&self, path: impl AsRef<Path>) -> PathBuf<Form::Output>
pub fn join(&self, path: impl AsRef<Path>) -> PathBuf<Form::Output>
Creates an owned PathBuf with path adjoined to self.
If path is absolute, it replaces the current path.
See PathBuf::push for more details on what it means to adjoin a path.
§Examples
use nu_path::{Path, PathBuf};
assert_eq!(Path::new("/etc").join("passwd"), PathBuf::from("/etc/passwd"));
assert_eq!(Path::new("/etc").join("/bin/sh"), PathBuf::from("/bin/sh"));Sourcepub fn with_file_name(&self, file_name: impl AsRef<OsStr>) -> PathBuf<Form>
pub fn with_file_name(&self, file_name: impl AsRef<OsStr>) -> PathBuf<Form>
Creates an owned PathBuf like self but with the given file name.
See PathBuf::set_file_name for more details.
§Examples
use nu_path::{Path, PathBuf};
let path = Path::new("/tmp/foo.png");
assert_eq!(path.with_file_name("bar"), PathBuf::from("/tmp/bar"));
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(&self, extension: impl AsRef<OsStr>) -> PathBuf<Form>
pub fn with_extension(&self, extension: impl AsRef<OsStr>) -> PathBuf<Form>
Creates an owned PathBuf like self but with the given extension.
See PathBuf::set_extension for more details.
§Examples
use nu_path::{Path, PathBuf};
let path = Path::new("foo.rs");
assert_eq!(path.with_extension("txt"), PathBuf::from("foo.txt"));
let path = Path::new("foo.tar.gz");
assert_eq!(path.with_extension(""), PathBuf::from("foo.tar"));
assert_eq!(path.with_extension("xz"), PathBuf::from("foo.tar.xz"));
assert_eq!(path.with_extension("").with_extension("txt"), PathBuf::from("foo.txt"));Sourcepub fn as_relative_std_path(&self) -> &Path
pub fn as_relative_std_path(&self) -> &Path
Returns the, potentially relative, underlying std::path::Path.
§Note
Caution should be taken when using this function. Nushell keeps track of an emulated current
working directory, and using the std::path::Path returned from this method will likely
use std::env::current_dir to resolve the path instead of using the emulated current
working directory.
Instead, you should probably join this path onto the emulated current working directory.
Any AbsolutePath or CanonicalPath will also suffice.
§Examples
use nu_path::Path;
let p = Path::new("test.txt");
assert_eq!(std::path::Path::new("test.txt"), p.as_relative_std_path());Sourcepub fn has_root(&self) -> bool
pub fn has_root(&self) -> bool
-
On Unix, a path has a root if it begins with
/. -
On Windows, a path has a root if it:
- has no prefix and begins with a separator, e.g.,
\windows - has a prefix followed by a separator, e.g.,
c:\windowsbut notc:windows - has any non-disk prefix, e.g.,
\\server\share
- has no prefix and begins with a separator, e.g.,
§Examples
use nu_path::Path;
assert!(Path::new("/etc/passwd").has_root());Sourcepub fn as_std_path(&self) -> &Path
pub fn as_std_path(&self) -> &Path
Returns the underlying std::path::Path.
§Examples
use nu_path::AbsolutePath;
let p = AbsolutePath::try_new("/test").unwrap();
assert_eq!(std::path::Path::new("/test"), p.as_std_path());Sourcepub fn to_std_path_buf(&self) -> PathBuf
pub fn to_std_path_buf(&self) -> PathBuf
Converts a Path to an owned std::path::PathBuf.
§Examples
use nu_path::AbsolutePath;
let path = AbsolutePath::try_new("/foo").unwrap();
assert_eq!(path.to_std_path_buf(), std::path::PathBuf::from("/foo"));Sourcepub fn metadata(&self) -> Result<Metadata>
pub fn metadata(&self) -> Result<Metadata>
Queries the file system to get information about a file, directory, etc.
This function will traverse symbolic links to query information about the destination file.
This is an alias to std::fs::metadata.
§Examples
use nu_path::AbsolutePath;
let path = AbsolutePath::try_new("/Minas/tirith").unwrap();
let metadata = path.metadata().expect("metadata call failed");
println!("{:?}", metadata.file_type());Sourcepub fn read_dir(&self) -> Result<ReadDir>
pub fn read_dir(&self) -> Result<ReadDir>
Returns an iterator over the entries within a directory.
The iterator will yield instances of io::Result<fs::DirEntry>.
New errors may be encountered after an iterator is initially constructed.
This is an alias to std::fs::read_dir.
§Examples
use nu_path::AbsolutePath;
let path = AbsolutePath::try_new("/laputa").unwrap();
for entry in path.read_dir().expect("read_dir call failed") {
if let Ok(entry) = entry {
println!("{:?}", entry.path());
}
}Sourcepub fn exists(&self) -> bool
pub fn exists(&self) -> bool
Returns true if the path points at an existing entity.
Warning: this method may be error-prone, consider using try_exists
instead! It also has a risk of introducing time-of-check to time-of-use (TOCTOU) bugs.
This function will traverse symbolic links to query information about the destination file.
If you cannot access the metadata of the file, e.g. because of a permission error
or broken symbolic links, this will return false.
§Examples
use nu_path::AbsolutePath;
let path = AbsolutePath::try_new("/does_not_exist").unwrap();
assert!(!path.exists());Sourcepub fn is_file(&self) -> bool
pub fn is_file(&self) -> bool
Returns true if the path exists on disk and is pointing at a regular file.
This function will traverse symbolic links to query information about the destination file.
If you cannot access the metadata of the file, e.g. because of a permission error
or broken symbolic links, this will return false.
§Examples
use nu_path::AbsolutePath;
let path = AbsolutePath::try_new("/is_a_directory/").unwrap();
assert_eq!(path.is_file(), false);
let path = AbsolutePath::try_new("/a_file.txt").unwrap();
assert_eq!(path.is_file(), true);§See Also
When the goal is simply to read from (or write to) the source, the most reliable way
to test the source can be read (or written to) is to open it. Only using is_file can
break workflows like diff <( prog_a ) on a Unix-like system for example.
See std::fs::File::open or std::fs::OpenOptions::open for more information.
Sourcepub fn is_dir(&self) -> bool
pub fn is_dir(&self) -> bool
Returns true if the path exists on disk and is pointing at a directory.
This function will traverse symbolic links to query information about the destination file.
If you cannot access the metadata of the file, e.g. because of a permission error
or broken symbolic links, this will return false.
§Examples
use nu_path::AbsolutePath;
let path = AbsolutePath::try_new("/is_a_directory/").unwrap();
assert_eq!(path.is_dir(), true);
let path = AbsolutePath::try_new("/a_file.txt").unwrap();
assert_eq!(path.is_dir(), false);Trait Implementations§
Source§impl<P: AsRef<Path>> Extend<P> for PathBuf
impl<P: AsRef<Path>> Extend<P> for PathBuf
Source§fn extend<T: IntoIterator<Item = P>>(&mut self, iter: T)
fn extend<T: IntoIterator<Item = P>>(&mut self, iter: T)
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)