W3cubDocs

/Rust

Struct std::path::Path

pub struct Path { /* fields omitted */ }

A slice of a path (akin to str).

This type supports a number of operations for inspecting a path, including breaking the path into its components (separated by / on Unix and by either / or \ on Windows), extracting the file name, determining whether the path is absolute, and so on.

This is an unsized type, meaning that it must always be used behind a pointer like & or Box. For an owned version of this type, see PathBuf.

More details about the overall approach can be found in the module documentation.

Examples

use std::path::Path;
use std::ffi::OsStr;

// Note: this example does work on Windows
let path = Path::new("./foo/bar.txt");

let parent = path.parent();
assert_eq!(parent, Some(Path::new("./foo")));

let file_stem = path.file_stem();
assert_eq!(file_stem, Some(OsStr::new("bar")));

let extension = path.extension();
assert_eq!(extension, Some(OsStr::new("txt")));

Implementations

impl Path[src]

pub fn new<S: AsRef<OsStr> + ?Sized>(s: &S) -> &Path[src]

Directly wraps a string slice as a Path slice.

This is a cost-free conversion.

Examples

use std::path::Path;

Path::new("foo.txt");

You can create Paths from Strings, or even other Paths:

use std::path::Path;

let string = String::from("foo.txt");
let from_string = Path::new(&string);
let from_path = Path::new(&from_string);
assert_eq!(from_string, from_path);

pub fn as_os_str(&self) -> &OsStr[src]

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>[src]

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>[src]

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[src]

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[src]

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 and has_root are equivalent.

  • On Windows, a path is absolute if it has a prefix and starts with the root: c:\windows is absolute, while c:temp and \temp are not.

Examples

use std::path::Path;

assert!(!Path::new("foo.txt").is_absolute());

pub fn is_relative(&self) -> bool[src]

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[src]

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 not c:windows
    • has any non-disk prefix, e.g., \\server\share

Examples

use std::path::Path;

assert!(Path::new("/etc/passwd").has_root());

pub fn parent(&self) -> Option<&Path>[src]

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<'_>ⓘ

Notable traits for Ancestors<'a>

impl<'a> Iterator for Ancestors<'a>
    type Item = &'a Path;
[src]1.28.0

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>[src]

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());

pub fn strip_prefix<P>(&self, base: P) -> Result<&Path, StripPrefixError> where
    P: AsRef<Path>, [src]1.7.0

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[src]

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[src]

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>[src]

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());

pub fn extension(&self) -> Option<&OsStr>[src]

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[src]

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[src]

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[src]

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<'_>ⓘ

Notable traits for Components<'a>

impl<'a> Iterator for Components<'a>
    type Item = Component<'a>;
[src]

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/b and a//b both have a and b 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/. and a/b all have a and b as components, but ./a/b starts with an additional CurDir 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<'_>ⓘ

Notable traits for Iter<'a>

impl<'a> Iterator for Iter<'a>
    type Item = &'a OsStr;
[src]

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<'_>[src]

Returns an object that implements Display for safely printing paths that may contain non-Unicode data.

Examples

use std::path::Path;

let path = Path::new("/tmp/foo.rs");

println!("{}", path.display());

pub fn metadata(&self) -> Result<Metadata>[src]1.5.0

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());

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>[src]1.5.0

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"));

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>[src]1.5.0

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[src]1.5.0

Returns 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 false.

If you cannot access the directory containing the file, e.g., because of a permission error, 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 is_file(&self) -> bool[src]1.5.0

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. In case of broken symbolic links this will return false.

If you cannot access the directory containing the file, e.g., because of a permission error, 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[src]1.5.0

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. In case of broken symbolic links this will return false.

If you cannot access the directory containing the file, e.g., because of a permission error, 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 into_path_buf(self: Box<Path>) -> PathBuf[src]1.20.0

Converts a Box<Path> into a PathBuf without copying or allocating.

Trait Implementations

impl AsRef<OsStr> for Path[src]

impl<'_> AsRef<Path> for Component<'_>[src]1.25.0

impl<'_> AsRef<Path> for Components<'_>[src]

impl<'_> AsRef<Path> for Iter<'_>[src]

impl AsRef<Path> for Path[src]

impl AsRef<Path> for OsStr[src]

impl<'_> AsRef<Path> for Cow<'_, OsStr>[src]1.8.0

impl AsRef<Path> for OsString[src]

impl AsRef<Path> for str[src]

impl AsRef<Path> for String[src]

impl AsRef<Path> for PathBuf[src]

impl Borrow<Path> for PathBuf[src]

impl Debug for Path[src]

impl Eq for Path[src]

impl<'_> From<&'_ Path> for Box<Path>[src]1.17.0

impl<'_> From<&'_ Path> for Arc<Path>[src]1.24.0

fn from(s: &Path) -> Arc<Path>[src]

Converts a Path into an Arc by copying the Path data into a new Arc buffer.

