Struct kernel::fs::path::PathBuf

pub struct PathBuf {
    inner: String,
}

An owned, mutable path (akin to String).

This type provides methods like PathBuf::push 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 crate documentation.

Examples

You can use PathBuf::push to build up a PathBuf from components:

let mut path = PathBuf::new();

path.push("/");
path.push("feel");
path.push("the");

However, PathBuf::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:

let path: PathBuf = ["/", "feel", "the.force"].iter().collect();

We can still do better than this! Since these are all strings, we can use From::from:

let path = PathBuf::from(r"/feel/the.force");

Which method works best depends on what kind of situation you’re in.

Fields

inner: String

Implementations

impl PathBuf

pub fn new() -> PathBuf

Allocates an empty PathBuf.

Examples

let path = PathBuf::new();

pub fn with_capacity(capacity: usize) -> PathBuf

Creates a new PathBuf with a given capacity used to create the internal String. See String::with_capacity.

Examples

let mut path = PathBuf::with_capacity(10);
let capacity = path.capacity();

// This push is done without reallocating
path.push("/");

assert_eq!(capacity, path.capacity());

pub fn as_path(&self) -> &Path

Coerces to a Path slice.

Examples

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.

Examples

Pushing a relative path extends the existing path:

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:

let mut path = PathBuf::from("/tmp");
path.push("/etc");
assert_eq!(path, PathBuf::from("/etc"));

fn _push(&mut self, path: &Path)

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

let mut p = PathBuf::from("/test/test.rs");

p.pop();
assert_eq!(Path::new("/test"), p);
p.pop();
assert_eq!(Path::new("/"), p);

