Struct NormpathBuf 

pub struct NormpathBuf(/* private fields */);

An owned normalized path that is mutable (akin to PathBuf).

This type provides methods like push that mutate the path in place, while maintaining the normalization invariants. It also implements Deref to Normpath, meaning that all methods on Normpath slices are available as well.

Details about the normalization invariants can be found in the crate documentation.

Implementations

impl NormpathBuf

pub fn root() -> Self

Available on Unix only.

Creates a new NormpathBuf from the root path /.

pub fn validate<P>(path: P) -> Result<Self, ConvertError<P>>

where P: AsRef<OsStr> + Into<OsString>,

Validates that path is normalized to create a NormpathBuf from it.

This function is an owned version of Normpath::validate. Refer to it for more details.

Errors

If path is not normalized, returns an ConvertError containing the original path instance unchanged.

Examples

use normal_path::{NormpathBuf, Error};

let norm = "/foo/bar";
let path1 = "foo/bar";
let path2 = "/foo/bar/";
let path3 = "/foo/../bar";

assert!(NormpathBuf::validate(norm).is_ok());

let e1 = NormpathBuf::validate(path1).unwrap_err();
assert_eq!((e1.error, e1.value), (Error::NotAbsolute, path1));
let e2 = NormpathBuf::validate(path2).unwrap_err();
assert_eq!((e2.error, e2.value), (Error::NotCanonical, path2));
let e3 = NormpathBuf::validate(path3).unwrap_err();
assert_eq!((e3.error, e3.value), (Error::ContainsParent, path3));

pub fn normalize(path: PathBuf) -> Result<Self, ConvertError<PathBuf>>

Validates that path is normalized to create a NormpathBuf from it while trying to normalize non-canonical patterns.

This function will mutate the input path to normalize every non-canonical pattern found, even with the presence of other errors.

Caveats

This function mutates the input path regardless of the result. Use Normpath::normalize or the corresponding TryFrom implementation if mutation is not desired.

Errors

If path is not absolute or contains parent components that cannot be normalized away, returns an ConvertError containing the path, with all non-canonicality removed. This implies NotCanonical will never be returned.

Examples

use std::path::PathBuf;
use normal_path::{Error, NormpathBuf};

let path1 = PathBuf::from("//foo/./bar/");
let norm1 = NormpathBuf::normalize(path1).unwrap();
assert_eq!(&norm1, "/foo/bar");

let path2 = PathBuf::from(".//foo/../bar/");
let err2 = NormpathBuf::normalize(path2).unwrap_err();
assert_eq!(&err2.value, "foo/../bar");

The results are different on Windows:

use std::path::PathBuf;
use normal_path::{Error, NormpathBuf};

