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.

Methods

impl PathDSL

pub fn new() -> Self

Creates a new PathDSL with a new empty PathBuf inside

pub fn into_os_string(self) -> OsString

Forwarder function for PathBuf::into_os_string

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

Forwarder function for PathBuf::into_boxed_path

pub fn into_pathbuf(self) -> PathBuf

Converts this PathDSL into the underlying PathBuf

Methods from Deref<Target = PathBuf>

pub fn as_path(&self) -> &Path

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<P>(&mut self, path: P) where
    P: AsRef<Path>, 

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

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

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

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

pub fn capacity(&self) -> usize

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

Invokes capacity on the underlying instance of OsString.

pub fn clear(&mut self)

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

Invokes clear on the underlying instance of OsString.

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

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

Invokes reserve on the underlying instance of OsString.

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

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

Invokes reserve_exact on the underlying instance of OsString.

pub fn shrink_to_fit(&mut self)

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

Invokes shrink_to_fit on the underlying instance of OsString.

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

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

Invokes shrink_to on the underlying instance of OsString.

Trait Implementations

impl AsMut<PathBuf> for PathDSL

fn as_mut(&mut self) -> &mut PathBuf

Performs the conversion.

impl Into<PathBuf> for PathDSL

fn into(self) -> PathBuf

Performs the conversion.

impl Into<OsString> for PathDSL

fn into(self) -> OsString

Performs the conversion.

impl Into<Box<Path>> for PathDSL

fn into(self) -> Box<Path>

Performs the conversion.

impl<'a> Into<Cow<'a, Path>> for PathDSL

fn into(self) -> Cow<'a, Path>

Performs the conversion.

impl<'a> Into<Cow<'a, Path>> for &'a PathDSL

fn into(self) -> Cow<'a, Path>

Performs the conversion.

impl<'a> Into<Cow<'a, OsStr>> for &'a PathDSL

fn into(self) -> Cow<'a, OsStr>

Performs the conversion.

impl<'a> Into<Arc<Path>> for PathDSL

fn into(self) -> Arc<Path>

Performs the conversion.

impl<'a> Into<Rc<Path>> for PathDSL

fn into(self) -> Rc<Path>

Performs the conversion.

impl Default for PathDSL

fn default() -> PathDSL

Returns the "default value" for a type.

impl Ord for PathDSL

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl Clone for PathDSL

fn clone(&self) -> PathDSL

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<PathDSL> for PathDSL

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<PathBuf> for PathDSL

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Path> for PathDSL

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<OsStr> for PathDSL

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<OsString> for PathDSL

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<Cow<'a, OsStr>> for PathDSL

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<P> Extend<P> for PathDSL where
    P: AsRef<Path>, 

fn extend<I: IntoIterator<Item = P>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

impl AsRef<Path> for PathDSL

fn as_ref(&self) -> &Path

Performs the conversion.

impl AsRef<OsStr> for PathDSL

fn as_ref(&self) -> &OsStr

Performs the conversion.

impl<'_, T: ?Sized> From<&'_ T> for PathDSL where
    T: AsRef<Path>, 

fn from(other: &T) -> Self

Performs the conversion.

impl<'_, T: ?Sized> From<&'_ mut T> for PathDSL where
    T: AsRef<Path>, 

fn from(other: &mut T) -> Self

Performs the conversion.

impl From<PathBuf> for PathDSL

fn from(other: PathBuf) -> Self

Performs the conversion.

impl From<OsString> for PathDSL

fn from(other: OsString) -> Self

Performs the conversion.

impl From<String> for PathDSL

fn from(other: String) -> Self

Performs the conversion.

impl From<Box<Path>> for PathDSL

fn from(other: Box<Path>) -> Self

Performs the conversion.

impl<'_> From<Cow<'_, Path>> for PathDSL

fn from(other: Cow<Path>) -> Self

Performs the conversion.

impl<'_> From<Cow<'_, OsStr>> for PathDSL

fn from(other: Cow<OsStr>) -> Self

Performs the conversion.

impl Eq for PathDSL

impl<'a> IntoIterator for &'a PathDSL

type Item = &'a OsStr

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) -> Self::IntoIter

Creates an iterator from a value.

impl PartialOrd<PathDSL> for PathDSL

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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<PathBuf> for PathDSL

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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<Path> for PathDSL

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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> PartialOrd<Cow<'a, Path>> for PathDSL

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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> PartialOrd<Cow<'a, OsStr>> for PathDSL

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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<OsStr> for PathDSL

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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<OsString> for PathDSL

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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 Deref for PathDSL

type Target = PathBuf

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for PathDSL

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Debug for PathDSL

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Div<PathDSL> for PathDSL

type Output = PathDSL

The resulting type after applying the / operator.

fn div(self, rhs: PathDSL) -> Self::Output

Performs the / operation.

impl<'_, T: ?Sized> Div<&'_ T> for PathDSL where
    T: AsRef<Path>, 

type Output = PathDSL

The resulting type after applying the / operator.

fn div(self, rhs: &T) -> Self::Output

Performs the / operation.

impl<'_, T: ?Sized> Div<&'_ mut T> for PathDSL where
    T: AsRef<Path>, 

type Output = PathDSL

The resulting type after applying the / operator.

fn div(self, rhs: &mut T) -> Self::Output

Performs the / operation.

impl Div<OsString> for PathDSL

type Output = PathDSL