pub fn set_file_name<S: AsRef<str>>(&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

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_file_name(&mut self, file_name: &str)

pub fn into_string(self) -> String

Consumes the PathBuf, yielding its internal String storage.

Examples

let p = PathBuf::from("/the/head");
let bytes = p.into_string();

pub fn into_boxed_path(self) -> Box<Path>

Converts this PathBuf into a boxed Path.

pub fn capacity(&self) -> usize

Invokes capacity on the underlying instance of String.

pub fn clear(&mut self)

Invokes clear on the underlying instance of String.

pub fn reserve(&mut self, additional: usize)

Invokes reserve on the underlying instance of String.

pub fn reserve_exact(&mut self, additional: usize)

Invokes reserve_exact on the underlying instance of String.

pub fn shrink_to_fit(&mut self)

Invokes shrink_to_fit on the underlying instance of String.

pub fn shrink_to(&mut self, min_capacity: usize)

Invokes shrink_to on the underlying instance of String.

Methods from Deref<Target = Path>

pub fn as_str(&self) -> &str

Yields the underlying bytes.

Examples

let os_str = Path::new("foo.txt").as_str();
assert_eq!(os_str, "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

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:

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

let path_buf = Path::new("foo.txt").to_path_buf();
assert_eq!(path_buf, 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.

A path is absolute if it starts with the root, so is_absolute and has_root are equivalent.

Examples

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

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

pub fn has_root(&self) -> bool

Returns true if the Path has a root.

A path has a root if it begins with /.

Examples

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

pub fn has_last_separator(&self) -> bool

Checks if the path ends with a separator.

This function checks if the last character of the path string is a separator character. If the path is empty, it returns false.

Returns

• true if the path ends with a separator.
• false if the path does not end with a separator or if the path is empty.

Examples

use your_module::Path;

let p = Path::new("/some/path/");
assert_eq!(p.has_last_separator(), true);

let p = Path::new("/some/path");
assert_eq!(p.has_last_separator(), false);

pub fn is_root(&self) -> bool

Checks if the path is the root directory.

This function compares the path string with “/”, the root directory. If the path is “/”, it returns true. For any other path, it returns false.

Returns

• true if the path is the root directory (“/”).
• false if the path is not the root directory.

Examples

use your_module::Path;

let p = Path::new("/");
assert_eq!(p.is_root(), true);

let p = Path::new("/some/path");
assert_eq!(p.is_root(), false);

pub fn is_empty(&self) -> bool

Checks if the path is empty.

This function checks if the path string is empty. If the path is an empty string, it returns true. For any non-empty path, it returns false.

Returns

• true if the path is an empty string.
• false if the path is not an empty string.

Examples

use your_module::Path;

let p = Path::new("");
assert_eq!(p.is_empty(), true);

let p = Path::new("/some/path");
assert_eq!(p.is_empty(), false);

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

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

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

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

pub fn file_name(&self) -> Option<&str>

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

assert_eq!(Some("bin"), Path::new("/usr/bin/").file_name());
assert_eq!(Some("foo.txt"), Path::new("tmp/foo.txt").file_name());
assert_eq!(Some("foo.txt"), Path::new("foo.txt/.").file_name());
assert_eq!(Some("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>,

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

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_eq!(path.strip_prefix("test").is_ok(), false);
assert_eq!(path.strip_prefix("/haha").is_ok(), false);

let prefix = PathBuf::from("/test/");
assert_eq!(path.strip_prefix(prefix), Ok(Path::new("haha/foo.txt")));

fn _strip_prefix(&self, base: &Path) -> Result<&Path, StripPrefixError>

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

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

assert!(!path.starts_with("/e"));

fn _starts_with(&self, base: &Path) -> bool

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

let path = Path::new("/etc/passwd");

assert!(path.ends_with("passwd"));

fn _ends_with(&self, child: &Path) -> bool

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

assert_eq!(Path::new("/etc").join("passwd"), PathBuf::from("/etc/passwd"));

fn _join(&self, path: &Path) -> PathBuf

pub fn with_file_name<S: AsRef<str>>(&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

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_file_name(&self, file_name: &str) -> PathBuf

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

let mut components = Path::new("/tmp/foo.txt").components();

assert_eq!(components.next(), Some(Component::RootDir));
assert_eq!(components.next(), Some(Component::Normal("tmp")));
assert_eq!(components.next(), Some(Component::Normal("foo.txt")));
assert_eq!(components.next(), None)

pub fn iter(&self) -> Iter<'_>

Produces an iterator over the path’s components viewed as str slices.

For more information about the particulars of how the path is separated into components, see components.

Examples

let mut it = Path::new("/tmp/foo.txt").iter();
assert_eq!(it.next(), Some("/"));
assert_eq!(it.next(), Some("tmp"));
assert_eq!(it.next(), Some("foo.txt"));
assert_eq!(it.next(), None)

pub fn display(&self) -> Display<'_>

Returns a newtype that implements Display for safely printing paths that may contain non-Unicode data.

Trait Implementations

impl AsRef<Path> for PathBuf

fn as_ref(&self) -> &Path

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<str> for PathBuf

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<Path> for PathBuf

fn borrow(&self) -> &Path

Immutably borrows from an owned value.

impl Clone for PathBuf

fn clone(&self) -> PathBuf

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PathBuf

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

Formats the value using the given formatter.

impl Default for PathBuf

fn default() -> Self

Returns the “default value” for a type.

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.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl<'a> From<&'a PathBuf> for Cow<'a, Path>

fn from(p: &'a PathBuf) -> Cow<'a, Path>

Converts to this type from the input type.

impl<T: ?Sized + AsRef<str>> From<&T> for PathBuf

fn from(s: &T) -> Self

Converts to this type from the input type.

impl<'a> From<Cow<'a, Path>> for PathBuf

fn from(p: Cow<'a, Path>) -> Self

Converts to this type from the input type.

impl From<PathBuf> for Arc<Path>

fn from(s: PathBuf) -> Arc<Path>

Converts a PathBuf into an Arc by moving the PathBuf data into a new Arc buffer.

impl From<PathBuf> for Box<Path>

fn from(p: PathBuf) -> Self

Converts a PathBuf into a Box<Path>

This conversion currently should not allocate memory, but this behavior is not guaranteed in all future versions.

impl<'a> From<PathBuf> for Cow<'a, Path>

fn from(s: PathBuf) -> Cow<'a, Path>

Converts to this type from the input type.

impl From<PathBuf> for Rc<Path>

fn from(s: PathBuf) -> Rc<Path>

Converts a PathBuf into an Rc by moving the PathBuf data into a new Rc buffer.

impl From<PathBuf> for String

fn from(path_buf: PathBuf) -> Self

Converts a PathBuf into a String

This conversion does not allocate or copy memory.

impl From<String> for PathBuf

fn from(s: String) -> Self

Converts a String into a PathBuf

This conversion does not allocate or copy memory.

impl<P: AsRef<Path>> FromIterator<P> for PathBuf

fn from_iter<I: IntoIterator<Item = P>>(iter: I) -> PathBuf

Creates a value from an iterator.

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.

impl Hash for PathBuf

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

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> IntoIterator for &'a PathBuf

type Item = &'a str

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>

Creates an iterator from a value.

impl Ord for PathBuf

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for PathBuf

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

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.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

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.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

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.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

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.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

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.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd for PathBuf

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

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for PathBuf