[−][src]Struct path_dsl::PathDSL

#[repr(transparent)]pub struct PathDSL { /* fields omitted */ }

A PathBuf wrapper that has support for a Path DSL.

It is usable nearly identically to a PathBuf. Supports Deref to PathBuf to cover all edge cases.

Prefer using the path! macro.

See crate documentation for usage examples.

Implementations

`impl PathDSL`[src]

`pub fn new() -> Self`[src]

Creates a new PathDSL with a new empty PathBuf inside

`pub fn into_os_string(self) -> OsString`[src]

Forwarder function for PathBuf::into_os_string

`pub fn into_boxed_path(self) -> Box<Path>`[src]

Forwarder function for PathBuf::into_boxed_path

`pub fn into_pathbuf(self) -> PathBuf`[src]

Converts this PathDSL into the underlying PathBuf

Methods from Deref<Target = PathBuf>

`pub fn as_path(&self) -> &Path`1.0.0[src]

Coerces to a Path slice.

Examples

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

let p = PathBuf::from("/test");
assert_eq!(Path::new("/test"), p.as_path());

`pub fn push(&mut self, path: P) where P: AsRef<Path>,` 1.0.0[src]

Extends self with path.

If path is absolute, it replaces the current path.

On Windows:

if path has a root but no prefix (e.g., \windows), it replaces everything except for the prefix (if any) of self.
if path has a prefix but no root, it replaces self.

Examples

Pushing a relative path extends the existing path:

use std::path::PathBuf;

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:

use std::path::PathBuf;

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

`pub fn pop(&mut self) -> bool`1.0.0[src]

Truncates self to self.parent.

Returns false and does nothing if self.parent is None. Otherwise, returns true.

Examples

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

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>(&mut self, file_name: S) where S: AsRef<OsStr>,` 1.0.0[src]

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

use std::path::PathBuf;

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

`pub fn set_extension<S>(&mut self, extension: S) -> bool where S: AsRef<OsStr>,` 1.0.0[src]

Updates self.extension to extension.

Returns false and does nothing if self.file_name is None, returns true and updates the extension otherwise.

If self.extension is None, the extension is added; otherwise it is replaced.

Examples

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

let mut p = PathBuf::from("/feel/the");

p.set_extension("force");
assert_eq!(Path::new("/feel/the.force"), p.as_path());

p.set_extension("dark_side");
assert_eq!(Path::new("/feel/the.dark_side"), p.as_path());