The resulting type after applying the / operator.

fn div(self, rhs: OsString) -> Self::Output

Performs the / operation.

impl Div<String> for PathDSL

type Output = PathDSL

The resulting type after applying the / operator.

fn div(self, rhs: String) -> Self::Output

Performs the / operation.

impl Div<PathBuf> for PathDSL

type Output = PathDSL

The resulting type after applying the / operator.

fn div(self, rhs: PathBuf) -> Self::Output

Performs the / operation.

impl Div<Box<Path>> for PathDSL

type Output = PathDSL

The resulting type after applying the / operator.

fn div(self, rhs: Box<Path>) -> Self::Output

Performs the / operation.

impl<'_> Div<Cow<'_, Path>> for PathDSL

type Output = PathDSL

The resulting type after applying the / operator.

fn div(self, rhs: Cow<Path>) -> Self::Output

Performs the / operation.

impl<'_> Div<Cow<'_, OsStr>> for PathDSL

type Output = PathDSL

The resulting type after applying the / operator.

fn div(self, rhs: Cow<OsStr>) -> Self::Output

Performs the / operation.

impl<'_> Div<PathDSL> for &'_ PathDSL

type Output = PathDSL

The resulting type after applying the / operator.

fn div(self, rhs: PathDSL) -> Self::Output

Performs the / operation.

impl<'_, '_, T: ?Sized> Div<&'_ T> for &'_ PathDSL where
    T: AsRef<Path>, 

type Output = PathDSL

The resulting type after applying the / operator.

fn div(self, rhs: &T) -> Self::Output

Performs the / operation.

impl<'_, '_, T: ?Sized> Div<&'_ mut T> for &'_ PathDSL where
    T: AsRef<Path>, 

type Output = PathDSL

The resulting type after applying the / operator.

fn div(self, rhs: &mut T) -> Self::Output

Performs the / operation.

impl<'_> Div<OsString> for &'_ PathDSL

type Output = PathDSL

The resulting type after applying the / operator.

fn div(self, rhs: OsString) -> Self::Output

Performs the / operation.

impl<'_> Div<String> for &'_ PathDSL

type Output = PathDSL

The resulting type after applying the / operator.

fn div(self, rhs: String) -> Self::Output

Performs the / operation.

impl<'_> Div<PathBuf> for &'_ PathDSL

type Output = PathDSL

The resulting type after applying the / operator.

fn div(self, rhs: PathBuf) -> Self::Output

Performs the / operation.

impl<'_> Div<Box<Path>> for &'_ PathDSL

type Output = PathDSL

The resulting type after applying the / operator.

fn div(self, rhs: Box<Path>) -> Self::Output

Performs the / operation.

impl<'_, '_> Div<Cow<'_, Path>> for &'_ PathDSL

type Output = PathDSL

The resulting type after applying the / operator.

fn div(self, rhs: Cow<Path>) -> Self::Output

Performs the / operation.

impl<'_, '_> Div<Cow<'_, OsStr>> for &'_ PathDSL

type Output = PathDSL

The resulting type after applying the / operator.

fn div(self, rhs: Cow<OsStr>) -> Self::Output

Performs the / operation.

impl<'_> Div<PathDSL> for &'_ mut PathDSL

type Output = PathDSL

The resulting type after applying the / operator.

fn div(self, rhs: PathDSL) -> Self::Output

Performs the / operation.

impl<'_, '_, T: ?Sized> Div<&'_ T> for &'_ mut PathDSL where
    T: AsRef<Path>, 

type Output = PathDSL

The resulting type after applying the / operator.

fn div(self, rhs: &T) -> Self::Output

Performs the / operation.

impl<'_, '_, T: ?Sized> Div<&'_ mut T> for &'_ mut PathDSL where
    T: AsRef<Path>, 

type Output = PathDSL

The resulting type after applying the / operator.

fn div(self, rhs: &mut T) -> Self::Output

Performs the / operation.

impl<'_> Div<OsString> for &'_ mut PathDSL

type Output = PathDSL

The resulting type after applying the / operator.

fn div(self, rhs: OsString) -> Self::Output

Performs the / operation.

impl<'_> Div<String> for &'_ mut PathDSL

type Output = PathDSL

The resulting type after applying the / operator.

fn div(self, rhs: String) -> Self::Output

Performs the / operation.

impl<'_> Div<PathBuf> for &'_ mut PathDSL

type Output = PathDSL

The resulting type after applying the / operator.

fn div(self, rhs: PathBuf) -> Self::Output

Performs the / operation.

impl<'_> Div<Box<Path>> for &'_ mut PathDSL

type Output = PathDSL

The resulting type after applying the / operator.

fn div(self, rhs: Box<Path>) -> Self::Output

Performs the / operation.

impl<'_, '_> Div<Cow<'_, Path>> for &'_ mut PathDSL

type Output = PathDSL

The resulting type after applying the / operator.

fn div(self, rhs: Cow<Path>) -> Self::Output

Performs the / operation.

impl<'_, '_> Div<Cow<'_, OsStr>> for &'_ mut PathDSL

type Output = PathDSL

The resulting type after applying the / operator.

fn div(self, rhs: Cow<OsStr>) -> Self::Output

Performs the / operation.

impl Hash for PathDSL

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl FromStr for PathDSL

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 Borrow<Path> for PathDSL

fn borrow(&self) -> &Path

Immutably borrows from an owned value.