Struct std::fs::PathBuf

An owned (heap-allocated) path buffer

Example

use std::fs::{PathBuf, Path};

let path = PathBuf::from_str("/home");
defer path.free();

path.push(Path::new("alumina/"));
assert_eq!(path.as_path(), Path::new("/home/alumina"));

path.push(Path::new("/hello/world"));
assert_eq!(path.as_path(), Path::new("/hello/world"));
Run this example

Fields

• inner: StringBuf

Methods

• fn new() -> PathBuf

  source

  Create a new empty path buffer

• fn from_path(path: Path) -> PathBuf

  source

  Create a new path buffer from a Path instance

  Example

  use std::fs::{PathBuf, Path};
  
  let path = PathBuf::from_path(Path::new("/home/alumina"));
  defer path.free();
  
  assert_eq!(path.as_path(), Path::new("/home/alumina"));
  Run this example

• fn from_str(path: &[u8]) -> PathBuf

  source

  Create a new path buffer from a string slice

  Example

  use std::fs::{PathBuf, Path};
  
  let path = PathBuf::from_str("/home/alumina");
  defer path.free();
  
  assert_eq!(path.as_path(), Path::new("/home/alumina"));
  Run this example

• fn as_path(self: &PathBuf) -> Path

  source

  View path as Path object

  Example

  use std::fs::{PathBuf, Path};
  
  let path = PathBuf::from_str("/home/alumina");
  defer path.free();
  
  assert_eq!(path.as_path(), Path::new("/home/alumina"));
  Run this example

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

  source

  Returns the contents of the object as a slice.

  See AsSlice for details.

• fn as_slice_mut(self: &mut PathBuf) -> &mut [u8]

  source

  Returns the contents of the object as a mutable slice.

  See AsSliceMut for details.

• fn extend<It>(self: &mut PathBuf, iter: &mut It)

  It: Iterator<It, PathSegment>

  source

  Extend the path buffer from an iterator of path segments

  Example

  use std::fs::{PathBuf, Path, PathSegment};
  
  let path = PathBuf::from_str("/home");
  defer path.free();
  
  path.extend(&[
      PathSegment::parent_dir(),
      PathSegment::current_dir(),
      PathSegment::normal("alumina"),
  ].iter());
  
  assert_eq!(path.as_path(), Path::new("/home/.././alumina"));
  Run this example

• fn with_suffix(self: &PathBuf, suffix: Path) -> PathBuf

  source

  Create a new path buffer with the base path of self and extension suffix.

  Example

  use std::fs::{PathBuf, Path};
  
  let path = PathBuf::from_str("/home/alumina");
  defer path.free();
  
  let new_path = path.with_suffix(Path::new("foo/bar"));
  defer new_path.free();
  
  assert_eq!(new_path.as_path(), Path::new("/home/alumina/foo/bar"));
  Run this example

• fn push(self: &mut PathBuf, suffix: Path)

  source

  Extend the path buffer with a Path instance

  Example

  use std::fs::{PathBuf, Path};
  
  let path = PathBuf::from_str("/home");
  defer path.free();
  
  path.push(Path::new("alumina"));
  
  assert_eq!(path.as_path(), Path::new("/home/alumina"));
  Run this example

• fn pop(self: &mut PathBuf) -> bool

  source

  Pop the last path segment from the path buffer

  Returns true if the path buffer was modified, false otherwise.

  Example

  use std::fs::{PathBuf, Path};
  
  let path = PathBuf::from_str("/home/alumina");
  defer path.free();
  
  assert!(path.pop());
  assert_eq!(path.as_path(), Path::new("/home"));
  
  assert!(path.pop());
  assert_eq!(path.as_path(), Path::new("/"));
  
  assert!(!path.pop());
  assert_eq!(path.as_path(), Path::new("/"));
  Run this example

• fn from_iter<It>(iter: &mut It) -> PathBuf

  It: Iterator<It, PathSegment>

  source

  Create a new path buffer from an iterator of path segments

  Example

  use std::fs::{PathBuf, Path, PathSegment};
  
  let path = PathBuf::from_iter(&[
      PathSegment::normal("home"),
      PathSegment::normal("alumina"),
  ].iter());
  defer path.free();
  
  assert_eq!(path.as_path(), Path::new("/home/alumina"));
  Run this example

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

  F: Formatter<F>

  source

  Write the object into a given formatter.

  See Formattable for details.

• fn clone(self: &PathBuf) -> PathBuf

  source

  Returns a copy of the object.

• fn borrow(self: &PathBuf) -> Path

  source

  Returns a view to the object.

• fn free(self: &mut PathBuf)

  source

  Frees the memory backing the object.

• fn move(self: &mut PathBuf) -> PathBuf

  source

  Creates a copy of the object, leaving an inert object behind.

  See Movable for details.