Struct typed_path::Path
source · #[repr(transparent)]pub struct Path<T>where
T: for<'enc> Encoding<'enc>,{ /* private fields */ }
Expand description
A slice of a path (akin to str
).
This type supports a number of operations for inspecting a path, including
breaking the path into its components (separated by /
on Unix and by either
/
or \
on Windows), extracting the file name, determining whether the path
is absolute, and so on.
This is an unsized type, meaning that it must always be used behind a
pointer like &
or Box
. For an owned version of this type,
see PathBuf
.
Examples
use typed_path::{Path, UnixEncoding};
// NOTE: A path cannot be created on its own without a defined encoding,
// but all encodings work on all operating systems, providing the
// ability to parse and operate on paths independently of the
// compiled platform
let path = Path::<UnixEncoding>::new("./foo/bar.txt");
let parent = path.parent();
assert_eq!(parent, Some(Path::new("./foo")));
let file_stem = path.file_stem();
assert_eq!(file_stem, Some(b"bar".as_slice()));
let extension = path.extension();
assert_eq!(extension, Some(b"txt".as_slice()));
In addition to explicitly using Encoding
s, you can also
leverage aliases available from the crate to work with paths:
use typed_path::{UnixPath, WindowsPath};
// Same as Path<UnixEncoding>
let path = UnixPath::new("/foo/bar.txt");
// Same as Path<WindowsEncoding>
let path = WindowsPath::new(r"C:\foo\bar.txt");
To mirror the design of Rust’s standard library, you can access
the path associated with the compiled rust platform using NativePath
,
which itself is an alias to one of the other choices:
use typed_path::NativePath;
// On Unix, this would be UnixPath aka Path<UnixEncoding>
// On Windows, this would be WindowsPath aka Path<WindowsEncoding>
let path = NativePath::new("/foo/bar.txt");
Implementations§
source§impl<T> Path<T>where
T: for<'enc> Encoding<'enc>,
impl<T> Path<T>where
T: for<'enc> Encoding<'enc>,
sourcepub fn new<S: AsRef<[u8]> + ?Sized>(s: &S) -> &Self
pub fn new<S: AsRef<[u8]> + ?Sized>(s: &S) -> &Self
Directly wraps a byte slice as a Path
slice.
This is a cost-free conversion.
Examples
use typed_path::{Path, UnixEncoding};
// NOTE: A path cannot be created on its own without a defined encoding
Path::<UnixEncoding>::new("foo.txt");
You can create Path
s from String
s, or even other Path
s:
use typed_path::{Path, UnixEncoding};
// NOTE: A path cannot be created on its own without a defined encoding
let string = String::from("foo.txt");
let from_string = Path::<UnixEncoding>::new(&string);
let from_path = Path::new(&from_string);
assert_eq!(from_string, from_path);
There are also handy aliases to the Path
with Encoding
:
use typed_path::UnixPath;
let string = String::from("foo.txt");
let from_string = UnixPath::new(&string);
let from_path = UnixPath::new(&from_string);
assert_eq!(from_string, from_path);
sourcepub fn as_bytes(&self) -> &[u8] ⓘ
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");
sourcepub fn to_str(&self) -> Option<&str>
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"));
sourcepub fn to_string_lossy(&self) -> Cow<'_, str>
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"
.
sourcepub fn to_path_buf(&self) -> PathBuf<T>
pub fn to_path_buf(&self) -> PathBuf<T>
sourcepub fn is_absolute(&self) -> bool
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, sois_absolute
andhas_root
are equivalent. -
On Windows (
WindowsPath
), a path is absolute if it has a prefix and starts with the root:c:\windows
is absolute, whilec: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());
sourcepub fn is_relative(&self) -> bool
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());
sourcepub fn has_root(&self) -> bool
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 notc:windows
- has any non-disk prefix, e.g.,
\\server\share
- has no prefix and begins with a separator, e.g.,
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());
sourcepub fn parent(&self) -> Option<&Self>
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);
sourcepub fn ancestors(&self) -> Ancestors<'_, T> ⓘ
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);
sourcepub fn file_name(&self) -> Option<&[u8]>
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());
sourcepub fn strip_prefix<P>(&self, base: P) -> Result<&Path<T>, StripPrefixError>where
P: AsRef<Path<T>>,
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")));
sourcepub fn starts_with<P>(&self, base: P) -> boolwhere
P: AsRef<Path<T>>,
pub fn starts_with<P>(&self, base: P) -> boolwhere
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"));
sourcepub fn ends_with<P>(&self, child: P) -> boolwhere
P: AsRef<Path<T>>,
pub fn ends_with<P>(&self, child: P) -> boolwhere
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
sourcepub fn file_stem(&self) -> Option<&[u8]>
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());
sourcepub fn extension(&self) -> Option<&[u8]>
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());
sourcepub fn join<P: AsRef<Path<T>>>(&self, path: P) -> PathBuf<T>
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"),
);
sourcepub fn with_file_name<S: AsRef<[u8]>>(&self, file_name: S) -> PathBuf<T>
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"));
sourcepub fn with_extension<S: AsRef<[u8]>>(&self, extension: S) -> PathBuf<T>
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"));
sourcepub fn components(&self) -> <T as Encoding<'_>>::Components
pub fn components(&self) -> <T as Encoding<'_>>::Components
Produces an iterator over the Component
s of the path.
When parsing the path, there is a small amount of normalization:
-
Repeated separators are ignored, so
a/b
anda//b
both havea
andb
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/.
anda/b
all havea
andb
as components, but./a/b
starts with an additionalCurDir
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)
sourcepub fn iter(&self) -> Iter<'_, T> ⓘ
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)
sourcepub fn display(&self) -> Display<'_, T>
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§
source§impl<'a, T> IntoIterator for &'a Path<T>where
T: for<'enc> Encoding<'enc>,
impl<'a, T> IntoIterator for &'a Path<T>where
T: for<'enc> Encoding<'enc>,
source§impl<'a, T> PartialEq<&'a [u8]> for Path<T>where
T: for<'enc> Encoding<'enc>,
impl<'a, T> PartialEq<&'a [u8]> for Path<T>where
T: for<'enc> Encoding<'enc>,
source§impl<'a, T> PartialEq<&'a Path<T>> for [u8]where
T: for<'enc> Encoding<'enc>,
impl<'a, T> PartialEq<&'a Path<T>> for [u8]where
T: for<'enc> Encoding<'enc>,
source§impl<'a, 'b, T> PartialEq<&'a Path<T>> for Cow<'b, [u8]>where
T: for<'enc> Encoding<'enc>,
impl<'a, 'b, T> PartialEq<&'a Path<T>> for Cow<'b, [u8]>where
T: for<'enc> Encoding<'enc>,
source§impl<'a, T> PartialEq<&'a Path<T>> for PathBuf<T>where
T: for<'enc> Encoding<'enc>,
impl<'a, T> PartialEq<&'a Path<T>> for PathBuf<T>where
T: for<'enc> Encoding<'enc>,
source§impl<'a, T> PartialEq<&'a Path<T>> for Vec<u8>where
T: for<'enc> Encoding<'enc>,
impl<'a, T> PartialEq<&'a Path<T>> for Vec<u8>where
T: for<'enc> Encoding<'enc>,
source§impl<'a, 'b, T> PartialEq<&'b Path<T>> for Cow<'a, Path<T>>where
T: for<'enc> Encoding<'enc>,
impl<'a, 'b, T> PartialEq<&'b Path<T>> for Cow<'a, Path<T>>where
T: for<'enc> Encoding<'enc>,
source§impl<'a, T> PartialEq<[u8]> for &'a Path<T>where
T: for<'enc> Encoding<'enc>,
impl<'a, T> PartialEq<[u8]> for &'a Path<T>where
T: for<'enc> Encoding<'enc>,
source§impl<T> PartialEq<[u8]> for Path<T>where
T: for<'enc> Encoding<'enc>,
impl<T> PartialEq<[u8]> for Path<T>where
T: for<'enc> Encoding<'enc>,
source§impl<'a, T> PartialEq<Cow<'a, [u8]>> for Path<T>where
T: for<'enc> Encoding<'enc>,
impl<'a, T> PartialEq<Cow<'a, [u8]>> for Path<T>where
T: for<'enc> Encoding<'enc>,
source§impl<'a, 'b, T> PartialEq<Cow<'a, Path<T>>> for &'b Path<T>where
T: for<'enc> Encoding<'enc>,
impl<'a, 'b, T> PartialEq<Cow<'a, Path<T>>> for &'b Path<T>where
T: for<'enc> Encoding<'enc>,
source§impl<'a, T> PartialEq<Cow<'a, Path<T>>> for Path<T>where
T: for<'enc> Encoding<'enc>,
impl<'a, T> PartialEq<Cow<'a, Path<T>>> for Path<T>where
T: for<'enc> Encoding<'enc>,
source§impl<'a, 'b, T> PartialEq<Cow<'b, [u8]>> for &'a Path<T>where
T: for<'enc> Encoding<'enc>,
impl<'a, 'b, T> PartialEq<Cow<'b, [u8]>> for &'a Path<T>where
T: for<'enc> Encoding<'enc>,
source§impl<'a, T> PartialEq<Path<T>> for &'a [u8]where
T: for<'enc> Encoding<'enc>,
impl<'a, T> PartialEq<Path<T>> for &'a [u8]where
T: for<'enc> Encoding<'enc>,
source§impl<T> PartialEq<Path<T>> for [u8]where
T: for<'enc> Encoding<'enc>,
impl<T> PartialEq<Path<T>> for [u8]where
T: for<'enc> Encoding<'enc>,
source§impl<'a, T> PartialEq<Path<T>> for Cow<'a, [u8]>where
T: for<'enc> Encoding<'enc>,
impl<'a, T> PartialEq<Path<T>> for Cow<'a, [u8]>where
T: for<'enc> Encoding<'enc>,
source§impl<'a, T> PartialEq<Path<T>> for Cow<'a, Path<T>>where
T: for<'enc> Encoding<'enc>,
impl<'a, T> PartialEq<Path<T>> for Cow<'a, Path<T>>where
T: for<'enc> Encoding<'enc>,
source§impl<T> PartialEq<Path<T>> for Path<T>where
T: for<'enc> Encoding<'enc>,
impl<T> PartialEq<Path<T>> for Path<T>where
T: for<'enc> Encoding<'enc>,
source§impl<T> PartialEq<Path<T>> for PathBuf<T>where
T: for<'enc> Encoding<'enc>,
impl<T> PartialEq<Path<T>> for PathBuf<T>where
T: for<'enc> Encoding<'enc>,
source§impl<T> PartialEq<Path<T>> for Vec<u8>where
T: for<'enc> Encoding<'enc>,
impl<T> PartialEq<Path<T>> for Vec<u8>where
T: for<'enc> Encoding<'enc>,
source§impl<'a, T> PartialEq<PathBuf<T>> for &'a Path<T>where
T: for<'enc> Encoding<'enc>,
impl<'a, T> PartialEq<PathBuf<T>> for &'a Path<T>where
T: for<'enc> Encoding<'enc>,
source§impl<T> PartialEq<PathBuf<T>> for Path<T>where
T: for<'enc> Encoding<'enc>,
impl<T> PartialEq<PathBuf<T>> for Path<T>where
T: for<'enc> Encoding<'enc>,
source§impl<'a, T> PartialEq<Vec<u8, Global>> for &'a Path<T>where
T: for<'enc> Encoding<'enc>,
impl<'a, T> PartialEq<Vec<u8, Global>> for &'a Path<T>where
T: for<'enc> Encoding<'enc>,
source§impl<T> PartialEq<Vec<u8, Global>> for Path<T>where
T: for<'enc> Encoding<'enc>,
impl<T> PartialEq<Vec<u8, Global>> for Path<T>where
T: for<'enc> Encoding<'enc>,
source§impl<'a, T> PartialOrd<&'a [u8]> for Path<T>where
T: for<'enc> Encoding<'enc>,
impl<'a, T> PartialOrd<&'a [u8]> for Path<T>where
T: for<'enc> Encoding<'enc>,
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<'a, T> PartialOrd<&'a Path<T>> for [u8]where
T: for<'enc> Encoding<'enc>,
impl<'a, T> PartialOrd<&'a Path<T>> for [u8]where
T: for<'enc> Encoding<'enc>,
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<'a, 'b, T> PartialOrd<&'a Path<T>> for Cow<'b, [u8]>where
T: for<'enc> Encoding<'enc>,
impl<'a, 'b, T> PartialOrd<&'a Path<T>> for Cow<'b, [u8]>where
T: for<'enc> Encoding<'enc>,
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<'a, T> PartialOrd<&'a Path<T>> for PathBuf<T>where
T: for<'enc> Encoding<'enc>,
impl<'a, T> PartialOrd<&'a Path<T>> for PathBuf<T>where
T: for<'enc> Encoding<'enc>,
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<'a, T> PartialOrd<&'a Path<T>> for Vec<u8>where
T: for<'enc> Encoding<'enc>,
impl<'a, T> PartialOrd<&'a Path<T>> for Vec<u8>where
T: for<'enc> Encoding<'enc>,
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<'a, 'b, T> PartialOrd<&'b Path<T>> for Cow<'a, Path<T>>where
T: for<'enc> Encoding<'enc>,
impl<'a, 'b, T> PartialOrd<&'b Path<T>> for Cow<'a, Path<T>>where
T: for<'enc> Encoding<'enc>,
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<'a, T> PartialOrd<[u8]> for &'a Path<T>where
T: for<'enc> Encoding<'enc>,
impl<'a, T> PartialOrd<[u8]> for &'a Path<T>where
T: for<'enc> Encoding<'enc>,
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<T> PartialOrd<[u8]> for Path<T>where
T: for<'enc> Encoding<'enc>,
impl<T> PartialOrd<[u8]> for Path<T>where
T: for<'enc> Encoding<'enc>,
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<'a, T> PartialOrd<Cow<'a, [u8]>> for Path<T>where
T: for<'enc> Encoding<'enc>,
impl<'a, T> PartialOrd<Cow<'a, [u8]>> for Path<T>where
T: for<'enc> Encoding<'enc>,
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<'a, 'b, T> PartialOrd<Cow<'a, Path<T>>> for &'b Path<T>where
T: for<'enc> Encoding<'enc>,
impl<'a, 'b, T> PartialOrd<Cow<'a, Path<T>>> for &'b Path<T>where
T: for<'enc> Encoding<'enc>,
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<'a, T> PartialOrd<Cow<'a, Path<T>>> for Path<T>where
T: for<'enc> Encoding<'enc>,
impl<'a, T> PartialOrd<Cow<'a, Path<T>>> for Path<T>where
T: for<'enc> Encoding<'enc>,
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<'a, 'b, T> PartialOrd<Cow<'b, [u8]>> for &'a Path<T>where
T: for<'enc> Encoding<'enc>,
impl<'a, 'b, T> PartialOrd<Cow<'b, [u8]>> for &'a Path<T>where
T: for<'enc> Encoding<'enc>,
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<'a, T> PartialOrd<Path<T>> for &'a [u8]where
T: for<'enc> Encoding<'enc>,
impl<'a, T> PartialOrd<Path<T>> for &'a [u8]where
T: for<'enc> Encoding<'enc>,
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<T> PartialOrd<Path<T>> for [u8]where
T: for<'enc> Encoding<'enc>,
impl<T> PartialOrd<Path<T>> for [u8]where
T: for<'enc> Encoding<'enc>,
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<'a, T> PartialOrd<Path<T>> for Cow<'a, [u8]>where
T: for<'enc> Encoding<'enc>,
impl<'a, T> PartialOrd<Path<T>> for Cow<'a, [u8]>where
T: for<'enc> Encoding<'enc>,
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<'a, T> PartialOrd<Path<T>> for Cow<'a, Path<T>>where
T: for<'enc> Encoding<'enc>,
impl<'a, T> PartialOrd<Path<T>> for Cow<'a, Path<T>>where
T: for<'enc> Encoding<'enc>,
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<T> PartialOrd<Path<T>> for Path<T>where
T: for<'enc> Encoding<'enc>,
impl<T> PartialOrd<Path<T>> for Path<T>where
T: for<'enc> Encoding<'enc>,
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<T> PartialOrd<Path<T>> for PathBuf<T>where
T: for<'enc> Encoding<'enc>,
impl<T> PartialOrd<Path<T>> for PathBuf<T>where
T: for<'enc> Encoding<'enc>,
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<T> PartialOrd<Path<T>> for Vec<u8>where
T: for<'enc> Encoding<'enc>,
impl<T> PartialOrd<Path<T>> for Vec<u8>where
T: for<'enc> Encoding<'enc>,
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<'a, T> PartialOrd<PathBuf<T>> for &'a Path<T>where
T: for<'enc> Encoding<'enc>,
impl<'a, T> PartialOrd<PathBuf<T>> for &'a Path<T>where
T: for<'enc> Encoding<'enc>,
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<T> PartialOrd<PathBuf<T>> for Path<T>where
T: for<'enc> Encoding<'enc>,
impl<T> PartialOrd<PathBuf<T>> for Path<T>where
T: for<'enc> Encoding<'enc>,
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<'a, T> PartialOrd<Vec<u8, Global>> for &'a Path<T>where
T: for<'enc> Encoding<'enc>,
impl<'a, T> PartialOrd<Vec<u8, Global>> for &'a Path<T>where
T: for<'enc> Encoding<'enc>,
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<T> PartialOrd<Vec<u8, Global>> for Path<T>where
T: for<'enc> Encoding<'enc>,
impl<T> PartialOrd<Vec<u8, Global>> for Path<T>where
T: for<'enc> Encoding<'enc>,
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<T> ToOwned for Path<T>where
T: for<'enc> Encoding<'enc>,
impl<T> ToOwned for Path<T>where
T: for<'enc> Encoding<'enc>,
source§impl<T> TryAsRef<Path<T>> for StdPathwhere
T: for<'enc> Encoding<'enc>,
impl<T> TryAsRef<Path<T>> for StdPathwhere
T: for<'enc> Encoding<'enc>,
source§fn try_as_ref(&self) -> Option<&Path<T>>
fn try_as_ref(&self) -> Option<&Path<T>>
Attempts to convert a std::path::Path
into a Path
, returning a result containing
the new path when successful
Examples
use std::path::Path;
use typed_path::{TryAsRef, UnixPath};
let std_path = Path::new("/path/to/file.txt");
let unix_path: &UnixPath = std_path.try_as_ref().unwrap();
source§impl<T> TryAsRef<Path> for Path<T>where
T: for<'enc> Encoding<'enc>,
impl<T> TryAsRef<Path> for Path<T>where
T: for<'enc> Encoding<'enc>,
source§fn try_as_ref(&self) -> Option<&StdPath>
fn try_as_ref(&self) -> Option<&StdPath>
Attempts to convert a Path
into a std::path::Path
, succeeding if the path is
comprised only of valid UTF-8 bytes
Examples
use std::path::Path;
use typed_path::{TryAsRef, UnixPath};
let unix_path = UnixPath::new("/path/to/file.txt");
let std_path: &Path = unix_path.try_as_ref().unwrap();