let path1 = PathBuf::from(r"C:\foo/.\bar\");
let norm1 = NormpathBuf::normalize(path1).unwrap();
assert_eq!(&norm1, r"C:\foo\bar");

let path2 = PathBuf::from(r"./\foo\../bar\..");
let err2 = NormpathBuf::normalize(path2).unwrap_err();
assert_eq!(&err2.value, "");

pub unsafe fn new_unchecked<S: Into<OsString>>(path: S) -> Self

Creates a NormpathBuf from path without any validation.

Safety

path must be a normalized path, such that validate would succeed.

Examples

use normal_path::NormpathBuf;

let path = "/foo/bar";
assert!(NormpathBuf::validate(path).is_ok());

// SAFETY: already validated
let norm = unsafe { NormpathBuf::new_unchecked(path) };

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

Extends self with path, with normalization.

See PathBuf::push for more details on how self is extended with path.

Consider using Normpath::checked_join if you need a new NormpathBuf instead of using this function on a cloned NormpathBuf.

Errors

If the resulting path cannot be normalized, returns an Error. This implies NotCanonical will never be returned.

pub fn pop(&mut self) -> bool

Truncates self to self.parent.

Returns false and does nothing if self.parent is None.

pub fn as_normpath(&self) -> &Normpath

Coerces to a Normpath slice.

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

Converts the NormpathBuf into a boxed Normpath.

pub fn into_path_buf(self) -> PathBuf

Consumes the NormpathBuf, yielding the underlying PathBuf instance.

pub fn into_os_string(self) -> OsString

Consumes the NormpathBuf, yielding its internal OsString storage.

pub fn capacity(&self) -> usize

Invokes capacity on the internal OsString storage.

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

Invokes reserve on the internal OsString storage.

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

Invokes reserve_exact on the internal OsString storage.

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

Invokes try_reserve on the internal OsString storage.

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

Invokes try_reserve_exact on the internal OsString storage.

pub fn shrink_to_fit(&mut self)

Invokes shrink_to_fit on the internal OsString storage.

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

Invokes shrink_to on the internal OsString storage.

Methods from Deref<Target = Normpath>

pub fn len(&self) -> usize

Returns the length of self in bytes.

pub fn as_path(&self) -> &Path

Yields the underlying Path slice.

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

Returns the Normpath without the final component, if the path doesn’t end with the root.

This function effectively shadows Path::parent but is entirely compatible in most cases. In case the original method is desired, use self.as_path().parent() to invoke it.

pub fn windows_split_components(&self) -> (PrefixComponent<'_>, Components<'_>)

Available on Windows only.

Splits self.components into the prefix part and the rest.

Examples

use std::path::{Component, Prefix};
use normal_path::Normpath;

let path = Normpath::validate(r"C:\a").unwrap();
let (prefix, mut components) = path.windows_split_components();

assert_eq!(prefix.kind(), Prefix::Disk(b'C'));
assert_eq!(components.next(), Some(Component::RootDir));
assert_eq!(components.next(), Some(Component::Normal("a".as_ref())));
assert_eq!(components.next(), None);

pub fn windows_prefix(&self) -> PrefixComponent<'_>

Available on Windows only.

Returns the prefix component of self.

pub fn split_components(&self) -> Option<(PrefixComponent<'_>, Components<'_>)>

Splits self.components into the prefix part and the rest, if there is a prefix.

This is equivalent to windows_split_components on Windows, while returning None on other platforms.

Examples

use std::path::Component;
use normal_path::Normpath;

let path = if cfg!(windows) { r"C:\a" } else { "/a" };
let norm = Normpath::validate(path).unwrap();

let mut components = match norm.split_components() {
    Some((_, components)) => components,
    None => norm.components(),
};

assert_eq!(components.next(), Some(Component::RootDir));
assert_eq!(components.next(), Some(Component::Normal("a".as_ref())));
assert_eq!(components.next(), None);

pub fn prefix(&self) -> Option<PrefixComponent<'_>>

Returns the prefix component of self, if there is one.

This is equivalent to windows_prefix on Windows, while returning None on other platforms.

pub fn checked_join<P: AsRef<Path>>( &self, path: P, ) -> Result<NormpathBuf, Error>

Creates an owned NormpathBuf with path adjoined to self, with normalization.

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

Errors

If the resulting path cannot be normalized, returns an Error. This implies NotCanonical will never be returned.

pub fn quick_strip_prefix<P: AsRef<Path>>(&self, base: P) -> Option<&Path>

Returns a path that, when joined onto base, yields self.

If base is not a prefix of self, returns None.

Compared to Path::strip_prefix, this function only performs byte-level comparison, skipping the parsing as an optimization.

Examples

use std::path::Path;
use normal_path::Normpath;

let norm = Normpath::validate("/foo/bar/baz").unwrap();
let base1 = Path::new("/foo/bar");
let base2 = Path::new("/foo/./bar");
let base3 = Path::new("/foo/ba");

// strip_prefix parses paths and thus both are accepted
assert!(norm.strip_prefix(base1).is_ok());
assert!(norm.strip_prefix(base2).is_ok());

// But quick_strip_prefix only compares bytes
assert!(norm.quick_strip_prefix(base1).is_some());
assert!(norm.quick_strip_prefix(base2).is_none());

// Both functions are otherwise the same
assert!(norm.strip_prefix(base3).is_err());
assert!(norm.quick_strip_prefix(base3).is_none());

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

Determines whether base is a prefix of self.

Compared to Path::starts_with, this function only performs byte-level comparison, skipping the parsing as an optimization.

Examples

use std::path::Path;
use normal_path::Normpath;

let norm = Normpath::validate("/foo/bar/baz").unwrap();
let base1 = Path::new("/foo/bar");
let base2 = Path::new("/foo/./bar");
let base3 = Path::new("/foo/ba");

// starts_with parses paths and thus both are accepted
assert!(norm.starts_with(base1));
assert!(norm.starts_with(base2));

// But quick_starts_with only compares bytes
assert!(norm.quick_starts_with(base1));
assert!(!norm.quick_starts_with(base2));

// Both functions are otherwise the same
assert!(!norm.starts_with(base3));
assert!(!norm.quick_starts_with(base3));

Methods from Deref<Target = Path>

pub fn as_os_str(&self) -> &OsStr

Yields the underlying OsStr slice.

Examples

use std::path::Path;

let os_str = Path::new("foo.txt").as_os_str();
assert_eq!(os_str, std::ffi::OsStr::new("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 std::path::Path;

let path = Path::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-UTF-8 sequences are replaced with U+FFFD REPLACEMENT CHARACTER.

Examples

Calling to_string_lossy on a Path with valid unicode:

use std::path::Path;

let path = Path::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

Converts a Path to an owned PathBuf.

Examples

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

let path_buf = Path::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, a path is absolute if it starts with the root, so is_absolute and has_root are equivalent.

• On Windows, 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 std::path::Path;

assert!(!Path::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 std::path::Path;

assert!(Path::new("foo.txt").is_relative());

pub fn has_root(&self) -> bool

Returns true if the Path has a root.

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

• On Windows, 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 std::path::Path;

assert!(Path::new("/etc/passwd").has_root());

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

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

This means it returns Some("") for relative paths with one component.

Returns None if the path terminates in a root or prefix, or if it’s the empty string.

Examples

use std::path::Path;

let path = Path::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);

let relative_path = Path::new("foo/bar");
let parent = relative_path.parent();
assert_eq!(parent, Some(Path::new("foo")));
let grand_parent = parent.and_then(Path::parent);
assert_eq!(grand_parent, Some(Path::new("")));
let great_grand_parent = grand_parent.and_then(Path::parent);
assert_eq!(great_grand_parent, None);

pub fn ancestors(&self) -> Ancestors<'_>

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. If the parent method returns None, the iterator will do likewise. The iterator will always yield at least one value, namely Some(&self). Next it will yield &self.parent(), &self.parent().and_then(Path::parent) and so on.

Examples

use std::path::Path;

let mut ancestors = Path::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);

let mut ancestors = Path::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<&OsStr>

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 std::path::Path;
use std::ffi::OsStr;

assert_eq!(Some(OsStr::new("bin")), Path::new("/usr/bin/").file_name());
assert_eq!(Some(OsStr::new("foo.txt")), Path::new("tmp/foo.txt").file_name());
assert_eq!(Some(OsStr::new("foo.txt")), Path::new("foo.txt/.").file_name());
assert_eq!(Some(OsStr::new("foo.txt")), Path::new("foo.txt/.//").file_name());
assert_eq!(None, Path::new("foo.txt/..").file_name());
assert_eq!(None, Path::new("/").file_name());

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

where P: AsRef<Path>,

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 std::path::{Path, PathBuf};

let path = Path::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("/te").is_err());
assert!(path.strip_prefix("/haha").is_err());

let prefix = PathBuf::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>,

Determines whether base is a prefix of self.

Only considers whole path components to match.

Examples

use std::path::Path;

let path = Path::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::new("/etc/foo.rs").starts_with("/etc/foo"));

