Struct typed_path::PathBuf

pub struct PathBuf<T> where
    T: for<'enc> Encoding<'enc>, { /* private fields */ }

An owned, mutable path that mirrors std::path::PathBuf, but operatings using an Encoding to determine how to parse the underlying bytes.

This type provides methods like push and set_extension 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.

Examples

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

use typed_path::{PathBuf, WindowsEncoding};

// NOTE: A pathbuf cannot be created on its own without a defined encoding
let mut path = PathBuf::<WindowsEncoding>::new();

path.push(r"C:\");
path.push("windows");
path.push("system32");

path.set_extension("dll");

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

use typed_path::{PathBuf, WindowsEncoding};

let path: PathBuf<WindowsEncoding> = [r"C:\", "windows", "system32.dll"].iter().collect();

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

use typed_path::{PathBuf, WindowsEncoding};

let path = PathBuf::<WindowsEncoding>::from(br"C:\windows\system32.dll");

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

Implementations

impl<T> PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

pub fn new() -> Self

Allocates an empty PathBuf.

Examples

use typed_path::{PathBuf, UnixEncoding};

// NOTE: A pathbuf cannot be created on its own without a defined encoding
let path = PathBuf::<UnixEncoding>::new();

pub fn with_capacity(capacity: usize) -> Self

Creates a new PathBuf with a given capacity used to create the internal Vec<u8>. See with_capacity defined on Vec.

Examples

use typed_path::{PathBuf, UnixEncoding};

// NOTE: A pathbuf cannot be created on its own without a defined encoding
let mut path = PathBuf::<UnixEncoding>::with_capacity(10);
let capacity = path.capacity();

// This push is done without reallocating
path.push(r"C:\");

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

pub fn as_path(&self) -> &Path<T>

Coerces to a Path slice.

Examples

use typed_path::{Path, PathBuf, UnixEncoding};

// NOTE: A pathbuf cannot be created on its own without a defined encoding
let p = PathBuf::<UnixEncoding>::from("/test");
assert_eq!(Path::new("/test"), p.as_path());

pub fn push<P: AsRef<Path<T>>>(&mut self, path: P)

Extends self with path.

If path is absolute, it replaces the current path.

With WindowsPathBuf:

• 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.
• if self has a verbatim prefix (e.g. \\?\C:\windows) and path is not empty, the new path is normalized: all references to . and .. are removed.

Examples

Pushing a relative path extends the existing path:

use typed_path::{PathBuf, UnixEncoding};

// NOTE: A pathbuf cannot be created on its own without a defined encoding
let mut path = PathBuf::<UnixEncoding>::from("/tmp");
path.push("file.bk");
assert_eq!(path, PathBuf::from("/tmp/file.bk"));

Pushing an absolute path replaces the existing path:

use typed_path::{PathBuf, UnixEncoding};

// NOTE: A pathbuf cannot be created on its own without a defined encoding
let mut path = PathBuf::<UnixEncoding>::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 typed_path::{Path, PathBuf, UnixEncoding};

// NOTE: A pathbuf cannot be created on its own without a defined encoding
let mut p = PathBuf::<UnixEncoding>::from("/spirited/away.rs");

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

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

use typed_path::{PathBuf, UnixEncoding};

// NOTE: A pathbuf cannot be created on its own without a defined encoding
let mut buf = PathBuf::<UnixEncoding>::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: AsRef<[u8]>>(&mut self, extension: S) -> bool

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 typed_path::{Path, PathBuf, UnixEncoding};

let mut p = PathBuf::<UnixEncoding>::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 into_vec(self) -> Vec<u8>

Consumes the PathBuf, yielding its internal Vec<u8> storage.

Examples

use typed_path::{PathBuf, UnixEncoding};

let p = PathBuf::<UnixEncoding>::from("/the/head");
let vec = p.into_vec();

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

Converts this PathBuf into a boxed Path.

pub fn capacity(&self) -> usize

Invokes capacity on the underlying instance of Vec.

pub fn clear(&mut self)

Invokes clear on the underlying instance of Vec.

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

Invokes reserve on the underlying instance of Vec.

pub fn try_reserve(&mut self, additional: usize) -> Result<(), TryReserveError>

Invokes try_reserve on the underlying instance of Vec.

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

Invokes reserve_exact on the underlying instance of Vec.

pub fn try_reserve_exact(
    &mut self,
    additional: usize
) -> Result<(), TryReserveError>

Invokes try_reserve_exact on the underlying instance of Vec.

pub fn shrink_to_fit(&mut self)

Invokes shrink_to_fit on the underlying instance of Vec.

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

Invokes shrink_to on the underlying instance of Vec.

Methods from Deref<Target = Path<T>>

pub fn as_bytes(&self) -> &[u8]

Yields the underlying [[u8]] slice.

Examples

use typed_path::{Path, UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
let bytes = Path::<UnixEncoding>::new("foo.txt").as_bytes();
assert_eq!(bytes, b"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

use typed_path::{Path, UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
let path = Path::<UnixEncoding>::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:

use typed_path::{Path, UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
let path = Path::<UnixEncoding>::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<T>

Converts a Path to an owned PathBuf.

Examples

use typed_path::{Path, PathBuf, UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
let path_buf = Path::<UnixEncoding>::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.

• On Unix (UnixPath]), a path is absolute if it starts with the root, so is_absolute and has_root are equivalent.

• On Windows (WindowsPath), a path is absolute if it has a prefix and starts with the root: c:\windows is absolute, while c:temp and \temp are not.

Examples

use typed_path::{Path, UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
assert!(!Path::<UnixEncoding>::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

use typed_path::{Path, UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
assert!(Path::<UnixEncoding>::new("foo.txt").is_relative());

pub fn has_root(&self) -> bool

Returns true if the Path has a root.

• On Unix (UnixPath), a path has a root if it begins with /.

• On Windows (WindowsPath), a path has a root if it:

  • has no prefix and begins with a separator, e.g., \windows
  • has a prefix followed by a separator, e.g., c:\windows but not c:windows
  • has any non-disk prefix, e.g., \\server\share

Examples

use typed_path::{Path, UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
assert!(Path::<UnixEncoding>::new("/etc/passwd").has_root());

pub fn parent(&self) -> Option<&Self>

Returns the Path without its final component, if there is one.

Returns None if the path terminates in a root or prefix.

Examples

use typed_path::{Path, UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
let path = Path::<UnixEncoding>::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<'_, T>

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

use typed_path::{Path, UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
let mut ancestors = Path::<UnixEncoding>::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);

// NOTE: A path cannot be created on its own without a defined encoding
let mut ancestors = Path::<UnixEncoding>::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(), Some(Path::new("")));
assert_eq!(ancestors.next(), None);

pub fn file_name(&self) -> Option<&[u8]>

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

use typed_path::{Path, UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
assert_eq!(Some(b"bin".as_slice()), Path::<UnixEncoding>::new("/usr/bin/").file_name());
assert_eq!(Some(b"foo.txt".as_slice()), Path::<UnixEncoding>::new("tmp/foo.txt").file_name());
assert_eq!(Some(b"foo.txt".as_slice()), Path::<UnixEncoding>::new("foo.txt/.").file_name());
assert_eq!(Some(b"foo.txt".as_slice()), Path::<UnixEncoding>::new("foo.txt/.//").file_name());
assert_eq!(None, Path::<UnixEncoding>::new("foo.txt/..").file_name());
assert_eq!(None, Path::<UnixEncoding>::new("/").file_name());

pub fn strip_prefix<P>(&self, base: P) -> Result<&Path<T>, StripPrefixError> where
    P: AsRef<Path<T>>, 

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

use typed_path::{Path, PathBuf, UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
let path = Path::<UnixEncoding>::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!(path.strip_prefix("test").is_err());
assert!(path.strip_prefix("/haha").is_err());

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

pub fn starts_with<P>(&self, base: P) -> bool where
    P: AsRef<Path<T>>, 

Determines whether base is a prefix of self.

Only considers whole path components to match.

Examples

use typed_path::{Path, UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
let path = Path::<UnixEncoding>::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/")); // extra slash is okay
assert!(path.starts_with("/etc/passwd///")); // multiple extra slashes are okay

assert!(!path.starts_with("/e"));
assert!(!path.starts_with("/etc/passwd.txt"));

assert!(!Path::<UnixEncoding>::new("/etc/foo.rs").starts_with("/etc/foo"));

pub fn ends_with<P>(&self, child: P) -> bool where
    P: AsRef<Path<T>>, 

Determines whether child is a suffix of self.

Only considers whole path components to match.

Examples

use typed_path::{Path, UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
let path = Path::<UnixEncoding>::new("/etc/resolv.conf");

assert!(path.ends_with("resolv.conf"));
assert!(path.ends_with("etc/resolv.conf"));
assert!(path.ends_with("/etc/resolv.conf"));

assert!(!path.ends_with("/resolv.conf"));
assert!(!path.ends_with("conf")); // use .extension() instead

pub fn file_stem(&self) -> Option<&[u8]>

Extracts the stem (non-extension) portion of self.file_name.

The stem is:

• None, if there is no file name;
• The entire file name if there is no embedded .;
• The entire file name if the file name begins with . and has no other .s within;
• Otherwise, the portion of the file name before the final .

Examples

use typed_path::{Path, UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
assert_eq!(b"foo", Path::<UnixEncoding>::new("foo.rs").file_stem().unwrap());
assert_eq!(b"foo.tar", Path::<UnixEncoding>::new("foo.tar.gz").file_stem().unwrap());

pub fn extension(&self) -> Option<&[u8]>

Extracts the extension of self.file_name, if possible.

The extension is:

• None, if there is no file name;
• None, if there is no embedded .;
• None, if the file name begins with . and has no other .s within;
• Otherwise, the portion of the file name after the final .

Examples

use typed_path::{Path, UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
assert_eq!(b"rs", Path::<UnixEncoding>::new("foo.rs").extension().unwrap());
assert_eq!(b"gz", Path::<UnixEncoding>::new("foo.tar.gz").extension().unwrap());

pub fn join<P: AsRef<Path<T>>>(&self, path: P) -> PathBuf<T>

Creates an owned PathBuf with path adjoined to self.

See PathBuf::push for more details on what it means to adjoin a path.

Examples

use typed_path::{Path, PathBuf, UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
assert_eq!(
    Path::<UnixEncoding>::new("/etc").join("passwd"),
    PathBuf::from("/etc/passwd"),
);

pub fn with_file_name<S: AsRef<[u8]>>(&self, file_name: S) -> PathBuf<T>

Creates an owned PathBuf like self but with the given file name.

See PathBuf::set_file_name for more details.

Examples

use typed_path::{Path, PathBuf, UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
let path = Path::<UnixEncoding>::new("/tmp/foo.txt");
assert_eq!(path.with_file_name("bar.txt"), PathBuf::from("/tmp/bar.txt"));

// NOTE: A path cannot be created on its own without a defined encoding
let path = Path::<UnixEncoding>::new("/tmp");
assert_eq!(path.with_file_name("var"), PathBuf::from("/var"));

pub fn with_extension<S: AsRef<[u8]>>(&self, extension: S) -> PathBuf<T>

Creates an owned PathBuf like self but with the given extension.

See PathBuf::set_extension for more details.

Examples

use typed_path::{Path, PathBuf, UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
let path = Path::<UnixEncoding>::new("foo.rs");
assert_eq!(path.with_extension("txt"), PathBuf::from("foo.txt"));

// NOTE: A path cannot be created on its own without a defined encoding
let path = Path::<UnixEncoding>::new("foo.tar.gz");
assert_eq!(path.with_extension(""), PathBuf::from("foo.tar"));
assert_eq!(path.with_extension("xz"), PathBuf::from("foo.tar.xz"));
assert_eq!(path.with_extension("").with_extension("txt"), PathBuf::from("foo.txt"));

pub fn components(&self) -> <T as Encoding<'_>>::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 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

use typed_path::{Path, UnixEncoding, unix::UnixComponent};

// NOTE: A path cannot be created on its own without a defined encoding
let mut components = Path::<UnixEncoding>::new("/tmp/foo.txt").components();

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

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

Produces an iterator over the path’s components viewed as [[u8]] slices.

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

Examples

use typed_path::{Path, UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
let mut it = Path::<UnixEncoding>::new("/tmp/foo.txt").iter();

assert_eq!(it.next(), Some(typed_path::unix::SEPARATOR_STR.as_bytes()));
assert_eq!(it.next(), Some(b"tmp".as_slice()));
assert_eq!(it.next(), Some(b"foo.txt".as_slice()));
assert_eq!(it.next(), None)

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

Returns an object that implements Display for safely printing paths that may contain non-Unicode data. This may perform lossy conversion, depending on the platform. If you would like an implementation which escapes the path please use Debug instead.

Examples

use typed_path::{Path, UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
let path = Path::<UnixEncoding>::new("/tmp/foo.rs");

println!("{}", path.display());

Trait Implementations

impl<T> AsRef<[u8]> for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

fn as_ref(&self) -> &[u8]

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

impl<T> AsRef<OsStr> for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

fn as_ref(&self) -> &OsStr

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

impl<T> AsRef<Path<T>> for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

fn as_ref(&self) -> &Path<T>

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

impl<T> Borrow<Path<T>> for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

fn borrow(&self) -> &Path<T>

Immutably borrows from an owned value.

impl<T: Clone> Clone for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

fn clone(&self) -> PathBuf<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

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

Formats the value using the given formatter.

impl<T> Default for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

fn default() -> PathBuf<T>

Returns the “default value” for a type.

impl<T> Deref for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

type Target = Path<T>

The resulting type after dereferencing.

fn deref(&self) -> &Path<T>

Dereferences the value.

impl<T, P> Extend<P> for PathBuf<T> where
    T: for<'enc> Encoding<'enc>,
    P: AsRef<Path<T>>, 

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, T> From<&'a PathBuf<T>> for Cow<'a, Path<T>> where
    T: for<'enc> Encoding<'enc>, 

fn from(p: &'a PathBuf<T>) -> Self

Creates a clone-on-write pointer from a reference to PathBuf.

This conversion does not clone or allocate.

impl<T, V> From<&V> for PathBuf<T> where
    T: for<'enc> Encoding<'enc>,
    V: ?Sized + AsRef<[u8]>, 

fn from(s: &V) -> Self

Converts a borrowed [[u8]] to a PathBuf.

Allocates a PathBuf and copies the data into it.

impl<T> From<Box<Path<T>, Global>> for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

fn from(boxed: Box<Path<T>>) -> Self

Converts to this type from the input type.

impl<'a, T> From<Cow<'a, Path<T>>> for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

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

Converts a clone-on-write pointer to an owned path.

Converting from a Cow::Owned does not clone or allocate.

impl<T> From<PathBuf<T>> for Arc<Path<T>> where
    T: for<'enc> Encoding<'enc>, 

fn from(path_buf: PathBuf<T>) -> Self

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

impl<T> From<PathBuf<T>> for Box<Path<T>> where
    T: for<'enc> Encoding<'enc>, 

fn from(p: PathBuf<T>) -> Box<Path<T>>

Converts a PathBuf into a Box<Path>.

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

impl<'a, T> From<PathBuf<T>> for Cow<'a, Path<T>> where
    T: for<'enc> Encoding<'enc>, 

fn from(s: PathBuf<T>) -> Self

Creates a clone-on-write pointer from an owned instance of PathBuf.

This conversion does not clone or allocate.

impl<T> From<PathBuf<T>> for OsString where
    T: for<'enc> Encoding<'enc>, 

fn from(path_buf: PathBuf<T>) -> Self

Converts to this type from the input type.

impl<T> From<PathBuf<T>> for Rc<Path<T>> where
    T: for<'enc> Encoding<'enc>, 

fn from(path_buf: PathBuf<T>) -> Self

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

impl<T> From<PathBuf<T>> for Vec<u8> where
    T: for<'enc> Encoding<'enc>, 

fn from(path_buf: PathBuf<T>) -> Self

Converts a PathBuf into a Vec<u8>

This conversion does not allocate or copy memory.

impl<T> From<String> for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

fn from(s: String) -> Self

Converts a String into a PathBuf

This conversion does not allocate or copy memory.

impl<T> From<Vec<u8, Global>> for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

fn from(inner: Vec<u8>) -> Self

Converts a Vec<u8> into a PathBuf

This conversion does not allocate or copy memory.

impl<T, P> FromIterator<P> for PathBuf<T> where
    T: for<'enc> Encoding<'enc>,
    P: AsRef<Path<T>>, 

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

Creates a value from an iterator.

impl<T> FromStr for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

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<T> Hash for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

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, 

Feeds a slice of this type into the given Hasher.

impl<'a, T> IntoIterator for &'a PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

type Item = &'a [u8]

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> Ord for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

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 where
    Self: PartialOrd<Self>, 

Restrict a value to a certain interval.

impl<'a, T> PartialEq<&'a [u8]> for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

fn eq(&self, other: &&'a [u8]) -> 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, T> PartialEq<&'a Path<T>> for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

fn eq(&self, other: &&'a Path<T>) -> 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<T> PartialEq<[u8]> for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

fn eq(&self, other: &[u8]) -> 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, T> PartialEq<Cow<'a, [u8]>> for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

fn eq(&self, other: &Cow<'a, [u8]>) -> 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, T> PartialEq<Cow<'a, Path<T>>> for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

fn eq(&self, other: &Cow<'a, Path<T>>) -> 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<T> PartialEq<Path<T>> for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

fn eq(&self, other: &Path<T>) -> 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, T> PartialEq<PathBuf<T>> for &'a [u8] where
    T: for<'enc> Encoding<'enc>, 

fn eq(&self, other: &PathBuf<T>) -> 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, T> PartialEq<PathBuf<T>> for &'a Path<T> where
    T: for<'enc> Encoding<'enc>, 

fn eq(&self, other: &PathBuf<T>) -> 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<T> PartialEq<PathBuf<T>> for [u8] where
    T: for<'enc> Encoding<'enc>, 

fn eq(&self, other: &PathBuf<T>) -> 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, T> PartialEq<PathBuf<T>> for Cow<'a, [u8]> where
    T: for<'enc> Encoding<'enc>, 

fn eq(&self, other: &PathBuf<T>) -> 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, T> PartialEq<PathBuf<T>> for Cow<'a, Path<T>> where
    T: for<'enc> Encoding<'enc>, 

fn eq(&self, other: &PathBuf<T>) -> 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<T> PartialEq<PathBuf<T>> for Path<T> where
    T: for<'enc> Encoding<'enc>, 

fn eq(&self, other: &PathBuf<T>) -> 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<T> PartialEq<PathBuf<T>> for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

fn eq(&self, other: &Self) -> 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<T> PartialEq<PathBuf<T>> for Vec<u8> where
    T: for<'enc> Encoding<'enc>, 

fn eq(&self, other: &PathBuf<T>) -> 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<T> PartialEq<Vec<u8, Global>> for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

fn eq(&self, other: &Vec<u8>) -> 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, T> PartialOrd<&'a [u8]> for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

fn partial_cmp(&self, other: &&'a [u8]) -> 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, T> PartialOrd<&'a Path<T>> for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

fn partial_cmp(&self, other: &&'a Path<T>) -> 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<T> PartialOrd<[u8]> for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

fn partial_cmp(&self, other: &[u8]) -> 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, T> PartialOrd<Cow<'a, [u8]>> for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

fn partial_cmp(&self, other: &Cow<'a, [u8]>) -> 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, T> PartialOrd<Cow<'a, Path<T>>> for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

fn partial_cmp(&self, other: &Cow<'a, Path<T>>) -> 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<T> PartialOrd<Path<T>> for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

fn partial_cmp(&self, other: &Path<T>) -> 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, T> PartialOrd<PathBuf<T>> for &'a [u8] where
    T: for<'enc> Encoding<'enc>, 

fn partial_cmp(&self, other: &PathBuf<T>) -> 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, T> PartialOrd<PathBuf<T>> for &'a Path<T> where
    T: for<'enc> Encoding<'enc>, 

fn partial_cmp(&self, other: &PathBuf<T>) -> 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<T> PartialOrd<PathBuf<T>> for [u8] where
    T: for<'enc> Encoding<'enc>, 

fn partial_cmp(&self, other: &PathBuf<T>) -> 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, T> PartialOrd<PathBuf<T>> for Cow<'a, [u8]> where
    T: for<'enc> Encoding<'enc>, 

fn partial_cmp(&self, other: &PathBuf<T>) -> 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, T> PartialOrd<PathBuf<T>> for Cow<'a, Path<T>> where
    T: for<'enc> Encoding<'enc>, 

fn partial_cmp(&self, other: &PathBuf<T>) -> 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<T> PartialOrd<PathBuf<T>> for Path<T> where
    T: for<'enc> Encoding<'enc>, 

fn partial_cmp(&self, other: &PathBuf<T>) -> 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<T> PartialOrd<PathBuf<T>> for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

fn partial_cmp(&self, other: &Self) -> 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<T> PartialOrd<PathBuf<T>> for Vec<u8> where
    T: for<'enc> Encoding<'enc>, 

fn partial_cmp(&self, other: &PathBuf<T>) -> 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<T> PartialOrd<Vec<u8, Global>> for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

fn partial_cmp(&self, other: &Vec<u8>) -> 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<T> TryFrom<PathBuf<T>> for StdPathBuf where
    T: for<'enc> Encoding<'enc>, 

fn try_from(path: PathBuf<T>) -> Result<Self, Self::Error>

Attempts to convert a PathBuf into a std::path::PathBuf, returning a result containing the new path when successful or the original path when failed

Examples

use std::convert::TryFrom;
use std::path::PathBuf;
use typed_path::UnixPathBuf;

let unix_path_buf = UnixPathBuf::from("/path/to/file.txt");
let std_path_buf: PathBuf = TryFrom::try_from(unix_path_buf).unwrap();

type Error = PathBuf<T>

The type returned in the event of a conversion error.

impl<T> TryFrom<PathBuf> for PathBuf<T> where
    T: for<'enc> Encoding<'enc>, 

fn try_from(path: StdPathBuf) -> Result<Self, Self::Error>

Attempts to convert a std::path::PathBuf into a PathBuf, returning a result containing the new path when successful or the original path when failed

Examples

use std::convert::TryFrom;
use std::path::PathBuf;
use typed_path::UnixPathBuf;

let std_path_buf = PathBuf::from("/path/to/file.txt");
let unix_path_buf: UnixPathBuf = TryFrom::try_from(std_path_buf).unwrap();

type Error = PathBuf

The type returned in the event of a conversion error.

impl<T> Eq for PathBuf<T> where
    T: for<'enc> Encoding<'enc>,