Struct tsfc::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 / or \, depending on the platform), 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;

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

let parent = path.parent();
assert_eq!(parent, Some(Path::new("/tmp/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")));

Methods

impl Path

fn new<S>(s: &S) -> &Path where
    S: AsRef<OsStr> + ?Sized, 

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

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

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.

Examples

use std::path::Path;

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

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".

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

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

fn is_relative(&self) -> bool

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

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

Examples

use std::path::Path;

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

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

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

fn strip_prefix<P>(&'a self, base: &'a P) -> Result<&'a Path, StripPrefixError> where
    P: AsRef<Path> + ?Sized, 

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;

let path = Path::new("/test/haha/foo.txt");

assert_eq!(path.strip_prefix("/test"), Ok(Path::new("haha/foo.txt")));
assert_eq!(path.strip_prefix("test").is_ok(), false);
assert_eq!(path.strip_prefix("/haha").is_ok(), false);

fn starts_with<P>(&self, base: P) -> bool where
    P: AsRef<Path>, 

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("/e"));

fn ends_with<P>(&self, child: P) -> bool where
    P: AsRef<Path>, 

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/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

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

use std::path::Path;

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

assert_eq!("rs", path.extension().unwrap());

fn join<P>(&self, path: P) -> PathBuf where
    P: AsRef<Path>, 

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

fn with_file_name<S>(&self, file_name: S) -> PathBuf where
    S: AsRef<OsStr>, 

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

fn with_extension<S>(&self, extension: S) -> PathBuf where
    S: AsRef<OsStr>, 

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

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/b and a//b both have a and b as components.

• Occurentces of . are normalized away, exept 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.

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)

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

fn metadata(&self) -> Result<Metadata, Error>

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

fn symlink_metadata(&self) -> Result<Metadata, Error>

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

fn canonicalize(&self) -> Result<PathBuf, Error>

Returns the canonical 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"));

fn read_link(&self) -> Result<PathBuf, Error>

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

fn read_dir(&self) -> Result<ReadDir, Error>

Returns an iterator over the entries within a directory.

The iterator will yield instances of io::Result<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());
    }
}

fn exists(&self) -> bool

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

Examples

use std::path::Path;
assert_eq!(Path::new("does_not_exist.txt").exists(), false);

fn is_file(&self) -> bool

Returns whether the path 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.

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

fn is_dir(&self) -> bool

Returns whether the path 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.

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

fn into_path_buf(self: Box<Path>) -> PathBuf

🔬 This is a nightly-only experimental API. (into_boxed_path)

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

Trait Implementations

impl Debug for Path

fn fmt(&self, formatter: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl<'a> IntoIterator for &'a Path

type Item = &'a OsStr

type IntoIter = Iter<'a>

fn into_iter(self) -> Iter<'a>

impl Eq for Path

impl AsRef<Path> for Path

fn as_ref(&self) -> &Path

Performs the conversion.

impl AsRef<OsStr> for Path

fn as_ref(&self) -> &OsStr

Performs the conversion.

impl ToOwned for Path

type Owned = PathBuf

fn to_owned(&self) -> PathBuf

fn clone_into(&self, target: &mut PathBuf)

impl PartialOrd<Path> for Path

fn partial_cmp(&self, other: &Path) -> Option<Ordering>

impl<'a, 'b> PartialOrd<OsString> for Path

fn partial_cmp(&self, other: &OsString) -> Option<Ordering>

impl<'a, 'b> PartialOrd<&'a OsStr> for Path

fn partial_cmp(&self, other: &&'a OsStr) -> Option<Ordering>

impl<'a, 'b> PartialOrd<OsStr> for Path

fn partial_cmp(&self, other: &OsStr) -> Option<Ordering>

impl<'a, 'b> PartialOrd<PathBuf> for &'a Path

fn partial_cmp(&self, other: &PathBuf) -> Option<Ordering>

impl<'a, 'b> PartialOrd<Cow<'a, Path>> for &'b Path

fn partial_cmp(&self, other: &Cow<'a, Path>) -> Option<Ordering>

impl<'a, 'b> PartialOrd<Cow<'b, OsStr>> for &'a Path

fn partial_cmp(&self, other: &Cow<'b, OsStr>) -> Option<Ordering>

impl<'a, 'b> PartialOrd<Cow<'a, Path>> for Path

fn partial_cmp(&self, other: &Cow<'a, Path>) -> Option<Ordering>

impl<'a, 'b> PartialOrd<Cow<'a, OsStr>> for Path

fn partial_cmp(&self, other: &Cow<'a, OsStr>) -> Option<Ordering>

impl<'a, 'b> PartialOrd<OsStr> for &'a Path

fn partial_cmp(&self, other: &OsStr) -> Option<Ordering>

impl<'a, 'b> PartialOrd<OsString> for &'a Path

fn partial_cmp(&self, other: &OsString) -> Option<Ordering>

impl<'a, 'b> PartialOrd<PathBuf> for Path

fn partial_cmp(&self, other: &PathBuf) -> Option<Ordering>

impl Hash for Path

fn hash<H>(&self, h: &mut H) where
    H: Hasher, 

impl<'a, 'b> PartialEq<Cow<'a, Path>> for Path

fn eq(&self, other: &Cow<'a, Path>) -> bool

impl<'a, 'b> PartialEq<Cow<'a, OsStr>> for Path

fn eq(&self, other: &Cow<'a, OsStr>) -> bool

impl<'a, 'b> PartialEq<Cow<'b, OsStr>> for &'a Path

fn eq(&self, other: &Cow<'b, OsStr>) -> bool

impl<'a, 'b> PartialEq<OsString> for &'a Path

fn eq(&self, other: &OsString) -> bool

impl PartialEq<Path> for Path

fn eq(&self, other: &Path) -> bool

impl<'a, 'b> PartialEq<PathBuf> for &'a Path

fn eq(&self, other: &PathBuf) -> bool

impl<'a, 'b> PartialEq<OsStr> for Path

fn eq(&self, other: &OsStr) -> bool

impl<'a, 'b> PartialEq<PathBuf> for Path

fn eq(&self, other: &PathBuf) -> bool

impl<'a, 'b> PartialEq<OsString> for Path

fn eq(&self, other: &OsString) -> bool

impl<'a, 'b> PartialEq<OsStr> for &'a Path

fn eq(&self, other: &OsStr) -> bool

impl<'a, 'b> PartialEq<&'a OsStr> for Path

fn eq(&self, other: &&'a OsStr) -> bool

impl<'a, 'b> PartialEq<Cow<'a, Path>> for &'b Path

fn eq(&self, other: &Cow<'a, Path>) -> bool

impl Ord for Path

fn cmp(&self, other: &Path) -> Ordering