pub fn ends_with<P>(&self, child: P) -> bool

where P: AsRef<Path>,

Determines whether child is a suffix of self.

Only considers whole path components to match.

Examples

use std::path::Path;

let path = Path::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 is_empty(&self) -> bool

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

Checks whether the Path is empty.

Examples

#![feature(path_is_empty)]
use std::path::Path;

let path = Path::new("");
assert!(path.is_empty());

let path = Path::new("foo");
assert!(!path.is_empty());

let path = Path::new(".");
assert!(!path.is_empty());

pub fn file_stem(&self) -> Option<&OsStr>

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 std::path::Path;

assert_eq!("foo", Path::new("foo.rs").file_stem().unwrap());
assert_eq!("foo.tar", Path::new("foo.tar.gz").file_stem().unwrap());

See Also

This method is similar to Path::file_prefix, which extracts the portion of the file name before the first .

pub fn file_prefix(&self) -> Option<&OsStr>

Extracts the prefix of self.file_name.

The prefix is:

• None, if there is no file name;
• The entire file name if there is no embedded .;
• The portion of the file name before the first non-beginning .;
• The entire file name if the file name begins with . and has no other .s within;
• The portion of the file name before the second . if the file name begins with .

Examples

use std::path::Path;

assert_eq!("foo", Path::new("foo.rs").file_prefix().unwrap());
assert_eq!("foo", Path::new("foo.tar.gz").file_prefix().unwrap());
assert_eq!(".config", Path::new(".config").file_prefix().unwrap());
assert_eq!(".config", Path::new(".config.toml").file_prefix().unwrap());

