Struct std::path::PathBuf
[−]
[src]
pub struct PathBuf { // some fields omitted }
An owned, mutable path (akin to String
`String`).
This type provides methods like push
`pushand
` and set_extension
that mutate the
path in place. It also implements Deref
`Derefto
` to Path
`Path, meaning that all methods on
Pathslices are available on
PathBuf` values as well.
More details about the overall approach can be found in the module documentation.
Examples
fn main() { use std::path::PathBuf; let mut path = PathBuf::from("c:\\"); path.push("windows"); path.push("system32"); path.set_extension("dll"); }use std::path::PathBuf; let mut path = PathBuf::from("c:\\"); path.push("windows"); path.push("system32"); path.set_extension("dll");
Methods
impl PathBuf
fn new() -> PathBuf
Allocates an empty PathBuf
`PathBuf`.
fn as_path(&self) -> &Path
Coerces to a Path
`Path` slice.
fn push<P: AsRef<Path>>(&mut self, path: P)
Extends self
`selfwith
` with path
`path`.
If path
`path` is absolute, it replaces the current path.
On Windows:
- if
path
`pathhas a root but no prefix (e.g.
\windows), it replaces everything except for the prefix (if any) of
self`. - if
path
`pathhas a prefix but no root, it replaces
self.
fn pop(&mut self) -> bool
Truncate self
`selfto
` to self.parent()
.
Returns false and does nothing if self.file_name()
is None
`None. Otherwise, returns
true`.
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
`None, this is equivalent to pushing
file_name`.
Examples
fn main() { 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")); }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"));
fn set_extension<S: AsRef<OsStr>>(&mut self, extension: S) -> bool
Updates self.extension()
to extension
.
If self.file_name()
is None
`None, does nothing and returns
false`.
Otherwise, returns true
`true; if
`; if self.extension()
is None
`None`, the extension
is added; otherwise it is replaced.
fn into_os_string(self) -> OsString
Consumes the PathBuf
`PathBuf, yielding its internal
OsString` storage.
Methods from Deref<Target=Path>
fn as_os_str(&self) -> &OsStr
Yields the underlying OsStr
`OsStr` slice.
Examples
fn main() { use std::path::Path; let os_str = Path::new("foo.txt").as_os_str(); assert_eq!(os_str, std::ffi::OsStr::new("foo.txt")); }use std::path::Path; let os_str = Path::new("foo.txt").as_os_str(); assert_eq!(os_str, std::ffi::OsStr::new("foo.txt"));
fn to_str(&self) -> Option<&str>
Yields a &str
`&strslice if the
Path` is valid unicode.
This conversion may entail doing a check for UTF-8 validity.
Examples
fn main() { use std::path::Path; let path_str = Path::new("foo.txt").to_str(); }use std::path::Path; let path_str = Path::new("foo.txt").to_str();
fn to_string_lossy(&self) -> Cow<str>
Converts a Path
`Pathto a
` to a Cow<str>
`Cow
Any non-Unicode sequences are replaced with U+FFFD REPLACEMENT CHARACTER.
Examples
fn main() { use std::path::Path; let path_str = Path::new("foo.txt").to_string_lossy(); assert_eq!(path_str, "foo.txt"); }use std::path::Path; let path_str = Path::new("foo.txt").to_string_lossy(); assert_eq!(path_str, "foo.txt");
fn to_path_buf(&self) -> PathBuf
Converts a Path
`Pathto an owned
PathBuf`.
Examples
fn main() { use std::path::Path; let path_buf = Path::new("foo.txt").to_path_buf(); assert_eq!(path_buf, std::path::PathBuf::from("foo.txt")); }use std::path::Path; let path_buf = Path::new("foo.txt").to_path_buf(); assert_eq!(path_buf, std::path::PathBuf::from("foo.txt"));
fn is_absolute(&self) -> bool
A path is absolute 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
`has_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
`c:tempand
` and\temp
`\tempare not. In other words,
path.is_absolute() == path.prefix().is_some() && path.has_root()`.
Examples
fn main() { use std::path::Path; assert!(!Path::new("foo.txt").is_absolute()); }use std::path::Path; assert!(!Path::new("foo.txt").is_absolute());
fn is_relative(&self) -> bool
A path is relative if it is not absolute.
Examples
fn main() { use std::path::Path; assert!(Path::new("foo.txt").is_relative()); }use std::path::Path; assert!(Path::new("foo.txt").is_relative());
fn prefix(&self) -> Option<Prefix>
: uncertain whether to expose this convenience
Returns the prefix of a path, if any.
Prefixes are relevant only for Windows paths, and consist of volumes
like C:
`C:, UNC prefixes like
\server, and others described in more detail in
std::os::windows::PathExt`.
fn has_root(&self) -> bool
A path has a root if the body of the path begins with the directory separator.
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
fn main() { use std::path::Path; assert!(Path::new("/etc/passwd").has_root()); }use std::path::Path; assert!(Path::new("/etc/passwd").has_root());
fn parent(&self) -> Option<&Path>
The path without its final component, if any.
Returns None
`None` if the path terminates in a root or prefix.
Examples
fn main() { 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); }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);
fn file_name(&self) -> Option<&OsStr>
The final component of the path, if it is a normal file.
If the path terminates in .
`.,
`, ..
`.., or consists solely of a root of prefix,
file_namewill return
None`.
Examples
fn main() { use std::path::Path; use std::ffi::OsStr; let path = Path::new("foo.txt"); let os_str = OsStr::new("foo.txt"); assert_eq!(Some(os_str), path.file_name()); }use std::path::Path; use std::ffi::OsStr; let path = Path::new("foo.txt"); let os_str = OsStr::new("foo.txt"); assert_eq!(Some(os_str), path.file_name());
fn relative_from<'a, P: ?Sized + AsRef<Path>>(&'a self, base: &'a P) -> Option<&Path>
: see #23284
Returns a path that, when joined onto base
`base, yields
`, yields self
`self`.
If base
`baseis not a prefix of
self(i.e.
` (i.e. starts_with
returns false), then relative_from
returns None
`None`.
fn starts_with<P: AsRef<Path>>(&self, base: P) -> bool
Determines whether base
`baseis a prefix of
self`.
Only considers whole path components to match.
Examples
fn main() { use std::path::Path; let path = Path::new("/etc/passwd"); assert!(path.starts_with("/etc")); assert!(!path.starts_with("/e")); }use std::path::Path; let path = Path::new("/etc/passwd"); assert!(path.starts_with("/etc")); assert!(!path.starts_with("/e"));
fn ends_with<P: AsRef<Path>>(&self, child: P) -> bool
Determines whether child
`childis a suffix of
self`.
Only considers whole path components to match.
Examples
fn main() { use std::path::Path; let path = Path::new("/etc/passwd"); assert!(path.ends_with("passwd")); }use std::path::Path; let path = Path::new("/etc/passwd"); assert!(path.ends_with("passwd"));
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
fn main() { use std::path::Path; let path = Path::new("foo.rs"); assert_eq!("foo", path.file_stem().unwrap()); }use std::path::Path; let path = Path::new("foo.rs"); assert_eq!("foo", path.file_stem().unwrap());
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
fn main() { use std::path::Path; let path = Path::new("foo.rs"); assert_eq!("rs", path.extension().unwrap()); }use std::path::Path; let path = Path::new("foo.rs"); assert_eq!("rs", path.extension().unwrap());
fn join<P: AsRef<Path>>(&self, path: P) -> PathBuf
Creates an owned PathBuf
`PathBufwith
` with path
`pathadjoined to
self`.
See PathBuf::push
for more details on what it means to adjoin a path.
Examples
fn main() { use std::path::{Path, PathBuf}; assert_eq!(Path::new("/etc").join("passwd"), PathBuf::from("/etc/passwd")); }use std::path::{Path, PathBuf}; assert_eq!(Path::new("/etc").join("passwd"), PathBuf::from("/etc/passwd"));
fn with_file_name<S: AsRef<OsStr>>(&self, file_name: S) -> PathBuf
Creates an owned PathBuf
`PathBuflike
` like self
`self` but with the given file name.
See PathBuf::set_file_name
for more details.
Examples
fn main() { 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")); }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"));
fn with_extension<S: AsRef<OsStr>>(&self, extension: S) -> PathBuf
Creates an owned PathBuf
`PathBuflike
` like self
`self` but with the given extension.
See PathBuf::set_extension
for more details.
Examples
fn main() { use std::path::{Path, PathBuf}; let path = Path::new("foo.rs"); assert_eq!(path.with_extension("txt"), PathBuf::from("foo.txt")); }use std::path::{Path, PathBuf}; let path = Path::new("foo.rs"); assert_eq!(path.with_extension("txt"), PathBuf::from("foo.txt"));
fn components(&self) -> Components
Produce an iterator over the components of the path.
Examples
fn main() { 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) }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)
fn iter(&self) -> Iter
Produce an iterator over the path's components viewed as OsStr
`OsStr` slices.
Examples
fn main() { 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) }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)
fn display(&self) -> Display
Returns an object that implements Display
`Display` for safely printing paths
that may contain non-Unicode data.
Examples
fn main() { use std::path::Path; let path = Path::new("/tmp/foo.rs"); println!("{}", path.display()); }use std::path::Path; let path = Path::new("/tmp/foo.rs"); println!("{}", path.display());