Struct std::fs::Path

A filesystem path

This is a non-owning variant (a view). For the owned path buffer, see PathBuf.

Example

use std::fs::Path;

let p = Path::new("/home/user/file.txt");

assert!(p.is_absolute());
assert_eq!(p.parent(), Option::some(Path::new("/home/user")));
Run this example

Fields

• inner: &[u8]

Methods

• fn new(inner: &[u8]) -> Path

  source

  Create a path from a string slice

  Example

  use std::fs::Path;
  
  let _ = Path::new("/home/user/file.txt");
  Run this example

• fn iter(self: &Path) -> PathIterator

  source

  Returns an iterator over the elements of this iterable.

  See Iterable for details.

• fn as_slice(self: &Path) -> &[u8]

  source

  Returns the contents of the object as a slice.

  See AsSlice for details.

• fn is_absolute(self: &Path) -> bool

  source

  Returns true if the path is absolute, false otherwise

  Example

  use std::fs::Path;
  
  assert!(Path::new("/home/user/file.txt").is_absolute());
  assert!(!Path::new("file.txt").is_absolute());
  Run this example

• fn is_relative(self: &Path) -> bool

  source

  Returns true if the path is relative, false otherwise

  Example

  use std::fs::Path;
  
  assert!(Path::new("file.txt").is_relative());
  assert!(!Path::new("/home/user/file.txt").is_relative());
  Run this example

• fn parent(self: &Path) -> Option<Path>

  source

  Returns the parent path of the path

  If the path has no parent, then Option::none() is returned.

  Example

  use std::fs::Path;
  
  assert_eq!(Path::new("/home/user/file.txt").parent(), Option::some(Path::new("/home/user")));
  assert_eq!(Path::new("/home/user").parent(), Option::some(Path::new("/home")));
  assert_eq!(Path::new("/home").parent(), Option::some(Path::new("/")));
  assert_eq!(Path::new("/").parent(), Option::none());
  Run this example

• fn strip_prefix(self: &Path, prefix: Path) -> Option<Path>

  source

  Strips the prefix from the path.

  If the path does not start with the prefix, then Option::none() is returned.

  Example

  use std::fs::Path;
  
  let p = Path::new("/home/user/file.txt");
  
  let stripped1 = p.strip_prefix(Path::new("/home/user"));
  let stripped2 = p.strip_prefix(Path::new("/something/else"));
  
  assert_eq!(stripped1, Option::some(Path::new("file.txt")));
  assert_eq!(stripped2, Option::none());
  Run this example

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

  source

  Returns true if other is a prefix of the current path, false otherwise

  Example

  use std::fs::Path;
  
  let p = Path::new("/home/user/file.txt");
  
  assert!(p.starts_with(Path::new("/home/user")));
  assert!(!p.starts_with(Path::new("/something/else")));
  Run this example

• fn fmt<F>(self: &Path, f: &mut F) -> Result

  F: Formatter<F>

  source

  Write the object into a given formatter.

  See Formattable for details.

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

  source

  Returns true if arguments are equal, false otherwise

  See Equatable for details.

Mixins

• mixin Equatable<Path>

• fn not_equals(lhs: &Self, rhs: &Self) -> bool

  source

  Returns false if arguments are equal, true otherwise