See Also

This method is similar to Path::file_stem, which extracts the portion of the file name before the last .

pub fn extension(&self) -> Option<&OsStr>

Extracts the extension (without the leading dot) 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 std::path::Path;

assert_eq!("rs", Path::new("foo.rs").extension().unwrap());
assert_eq!("gz", Path::new("foo.tar.gz").extension().unwrap());

pub fn has_trailing_sep(&self) -> bool

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

Checks whether the path ends in a trailing separator.

This is generally done to ensure that a path is treated as a directory, not a file, although it does not actually guarantee that such a path is a directory on the underlying file system.

Despite this behavior, two paths are still considered the same in Rust whether they have a trailing separator or not.

Examples

#![feature(path_trailing_sep)]
use std::path::Path;

assert!(Path::new("dir/").has_trailing_sep());
assert!(!Path::new("file.rs").has_trailing_sep());

pub fn with_trailing_sep(&self) -> Cow<'_, Path>

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

Ensures that a path has a trailing separator, allocating a PathBuf if necessary.

The resulting path will return true for has_trailing_sep.

Examples

#![feature(path_trailing_sep)]
use std::ffi::OsStr;
use std::path::Path;

assert_eq!(Path::new("dir//").with_trailing_sep().as_os_str(), OsStr::new("dir//"));
assert_eq!(Path::new("dir/").with_trailing_sep().as_os_str(), OsStr::new("dir/"));
assert!(!Path::new("dir").has_trailing_sep());
assert!(Path::new("dir").with_trailing_sep().has_trailing_sep());

pub fn trim_trailing_sep(&self) -> &Path

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

Trims a trailing separator from a path, if possible.

The resulting path will return false for has_trailing_sep for most paths.

Some paths, like /, cannot be trimmed in this way.

Examples

#![feature(path_trailing_sep)]
use std::ffi::OsStr;
use std::path::Path;

assert_eq!(Path::new("dir//").trim_trailing_sep().as_os_str(), OsStr::new("dir"));
assert_eq!(Path::new("dir/").trim_trailing_sep().as_os_str(), OsStr::new("dir"));
assert_eq!(Path::new("dir").trim_trailing_sep().as_os_str(), OsStr::new("dir"));
assert_eq!(Path::new("/").trim_trailing_sep().as_os_str(), OsStr::new("/"));
assert_eq!(Path::new("//").trim_trailing_sep().as_os_str(), OsStr::new("//"));

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

where P: AsRef<Path>,

Creates an owned PathBuf with path adjoined to self.

If path is absolute, it replaces the current path.

On Windows:

• if path has a root but no prefix (e.g., \windows), it replaces and returns everything except for the prefix (if any) of self.
• if path has a prefix but no root, self is ignored and path is returned.
• 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.

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

Examples

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

assert_eq!(Path::new("/etc").join("passwd"), PathBuf::from("/etc/passwd"));
assert_eq!(Path::new("/etc").join("/bin/sh"), PathBuf::from("/bin/sh"));

pub fn with_file_name<S>(&self, file_name: S) -> PathBuf

where S: AsRef<OsStr>,

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

See PathBuf::set_file_name for more details.

Examples

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

let path = Path::new("/tmp/foo.png");
assert_eq!(path.with_file_name("bar"), PathBuf::from("/tmp/bar"));
assert_eq!(path.with_file_name("bar.txt"), PathBuf::from("/tmp/bar.txt"));

let path = Path::new("/tmp");
assert_eq!(path.with_file_name("var"), PathBuf::from("/var"));

pub fn with_extension<S>(&self, extension: S) -> PathBuf

where S: AsRef<OsStr>,

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

See PathBuf::set_extension for more details.

