Struct std::path::PathBuf
pub struct PathBuf { /* fields omitted */ }
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 module documentation.
Examples
You can use push
to build up a PathBuf
from components:
use std::path::PathBuf; let mut path = PathBuf::new(); path.push(r"C:\"); path.push("windows"); path.push("system32"); path.set_extension("dll");
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 std::path::PathBuf; let path: PathBuf = [r"C:\", "windows", "system32.dll"].iter().collect();
We can still do better than this! Since these are all strings, we can use From::from
:
use std::path::PathBuf; let path = PathBuf::from(r"C:\windows\system32.dll");
Which method works best depends on what kind of situation you’re in.
Implementations
impl PathBuf
pub fn new() -> PathBuf
Allocates an empty PathBuf
.
Examples
use std::path::PathBuf; let path = PathBuf::new();
pub fn with_capacity(capacity: usize) -> PathBuf
Creates a new PathBuf
with a given capacity used to create the internal OsString
. See with_capacity
defined on OsString
.
Examples
use std::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());
pub fn as_path(&self) -> &Path
Coerces to a Path
slice.
Examples
use std::path::{Path, PathBuf}; let p = PathBuf::from("/test"); assert_eq!(Path::new("/test"), p.as_path());
pub fn push<P: AsRef<Path>>(&mut self, path: P)
Extends self
with path
.
If path
is absolute, it replaces the current path.
On Windows:
- if
path
has a root but no prefix (e.g.,\windows
), it replaces everything except for the prefix (if any) ofself
. - if
path
has a prefix but no root, it replacesself
.
Examples
Pushing a relative path extends the existing path:
use std::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 std::path::PathBuf; let mut path = PathBuf::from("/tmp"); path.push("/etc"); assert_eq!(path, PathBuf::from("/etc"));
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 std::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);
pub fn set_file_name<S: AsRef<OsStr>>(&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 std::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"));
pub fn set_extension<S: AsRef<OsStr>>(&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 std::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());
pub fn into_os_string(self) -> OsString
Consumes the PathBuf
, yielding its internal OsString
storage.
Examples
use std::path::PathBuf; let p = PathBuf::from("/the/head"); let os_str = p.into_os_string();
pub fn into_boxed_path(self) -> Box<Path>
impl<I, A> Iterator for Box<I, A> where I: Iterator + ?Sized, A: Allocator, type Item = <I as Iterator>::Item; impl<F, A> Future for Box<F, A> where F: Future + Unpin + ?Sized, A: Allocator + 'static, type Output = <F as Future>::Output; impl<R: Read + ?Sized> Read for Box<R> impl<W: Write + ?Sized> Write for Box<W>
pub fn capacity(&self) -> usize
pub fn clear(&mut self)
pub fn reserve(&mut self, additional: usize)
pub fn reserve_exact(&mut self, additional: usize)
Invokes reserve_exact
on the underlying instance of OsString
.
pub fn shrink_to_fit(&mut self)
Invokes shrink_to_fit
on the underlying instance of OsString
.
pub fn shrink_to(&mut self, min_capacity: usize)
Methods from Deref<Target = Path>
pub fn as_os_str(&self) -> &OsStr
Yields the underlying OsStr
slice.
Examples
use std::path::Path; let os_str = Path::new("foo.txt").as_os_str(); assert_eq!(os_str, std::ffi::OsStr::new("foo.txt"));
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 std::path::Path; let path = Path::new("foo.txt"); assert_eq!(path.to_str(), Some("foo.txt"));
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 std::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"
.
pub fn to_path_buf(&self) -> PathBuf
Converts a Path
to an owned PathBuf
.
Examples
use std::path::Path; let path_buf = Path::new("foo.txt").to_path_buf(); assert_eq!(path_buf, std::path::PathBuf::from("foo.txt"));
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_absolute
andhas_root
are equivalent. -
On Windows, a path is absolute if it has a prefix and starts with the root:
c:\windows
is absolute, whilec:temp
and\temp
are not.
Examples
use std::path::Path; assert!(!Path::new("foo.txt").is_absolute());
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 std::path::Path; assert!(Path::new("foo.txt").is_relative());
pub fn has_root(&self) -> bool
Returns true
if the Path
has a root.
-
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:\windows
but notc:windows
- has any non-disk prefix, e.g.,
\\server\share
- has no prefix and begins with a separator, e.g.,
Examples
use std::path::Path; assert!(Path::new("/etc/passwd").has_root());
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 std::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);
pub fn ancestors(&self) -> Ancestors<'_>
impl<'a> Iterator for Ancestors<'a> type Item = &'a Path;
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 std::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);
pub fn file_name(&self) -> Option<&OsStr>
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 std::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());
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 std::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!(path.strip_prefix("test").is_err()); assert!(path.strip_prefix("/haha").is_err()); let prefix = PathBuf::from("/test/"); assert_eq!(path.strip_prefix(prefix), Ok(Path::new("haha/foo.txt")));
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 std::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"));
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 std::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() instead
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 std::path::Path; assert_eq!("foo", Path::new("foo.rs").file_stem().unwrap()); assert_eq!("foo.tar", Path::new("foo.tar.gz").file_stem().unwrap());
See Also
This method is similar to Path::file_prefix
, which extracts the portion of the file name before the first .
pub fn file_prefix(&self) -> Option<&OsStr>
Extracts the prefix of self.file_name
.
The prefix is:
-
None
, if there is no file name; - The entire file name if there is no embedded
.
; - The portion of the file name before the first non-beginning
.
; - The entire file name if the file name begins with
.
and has no other.
s within; - The portion of the file name before the second
.
if the file name begins with.
Examples
use std::path::Path; assert_eq!("foo", Path::new("foo.rs").file_prefix().unwrap()); assert_eq!("foo", Path::new("foo.tar.gz").file_prefix().unwrap());
See Also
This method is similar to Path::file_stem
, which extracts the portion of the file name before the last .
pub fn extension(&self) -> Option<&OsStr>
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 std::path::Path; assert_eq!("rs", Path::new("foo.rs").extension().unwrap()); assert_eq!("gz", Path::new("foo.tar.gz").extension().unwrap());
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 std::path::{Path, PathBuf}; assert_eq!(Path::new("/etc").join("passwd"), PathBuf::from("/etc/passwd"));
pub fn with_file_name<S: AsRef<OsStr>>(&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 std::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"));
pub fn with_extension<S: AsRef<OsStr>>(&self, extension: S) -> PathBuf
Creates an owned PathBuf
like self
but with the given extension.
See PathBuf::set_extension
for more details.
Examples
use std::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"));
pub fn components(&self) -> Components<'_>
impl<'a> Iterator for Components<'a> type Item = Component<'a>;
Produces an iterator over the Component
s of the path.
When parsing the path, there is a small amount of normalization:
-
Repeated separators are ignored, so
a/b
anda//b
both havea
andb
as 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/b
all havea
andb
as components, but./a/b
starts with an additionalCurDir
component. -
A trailing slash is normalized away,
/a/b
and/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 std::path::{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)
pub fn iter(&self) -> Iter<'_>
impl<'a> Iterator for Iter<'a> type Item = &'a OsStr;
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 std::path::{self, Path}; use std::ffi::OsStr; let mut it = Path::new("/tmp/foo.txt").iter(); assert_eq!(it.next(), Some(OsStr::new(&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)
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 std::path::Path; let path = Path::new("/tmp/foo.rs"); println!("{}", path.display());
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 fs::metadata
.
Examples
use std::path::Path; let path = Path::new("/Minas/tirith"); let metadata = path.metadata().expect("metadata call failed"); println!("{:?}", metadata.file_type());
pub fn symlink_metadata(&self) -> Result<Metadata>
Queries the metadata about a file without following symlinks.
This is an alias to fs::symlink_metadata
.
Examples
use std::path::Path; let path = Path::new("/Minas/tirith"); let metadata = path.symlink_metadata().expect("symlink_metadata call failed"); println!("{:?}", metadata.file_type());
pub fn canonicalize(&self) -> Result<PathBuf>
Returns the canonical, absolute form of the path with all intermediate components normalized and symbolic links resolved.
This is an alias to fs::canonicalize
.
Examples
use std::path::{Path, PathBuf}; let path = Path::new("/foo/test/../test/bar.rs"); assert_eq!(path.canonicalize().unwrap(), PathBuf::from("/foo/test/bar.rs"));
pub fn read_link(&self) -> Result<PathBuf>
Reads a symbolic link, returning the file that the link points to.
This is an alias to fs::read_link
.
Examples
use std::path::Path; let path = Path::new("/laputa/sky_castle.rs"); let path_link = path.read_link().expect("read_link call failed");
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 fs::read_dir
.
Examples
use std::path::Path; let path = Path::new("/laputa"); for entry in path.read_dir().expect("read_dir call failed") { if let Ok(entry) = entry { println!("{:?}", entry.path()); } }
pub fn exists(&self) -> bool
Returns true
if the path points at an existing entity.
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 std::path::Path; assert!(!Path::new("does_not_exist.txt").exists());
See Also
This is a convenience function that coerces errors to false. If you want to check errors, call fs::metadata
.
pub fn try_exists(&self) -> Result<bool>
Returns Ok(true)
if the path points at an existing entity.
This function will traverse symbolic links to query information about the destination file. In case of broken symbolic links this will return Ok(false)
.
As opposed to the exists()
method, this one doesn’t silently ignore errors unrelated to the path not existing. (E.g. it will return Err(_)
in case of permission denied on some of the parent directories.)
Examples
#![feature(path_try_exists)] use std::path::Path; assert!(!Path::new("does_not_exist.txt").try_exists().expect("Can't check existence of file does_not_exist.txt")); assert!(Path::new("/root/secret_file.txt").try_exists().is_err());
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 std::path::Path; assert_eq!(Path::new("./is_a_directory/").is_file(), false); assert_eq!(Path::new("a_file.txt").is_file(), true);
See Also
This is a convenience function that coerces errors to false. If you want to check errors, call fs::metadata
and handle its Result
. Then call fs::Metadata::is_file
if it was Ok
.
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 fs::File::open
or fs::OpenOptions::open
for more information.
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 std::path::Path; assert_eq!(Path::new("./is_a_directory/").is_dir(), true); assert_eq!(Path::new("a_file.txt").is_dir(), false);
See Also
This is a convenience function that coerces errors to false. If you want to check errors, call fs::metadata
and handle its Result
. Then call fs::Metadata::is_dir
if it was Ok
.
pub fn is_symlink(&self) -> bool
Returns true if the path exists on disk and is pointing at a symbolic link.
This function will not traverse symbolic links. In case of a broken symbolic link this will also return true.
If you cannot access the directory containing the file, e.g., because of a permission error, this will return false.
Examples
#![feature(is_symlink)] use std::path::Path; use std::os::unix::fs::symlink; let link_path = Path::new("link"); symlink("/origin_does_not_exists/", link_path).unwrap(); assert_eq!(link_path.is_symlink(), true); assert_eq!(link_path.exists(), false);
Trait Implementations
impl AsRef<OsStr> for PathBuf
fn as_ref(&self) -> &OsStr
Performs the conversion.
impl AsRef<Path> for PathBuf
fn as_ref(&self) -> &Path
Performs the conversion.
impl Borrow<Path> for PathBuf
impl Clone for PathBuf
fn clone(&self) -> Self
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl Debug for PathBuf
fn fmt(&self, formatter: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
impl Default for PathBuf
impl Deref for PathBuf
type Target = Path
The resulting type after dereferencing.
fn deref(&self) -> &Path
Dereferences the value.
impl<P: AsRef<Path>> Extend<P> for PathBuf
fn extend<I: IntoIterator<Item = P>>(&mut self, iter: I)
Extends a collection with the contents of an iterator. Read more
fn extend_one(&mut self, p: P)
Extends a collection with exactly one element.
fn extend_reserve(&mut self, additional: usize)
Reserves capacity in a collection for the given number of additional elements. Read more
impl<T: ?Sized + AsRef<OsStr>> From<&'_ T> for PathBuf
fn from(s: &T) -> PathBuf
Converts a borrowed OsStr
to a PathBuf
.
Allocates a PathBuf
and copies the data into it.
impl<'a> From<&'a PathBuf> for Cow<'a, Path>
fn from(p: &'a PathBuf) -> Cow<'a, Path>
Creates a clone-on-write pointer from a reference to PathBuf
.
This conversion does not clone or allocate.
impl From<Box<Path, Global>> for PathBuf
fn from(boxed: Box<Path>) -> PathBuf
Converts a Box<Path>
into a PathBuf
This conversion does not allocate or copy memory.
impl<'a> From<Cow<'a, Path>> for PathBuf
fn from(p: Cow<'a, Path>) -> Self
Converts a clone-on-write pointer to an owned path.
Converting from a Cow::Owned
does not clone or allocate.
impl From<OsString> for PathBuf
fn from(s: OsString) -> PathBuf
impl From<PathBuf> for Box<Path>
fn from(p: PathBuf) -> Box<Path>
impl<I, A> Iterator for Box<I, A> where I: Iterator + ?Sized, A: Allocator, type Item = <I as Iterator>::Item; impl<F, A> Future for Box<F, A> where F: Future + Unpin + ?Sized, A: Allocator + 'static, type Output = <F as Future>::Output; impl<R: Read + ?Sized> Read for Box<R> impl<W: Write + ?Sized> Write for Box<W>
Converts a PathBuf
into a Box<Path>
This conversion currently should not allocate memory, but this behavior is not guaranteed on all platforms or in all future versions.
impl From<PathBuf> for OsString
fn from(path_buf: PathBuf) -> OsString
impl<'a> From<PathBuf> for Cow<'a, Path>
fn from(s: PathBuf) -> Cow<'a, Path>
Creates a clone-on-write pointer from an owned instance of PathBuf
.
This conversion does not clone or allocate.
impl From<PathBuf> for Arc<Path>
fn from(s: PathBuf) -> Arc<Path>
impl From<PathBuf> for Rc<Path>
fn from(s: PathBuf) -> Rc<Path>
impl From<String> for PathBuf
fn from(s: String) -> PathBuf
impl<P: AsRef<Path>> FromIterator<P> for PathBuf
fn from_iter<I: IntoIterator<Item = P>>(iter: I) -> PathBuf
Creates a value from an iterator. Read more
impl FromStr for PathBuf
type Err = Infallible
The associated error which can be returned from parsing.
fn from_str(s: &str) -> Result<Self, Self::Err>
Parses a string s
to return a value of this type. Read more
impl Hash for PathBuf
fn hash<H: Hasher>(&self, h: &mut H)
impl<'a> IntoIterator for &'a PathBuf
type Item = &'a OsStr
The type of the elements being iterated over.
type IntoIter = Iter<'a>
Which kind of iterator are we turning this into?
fn into_iter(self) -> Iter<'a>
impl<'a> Iterator for Iter<'a> type Item = &'a OsStr;
Creates an iterator from a value. Read more
impl Ord for PathBuf
fn cmp(&self, other: &PathBuf) -> Ordering
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
fn clamp(self, min: Self, max: Self) -> Self
Restrict a value to a certain interval. Read more
impl<'a, 'b> PartialEq<&'a OsStr> for PathBuf
fn eq(&self, other: &&'a OsStr) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl<'a, 'b> PartialEq<&'a Path> for PathBuf
fn eq(&self, other: &&'a Path) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl<'a, 'b> PartialEq<Cow<'a, OsStr>> for PathBuf
fn eq(&self, other: &Cow<'a, OsStr>) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl<'a, 'b> PartialEq<Cow<'a, Path>> for PathBuf
fn eq(&self, other: &Cow<'a, Path>) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl<'a, 'b> PartialEq<OsStr> for PathBuf
fn eq(&self, other: &OsStr) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl<'a, 'b> PartialEq<OsString> for PathBuf
fn eq(&self, other: &OsString) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl<'a, 'b> PartialEq<Path> for PathBuf
fn eq(&self, other: &Path) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl PartialEq<PathBuf> for PathBuf
fn eq(&self, other: &PathBuf) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl<'a, 'b> PartialEq<PathBuf> for Path
fn eq(&self, other: &PathBuf) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl<'a, 'b> PartialEq<PathBuf> for &'a Path
fn eq(&self, other: &PathBuf) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl<'a, 'b> PartialEq<PathBuf> for Cow<'a, Path>
fn eq(&self, other: &PathBuf) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl<'a, 'b> PartialEq<PathBuf> for OsStr
fn eq(&self, other: &PathBuf) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl<'a, 'b> PartialEq<PathBuf> for &'a OsStr
fn eq(&self, other: &PathBuf) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl<'a, 'b> PartialEq<PathBuf> for Cow<'a, OsStr>
fn eq(&self, other: &PathBuf) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl<'a, 'b> PartialEq<PathBuf> for OsString
fn eq(&self, other: &PathBuf) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl<'a, 'b> PartialOrd<&'a OsStr> for PathBuf
fn partial_cmp(&self, other: &&'a OsStr) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, other: &Rhs) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, other: &Rhs) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl<'a, 'b> PartialOrd<&'a Path> for PathBuf
fn partial_cmp(&self, other: &&'a Path) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, other: &Rhs) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, other: &Rhs) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl<'a, 'b> PartialOrd<Cow<'a, OsStr>> for PathBuf
fn partial_cmp(&self, other: &Cow<'a, OsStr>) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, other: &Rhs) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, other: &Rhs) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl<'a, 'b> PartialOrd<Cow<'a, Path>> for PathBuf
fn partial_cmp(&self, other: &Cow<'a, Path>) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, other: &Rhs) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, other: &Rhs) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl<'a, 'b> PartialOrd<OsStr> for PathBuf
fn partial_cmp(&self, other: &OsStr) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, other: &Rhs) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, other: &Rhs) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl<'a, 'b> PartialOrd<OsString> for PathBuf
fn partial_cmp(&self, other: &OsString) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, other: &Rhs) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, other: &Rhs) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl<'a, 'b> PartialOrd<Path> for PathBuf
fn partial_cmp(&self, other: &Path) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, other: &Rhs) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, other: &Rhs) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl PartialOrd<PathBuf> for PathBuf
fn partial_cmp(&self, other: &PathBuf) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, other: &Rhs) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, other: &Rhs) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl<'a, 'b> PartialOrd<PathBuf> for Path
fn partial_cmp(&self, other: &PathBuf) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, other: &Rhs) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, other: &Rhs) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl<'a, 'b> PartialOrd<PathBuf> for &'a Path
fn partial_cmp(&self, other: &PathBuf) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, other: &Rhs) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, other: &Rhs) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl<'a, 'b> PartialOrd<PathBuf> for Cow<'a, Path>
fn partial_cmp(&self, other: &PathBuf) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, other: &Rhs) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, other: &Rhs) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl<'a, 'b> PartialOrd<PathBuf> for OsStr
fn partial_cmp(&self, other: &PathBuf) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, other: &Rhs) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, other: &Rhs) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl<'a, 'b> PartialOrd<PathBuf> for &'a OsStr
fn partial_cmp(&self, other: &PathBuf) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, other: &Rhs) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, other: &Rhs) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl<'a, 'b> PartialOrd<PathBuf> for Cow<'a, OsStr>
fn partial_cmp(&self, other: &PathBuf) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, other: &Rhs) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, other: &Rhs) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl<'a, 'b> PartialOrd<PathBuf> for OsString
fn partial_cmp(&self, other: &PathBuf) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, other: &Rhs) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, other: &Rhs) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl Eq for PathBuf
Auto Trait Implementations
impl RefUnwindSafe for PathBuf
impl Send for PathBuf
impl Sync for PathBuf
impl Unpin for PathBuf
impl UnwindSafe for PathBuf
Blanket Implementations
impl<T> From<T> for T
pub fn from(t: T) -> T
Performs the conversion.
pub fn into(self) -> U
Performs the conversion.
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
#41263)recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
Performs the conversion.
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
Performs the conversion.
© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/path/struct.PathBuf.html