impl<'_> From<&'_ Path> for Rc<Path>[src]1.24.0

fn from(s: &Path) -> Rc<Path>[src]

Converts a Path into an Rc by copying the Path data into a new Rc buffer.

impl<'a> From<&'a Path> for Cow<'a, Path>[src]1.6.0

impl Hash for Path[src]

impl<'a> IntoIterator for &'a Path[src]1.6.0

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?

impl Ord for Path[src]

impl<'a, 'b> PartialEq<&'a OsStr> for Path[src]1.8.0

impl<'a, 'b> PartialEq<&'a Path> for PathBuf[src]1.6.0

impl<'a, 'b> PartialEq<&'a Path> for OsStr[src]1.8.0

impl<'a, 'b> PartialEq<&'a Path> for Cow<'b, OsStr>[src]1.8.0

impl<'a, 'b> PartialEq<&'a Path> for OsString[src]1.8.0

impl<'a, 'b> PartialEq<&'b Path> for Cow<'a, Path>[src]1.6.0

impl<'a, 'b> PartialEq<Cow<'a, OsStr>> for Path[src]1.8.0

impl<'a, 'b> PartialEq<Cow<'a, Path>> for Path[src]1.6.0

impl<'a, 'b> PartialEq<Cow<'a, Path>> for &'b Path[src]1.6.0

impl<'a, 'b> PartialEq<Cow<'b, OsStr>> for &'a Path[src]1.8.0

impl<'a, 'b> PartialEq<OsStr> for Path[src]1.8.0

impl<'a, 'b> PartialEq<OsStr> for &'a Path[src]1.8.0

impl<'a, 'b> PartialEq<OsString> for Path[src]1.8.0

impl<'a, 'b> PartialEq<OsString> for &'a Path[src]1.8.0

impl PartialEq<Path> for Path[src]

impl<'a, 'b> PartialEq<Path> for PathBuf[src]1.6.0

impl<'a, 'b> PartialEq<Path> for Cow<'a, Path>[src]1.6.0

impl<'a, 'b> PartialEq<Path> for OsStr[src]1.8.0

impl<'a, 'b> PartialEq<Path> for &'a OsStr[src]1.8.0

impl<'a, 'b> PartialEq<Path> for Cow<'a, OsStr>[src]1.8.0

impl<'a, 'b> PartialEq<Path> for OsString[src]1.8.0

impl<'a, 'b> PartialEq<PathBuf> for Path[src]1.6.0

impl<'a, 'b> PartialEq<PathBuf> for &'a Path[src]1.6.0

impl<'a, 'b> PartialOrd<&'a OsStr> for Path[src]1.8.0

impl<'a, 'b> PartialOrd<&'a Path> for PathBuf[src]1.8.0

impl<'a, 'b> PartialOrd<&'a Path> for OsStr[src]1.8.0

impl<'a, 'b> PartialOrd<&'a Path> for Cow<'b, OsStr>[src]1.8.0

impl<'a, 'b> PartialOrd<&'a Path> for OsString[src]1.8.0

impl<'a, 'b> PartialOrd<&'b Path> for Cow<'a, Path>[src]1.8.0

impl<'a, 'b> PartialOrd<Cow<'a, OsStr>> for Path[src]1.8.0

impl<'a, 'b> PartialOrd<Cow<'a, Path>> for Path[src]1.8.0

impl<'a, 'b> PartialOrd<Cow<'a, Path>> for &'b Path[src]1.8.0

impl<'a, 'b> PartialOrd<Cow<'b, OsStr>> for &'a Path[src]1.8.0

impl<'a, 'b> PartialOrd<OsStr> for Path[src]1.8.0

impl<'a, 'b> PartialOrd<OsStr> for &'a Path[src]1.8.0

impl<'a, 'b> PartialOrd<OsString> for Path[src]1.8.0

impl<'a, 'b> PartialOrd<OsString> for &'a Path[src]1.8.0

impl PartialOrd<Path> for Path[src]

impl<'a, 'b> PartialOrd<Path> for PathBuf[src]1.8.0

impl<'a, 'b> PartialOrd<Path> for Cow<'a, Path>[src]1.8.0

impl<'a, 'b> PartialOrd<Path> for OsStr[src]1.8.0

impl<'a, 'b> PartialOrd<Path> for &'a OsStr[src]1.8.0

impl<'a, 'b> PartialOrd<Path> for Cow<'a, OsStr>[src]1.8.0

impl<'a, 'b> PartialOrd<Path> for OsString[src]1.8.0

impl<'a, 'b> PartialOrd<PathBuf> for Path[src]1.8.0

impl<'a, 'b> PartialOrd<PathBuf> for &'a Path[src]1.8.0

impl ToOwned for Path[src]

type Owned = PathBuf

The resulting type after obtaining ownership.

Auto Trait Implementations

impl RefUnwindSafe for Path

impl Send for Path

impl Sync for Path

impl Unpin for Path

impl UnwindSafe for Path

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

© 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.Path.html