Examples

use std::path::Path;

let path = Path::new("foo.rs");
assert_eq!(path.with_extension("txt"), Path::new("foo.txt"));
assert_eq!(path.with_extension(""), Path::new("foo"));

Handling multiple extensions:

use std::path::Path;

let path = Path::new("foo.tar.gz");
assert_eq!(path.with_extension("xz"), Path::new("foo.tar.xz"));
assert_eq!(path.with_extension("").with_extension("txt"), Path::new("foo.txt"));

Adding an extension where one did not exist:

use std::path::Path;

let path = Path::new("foo");
assert_eq!(path.with_extension("rs"), Path::new("foo.rs"));

pub fn with_added_extension<S>(&self, extension: S) -> PathBuf

where S: AsRef<OsStr>,

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

See PathBuf::add_extension for more details.

Examples

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

let path = Path::new("foo.rs");
assert_eq!(path.with_added_extension("txt"), PathBuf::from("foo.rs.txt"));

let path = Path::new("foo.tar.gz");
assert_eq!(path.with_added_extension(""), PathBuf::from("foo.tar.gz"));
assert_eq!(path.with_added_extension("xz"), PathBuf::from("foo.tar.gz.xz"));
assert_eq!(path.with_added_extension("").with_added_extension("txt"), PathBuf::from("foo.tar.gz.txt"));

pub fn components(&self) -> 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.

• Trailing separators are normalized away, so /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 std::path::{Path, Component};
use std::ffi::OsStr;

let mut components = Path::new("/tmp/foo.txt").components();

assert_eq!(components.next(), Some(Component::RootDir));
assert_eq!(components.next(), Some(Component::Normal(OsStr::new("tmp"))));
assert_eq!(components.next(), Some(Component::Normal(OsStr::new("foo.txt"))));
assert_eq!(components.next(), None)

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

Produces an iterator over the path’s components viewed as OsStr slices.

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

Examples

use std::path::{self, Path};
use std::ffi::OsStr;

let mut it = Path::new("/tmp/foo.txt").iter();
assert_eq!(it.next(), Some(OsStr::new(&path::MAIN_SEPARATOR.to_string())));
assert_eq!(it.next(), Some(OsStr::new("tmp")));
assert_eq!(it.next(), Some(OsStr::new("foo.txt")));
assert_eq!(it.next(), None)

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

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 std::path::Path;

let path = Path::new("/tmp/foo.rs");

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

pub fn as_path(&self) -> &Path

Returns the same path as &Path.

This method is redundant when used directly on &Path, but it helps dereferencing other PathBuf-like types to Paths, for example references to Box<Path> or Arc<Path>.

pub fn metadata(&self) -> Result<Metadata, Error>

Queries the file system to get information about a file, directory, etc.

This function will traverse symbolic links to query information about the destination file.

This is an alias to fs::metadata.

Examples

use std::path::Path;

let path = Path::new("/Minas/tirith");
let metadata = path.metadata().expect("metadata call failed");
println!("{:?}", metadata.file_type());

pub fn symlink_metadata(&self) -> Result<Metadata, Error>

Queries the metadata about a file without following symlinks.

This is an alias to fs::symlink_metadata.

Examples

use std::path::Path;

let path = Path::new("/Minas/tirith");
let metadata = path.symlink_metadata().expect("symlink_metadata call failed");
println!("{:?}", metadata.file_type());

pub fn canonicalize(&self) -> Result<PathBuf, Error>

Returns the canonical, absolute form of the path with all intermediate components normalized and symbolic links resolved.

This is an alias to fs::canonicalize.

Errors

This method will return an error in the following situations, but is not limited to just these cases:

• path does not exist.
• A non-final component in path is not a directory.

Examples

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

let path = Path::new("/foo/test/../test/bar.rs");
assert_eq!(path.canonicalize().unwrap(), PathBuf::from("/foo/test/bar.rs"));

pub fn normalize_lexically(&self) -> Result<PathBuf, NormalizeError>

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

Normalize a path, including .. without traversing the filesystem.

Returns an error if normalization would leave leading .. components.

This function always resolves .. to the “lexical” parent. That is “a/b/../c” will always resolve to a/c which can change the meaning of the path. In particular, a/c and a/b/../c are distinct on many systems because b may be a symbolic link, so its parent isn’t a.

path::absolute is an alternative that preserves ... Or Path::canonicalize can be used to resolve any .. by querying the filesystem.

pub fn read_link(&self) -> Result<PathBuf, Error>

Reads a symbolic link, returning the file that the link points to.

This is an alias to fs::read_link.

Examples

use std::path::Path;

let path = Path::new("/laputa/sky_castle.rs");
let path_link = path.read_link().expect("read_link call failed");

pub fn read_dir(&self) -> Result<ReadDir, Error>

Returns an iterator over the entries within a directory.

The iterator will yield instances of io::Result<fs::DirEntry>. New errors may be encountered after an iterator is initially constructed.

This is an alias to fs::read_dir.

Examples

use std::path::Path;

let path = Path::new("/laputa");
for entry in path.read_dir().expect("read_dir call failed") {
    if let Ok(entry) = entry {
        println!("{:?}", entry.path());
    }
}

pub fn exists(&self) -> bool

Returns true if the path points at an existing entity.

Warning: this method may be error-prone, consider using try_exists() instead! It also has a risk of introducing time-of-check to time-of-use (TOCTOU) bugs.

This function will traverse symbolic links to query information about the destination file.

If you cannot access the metadata of the file, e.g. because of a permission error or broken symbolic links, this will return false.

Examples

use std::path::Path;
assert!(!Path::new("does_not_exist.txt").exists());

See Also

This is a convenience function that coerces errors to false. If you want to check errors, call Path::try_exists.

pub fn try_exists(&self) -> Result<bool, Error>

Returns Ok(true) if the path points at an existing entity.

This function will traverse symbolic links to query information about the destination file. In case of broken symbolic links this will return Ok(false).

Path::exists() only checks whether or not a path was both found and readable. By contrast, try_exists will return Ok(true) or Ok(false), respectively, if the path was verified to exist or not exist. If its existence can neither be confirmed nor denied, it will propagate an Err(_) instead. This can be the case if e.g. listing permission is denied on one of the parent directories.

Note that while this avoids some pitfalls of the exists() method, it still can not prevent time-of-check to time-of-use (TOCTOU) bugs. You should only use it in scenarios where those bugs are not an issue.

This is an alias for std::fs::exists.

Examples

use std::path::Path;
assert!(!Path::new("does_not_exist.txt").try_exists().expect("Can't check existence of file does_not_exist.txt"));
assert!(Path::new("/root/secret_file.txt").try_exists().is_err());

pub fn is_file(&self) -> bool

Returns true if the path exists on disk and is pointing at a regular file.

This function will traverse symbolic links to query information about the destination file.

If you cannot access the metadata of the file, e.g. because of a permission error or broken symbolic links, this will return false.

Examples

use std::path::Path;
assert_eq!(Path::new("./is_a_directory/").is_file(), false);
assert_eq!(Path::new("a_file.txt").is_file(), true);

See Also

This is a convenience function that coerces errors to false. If you want to check errors, call fs::metadata and handle its Result. Then call fs::Metadata::is_file if it was Ok.

When the goal is simply to read from (or write to) the source, the most reliable way to test the source can be read (or written to) is to open it. Only using is_file can break workflows like diff <( prog_a ) on a Unix-like system for example. See fs::File::open or fs::OpenOptions::open for more information.

pub fn is_dir(&self) -> bool

Returns true if the path exists on disk and is pointing at a directory.

This function will traverse symbolic links to query information about the destination file.

If you cannot access the metadata of the file, e.g. because of a permission error or broken symbolic links, this will return false.

Examples

use std::path::Path;
assert_eq!(Path::new("./is_a_directory/").is_dir(), true);
assert_eq!(Path::new("a_file.txt").is_dir(), false);

See Also

This is a convenience function that coerces errors to false. If you want to check errors, call fs::metadata and handle its Result. Then call fs::Metadata::is_dir if it was Ok.

pub fn is_symlink(&self) -> bool

Returns true if the path exists on disk and is pointing at a symbolic link.

This function will not traverse symbolic links. In case of a broken symbolic link this will also return true.

If you cannot access the directory containing the file, e.g., because of a permission error, this will return false.

Examples

use std::path::Path;
use std::os::unix::fs::symlink;

let link_path = Path::new("link");
symlink("/origin_does_not_exist/", link_path).unwrap();
assert_eq!(link_path.is_symlink(), true);
assert_eq!(link_path.exists(), false);

See Also

This is a convenience function that coerces errors to false. If you want to check errors, call fs::symlink_metadata and handle its Result. Then call fs::Metadata::is_symlink if it was Ok.

Trait Implementations

impl AsRef<Normpath> for NormpathBuf

fn as_ref(&self) -> &Normpath

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

impl AsRef<OsStr> for NormpathBuf

fn as_ref(&self) -> &OsStr

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

impl AsRef<Path> for NormpathBuf

fn as_ref(&self) -> &Path

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

impl Borrow<Normpath> for NormpathBuf

fn borrow(&self) -> &Normpath

Immutably borrows from an owned value.

impl Borrow<Path> for NormpathBuf

fn borrow(&self) -> &Path

Immutably borrows from an owned value.

impl Clone for NormpathBuf

fn clone(&self) -> NormpathBuf

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NormpathBuf

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

Formats the value using the given formatter.

impl Deref for NormpathBuf

type Target = Normpath

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de> Deserialize<'de> for NormpathBuf

Available on crate feature serde only.

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl From<&Normpath> for NormpathBuf

fn from(value: &Normpath) -> Self

Creates a NormpathBuf from a Normpath slice.

This will allocate and copy the data.

impl<'a> From<&'a NormpathBuf> for Cow<'a, Normpath>

fn from(value: &'a NormpathBuf) -> Self

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

This does not allocate or copy any data.

impl From<&NormpathBuf> for NormpathBuf

fn from(value: &NormpathBuf) -> Self

Clones a NormpathBuf from a reference to NormpathBuf.

impl From<Box<Normpath>> for NormpathBuf

fn from(value: Box<Normpath>) -> Self

Creates a NormpathBuf from a boxed Normpath.

This does not allocate or copy any data.

impl From<Cow<'_, Normpath>> for NormpathBuf

fn from(value: Cow<'_, Normpath>) -> Self

Creates a NormpathBuf from a clone-on-write pointer to Normpath.

Converting from Cow::Owned does not allocate or copy any data.

impl From<NormpathBuf> for Arc<Normpath>

fn from(value: NormpathBuf) -> Self

Creates an Arc pointer from a NormpathBuf.

This will allocate and copy the data.

impl From<NormpathBuf> for Box<Normpath>

fn from(value: NormpathBuf) -> Self

Creates a boxed Normpath from a NormpathBuf.

This can allocate and copy the data depending on the implementation of the standard library, but typically it will not.

impl From<NormpathBuf> for Cow<'_, Normpath>

fn from(value: NormpathBuf) -> Self

Creates a clone-on-write pointer from a NormpathBuf.

This does not allocate or copy any data.

impl From<NormpathBuf> for OsString

fn from(value: NormpathBuf) -> Self

Creates an OsString from a NormpathBuf.

This is a cost-free conversion.

impl From<NormpathBuf> for PathBuf

fn from(value: NormpathBuf) -> Self

Creates a PathBuf from a NormpathBuf.

This is a cost-free conversion.

impl From<NormpathBuf> for Rc<Normpath>

fn from(value: NormpathBuf) -> Self

Creates an Rc pointer from a NormpathBuf.

This will allocate and copy the data.

impl FromStr for NormpathBuf

type Err = ConvertError<String>

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 Hash for NormpathBuf

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for NormpathBuf

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq<&'a OsStr> for NormpathBuf

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialEq<&'a Path> for NormpathBuf

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Normpath> for NormpathBuf

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialEq<NormpathBuf> for &'a OsStr

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialEq<NormpathBuf> for &'a Path

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<NormpathBuf> for Normpath

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<NormpathBuf> for OsStr

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<NormpathBuf> for OsString

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<NormpathBuf> for Path

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<NormpathBuf> for PathBuf

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<NormpathBuf> for String

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<NormpathBuf> for str

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<OsStr> for NormpathBuf

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<OsString> for NormpathBuf

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Path> for NormpathBuf

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<PathBuf> for NormpathBuf

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<String> for NormpathBuf

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<str> for NormpathBuf

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for NormpathBuf

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialOrd<&'a OsStr> for NormpathBuf

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> PartialOrd<&'a Path> for NormpathBuf

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> PartialOrd<Cow<'a, OsStr>> for NormpathBuf

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> PartialOrd<Cow<'a, Path>> for NormpathBuf

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<Normpath> for NormpathBuf

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> PartialOrd<NormpathBuf> for &'a OsStr

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> PartialOrd<NormpathBuf> for &'a Path

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> PartialOrd<NormpathBuf> for Cow<'a, OsStr>

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> PartialOrd<NormpathBuf> for Cow<'a, Path>

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<NormpathBuf> for Normpath

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<NormpathBuf> for OsStr

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<NormpathBuf> for OsString

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<NormpathBuf> for Path

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<NormpathBuf> for PathBuf

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<OsStr> for NormpathBuf

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<OsString> for NormpathBuf

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<Path> for NormpathBuf

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<PathBuf> for NormpathBuf

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd for NormpathBuf

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

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for NormpathBuf

Available on crate feature serde only.

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<&'a OsStr> for NormpathBuf

fn try_from(value: &'a OsStr) -> Result<Self, Self::Error>

Validates that value is normalized to create a NormpathBuf from it.

type Error = ConvertError<&'a OsStr>

The type returned in the event of a conversion error.

impl<'a> TryFrom<&'a OsString> for NormpathBuf

fn try_from(value: &'a OsString) -> Result<Self, Self::Error>

Validates that value is normalized to create a NormpathBuf from it.

type Error = ConvertError<&'a OsString>

The type returned in the event of a conversion error.

impl<'a> TryFrom<&'a Path> for NormpathBuf

fn try_from(value: &'a Path) -> Result<Self, Self::Error>

Validates that value is normalized to create a NormpathBuf from it.

type Error = ConvertError<&'a Path>

The type returned in the event of a conversion error.

impl<'a> TryFrom<&'a PathBuf> for NormpathBuf

fn try_from(value: &'a PathBuf) -> Result<Self, Self::Error>

Validates that value is normalized to create a NormpathBuf from it.

type Error = ConvertError<&'a PathBuf>

The type returned in the event of a conversion error.

impl<'a> TryFrom<&'a String> for NormpathBuf

fn try_from(value: &'a String) -> Result<Self, Self::Error>

Validates that value is normalized to create a NormpathBuf from it.

type Error = ConvertError<&'a String>

The type returned in the event of a conversion error.

impl<'a> TryFrom<&'a str> for NormpathBuf

fn try_from(value: &'a str) -> Result<Self, Self::Error>

Validates that value is normalized to create a NormpathBuf from it.

type Error = ConvertError<&'a str>

The type returned in the event of a conversion error.

impl TryFrom<Box<Path>> for NormpathBuf

fn try_from(value: Box<Path>) -> Result<Self, Self::Error>

Validates that value is normalized to create a NormpathBuf from it.

Unlike NormpathBuf::normalize, this function never mutates the input value.

type Error = ConvertError<Box<Path>>

The type returned in the event of a conversion error.

impl<'a> TryFrom<Cow<'a, Path>> for NormpathBuf

fn try_from(value: Cow<'a, Path>) -> Result<Self, Self::Error>

Validates that value is normalized to create a NormpathBuf from it.

Unlike NormpathBuf::normalize, this function never mutates the input value.

type Error = ConvertError<Cow<'a, Path>>

The type returned in the event of a conversion error.

impl TryFrom<OsString> for NormpathBuf

fn try_from(value: OsString) -> Result<Self, Self::Error>

Validates that value is normalized to create a NormpathBuf from it.

Unlike NormpathBuf::normalize, this function never mutates the input value.

type Error = ConvertError<OsString>

The type returned in the event of a conversion error.

impl TryFrom<PathBuf> for NormpathBuf

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

Validates that value is normalized to create a NormpathBuf from it.

Unlike NormpathBuf::normalize, this function never mutates the input value.

type Error = ConvertError<PathBuf>

The type returned in the event of a conversion error.

impl TryFrom<String> for NormpathBuf

fn try_from(value: String) -> Result<Self, Self::Error>

Validates that value is normalized to create a NormpathBuf from it.

Unlike NormpathBuf::normalize, this function never mutates the input value.

type Error = ConvertError<String>

The type returned in the event of a conversion error.

impl Eq for NormpathBuf