pub enum TypedPathBuf {
Unix(UnixPathBuf),
Windows(WindowsPathBuf),
}Expand description
Represents a pathbuf with a known type that can be one of:
Variants§
Unix(UnixPathBuf)
Windows(WindowsPathBuf)
Implementations§
source§impl TypedPathBuf
impl TypedPathBuf
sourcepub fn is_windows(&self) -> bool
pub fn is_windows(&self) -> bool
Returns true if this path represents a Windows path.
sourcepub fn with_unix_encoding(&self) -> TypedPathBuf
pub fn with_unix_encoding(&self) -> TypedPathBuf
Converts this TypedPathBuf into the Unix variant.
sourcepub fn with_unix_encoding_checked(
&self,
) -> Result<TypedPathBuf, CheckedPathError>
pub fn with_unix_encoding_checked( &self, ) -> Result<TypedPathBuf, CheckedPathError>
Converts this TypedPathBuf into the Unix variant, ensuring it is a valid Unix path.
sourcepub fn with_windows_encoding(&self) -> TypedPathBuf
pub fn with_windows_encoding(&self) -> TypedPathBuf
Converts this TypedPathBuf into the Windows variant.
sourcepub fn with_windows_encoding_checked(
&self,
) -> Result<TypedPathBuf, CheckedPathError>
pub fn with_windows_encoding_checked( &self, ) -> Result<TypedPathBuf, CheckedPathError>
Converts this TypedPathBuf into the Windows variant, ensuring it is a valid Windows
path.
sourcepub fn new(type: PathType) -> Self
pub fn new(type: PathType) -> Self
Allocates an empty TypedPathBuf for the specified path type.
§Examples
use typed_path::{PathType, TypedPathBuf};
let _unix_path = TypedPathBuf::new(PathType::Unix);
let _windows_path = TypedPathBuf::new(PathType::Windows);sourcepub fn unix() -> Self
pub fn unix() -> Self
Allocates an empty TypedPathBuf as a Unix path.
sourcepub fn windows() -> Self
pub fn windows() -> Self
Allocates an empty TypedPathBuf as a Windows path.
sourcepub fn from_unix(s: impl AsRef<[u8]>) -> Self
pub fn from_unix(s: impl AsRef<[u8]>) -> Self
Creates a new TypedPathBuf from the bytes representing a Unix path.
§Examples
use typed_path::TypedPathBuf;
let path = TypedPathBuf::from_unix("/tmp");sourcepub fn from_windows(s: impl AsRef<[u8]>) -> Self
pub fn from_windows(s: impl AsRef<[u8]>) -> Self
Creates a new TypedPathBuf from the bytes representing a Windows path.
§Examples
use typed_path::TypedPathBuf;
let path = TypedPathBuf::from_windows(r"C:\tmp");sourcepub fn push(&mut self, path: impl AsRef<[u8]>)
pub fn push(&mut self, path: impl AsRef<[u8]>)
Extends self with path.
If path is absolute, it replaces the current path.
With WindowsPathBuf:
- if
pathhas a root but no prefix (e.g.,\windows), it replaces everything except for the prefix (if any) ofself. - if
pathhas a prefix but no root, it replacesself. - if
selfhas a verbatim prefix (e.g.\\?\C:\windows) andpathis not empty, the new path is normalized: all references to.and..are removed.
§Difference from PathBuf
Unlike PathBuf::push, this implementation only supports types that implement
AsRef<[u8]> instead of AsRef<Path>.
§Examples
Pushing a relative path extends the existing path:
use typed_path::TypedPathBuf;
let mut path = TypedPathBuf::from_unix("/tmp");
path.push("file.bk");
assert_eq!(path, TypedPathBuf::from_unix("/tmp/file.bk"));Pushing an absolute path replaces the existing path:
use typed_path::TypedPathBuf;
let mut path = TypedPathBuf::from_unix("/tmp");
path.push("/etc");
assert_eq!(path, TypedPathBuf::from_unix("/etc"));sourcepub fn push_checked(
&mut self,
path: impl AsRef<[u8]>,
) -> Result<(), CheckedPathError>
pub fn push_checked( &mut self, path: impl AsRef<[u8]>, ) -> Result<(), CheckedPathError>
Like TypedPathBuf::push, extends self with path, but also checks to ensure that
path abides by a set of rules.
§Rules
pathcannot contain a prefix component.pathcannot contain a root component.pathcannot contain invalid filename bytes.pathcannot contain parent components such that the current path would be escaped.
§Difference from PathBuf
Unlike PathBuf::push_checked, this implementation only supports types that implement
AsRef<[u8]> instead of AsRef<Path>.
§Examples
Pushing a relative path extends the existing path:
use typed_path::TypedPathBuf;
let mut path = TypedPathBuf::from_unix("/tmp");
assert!(path.push_checked("file.bk").is_ok());
assert_eq!(path, TypedPathBuf::from_unix("/tmp/file.bk"));Pushing a relative path that contains unresolved parent directory references fails with an error:
use typed_path::{CheckedPathError, TypedPathBuf};
let mut path = TypedPathBuf::from_unix("/tmp");
// Pushing a relative path that contains parent directory references that cannot be
// resolved within the path is considered an error as this is considered a path
// traversal attack!
assert_eq!(path.push_checked(".."), Err(CheckedPathError::PathTraversalAttack));
assert_eq!(path, TypedPathBuf::from("/tmp"));Pushing an absolute path fails with an error:
use typed_path::{CheckedPathError, TypedPathBuf};
let mut path = TypedPathBuf::from_unix("/tmp");
// Pushing an absolute path will fail with an error
assert_eq!(path.push_checked("/etc"), Err(CheckedPathError::UnexpectedRoot));
assert_eq!(path, TypedPathBuf::from_unix("/tmp"));sourcepub fn pop(&mut self) -> bool
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::{TypedPath, TypedPathBuf};
let mut p = TypedPathBuf::from_unix("/spirited/away.rs");
p.pop();
assert_eq!(TypedPath::derive("/spirited"), p);
p.pop();
assert_eq!(TypedPath::derive("/"), p);sourcepub fn set_file_name<S: AsRef<[u8]>>(&mut self, file_name: S)
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::TypedPathBuf;
let mut buf = TypedPathBuf::from_unix("/");
assert!(buf.file_name() == None);
buf.set_file_name("bar");
assert!(buf == TypedPathBuf::from_unix("/bar"));
assert!(buf.file_name().is_some());
buf.set_file_name("baz.txt");
assert!(buf == TypedPathBuf::from_unix("/baz.txt"));sourcepub fn set_extension<S: AsRef<[u8]>>(&mut self, extension: S) -> bool
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::{TypedPath, TypedPathBuf};
let mut p = TypedPathBuf::from_unix("/feel/the");
p.set_extension("force");
assert_eq!(TypedPath::derive("/feel/the.force"), p.to_path());
p.set_extension("dark_side");
assert_eq!(TypedPath::derive("/feel/the.dark_side"), p.to_path());sourcepub fn into_vec(self) -> Vec<u8> ⓘ
pub fn into_vec(self) -> Vec<u8> ⓘ
Consumes the TypedPathBuf, yielding its internal Vec<u8> storage.
§Examples
use typed_path::TypedPathBuf;
let p = TypedPathBuf::from_unix("/the/head");
let vec = p.into_vec();
assert_eq!(vec, b"/the/head");sourcepub fn try_reserve(&mut self, additional: usize) -> Result<(), TryReserveError>
pub fn try_reserve(&mut self, additional: usize) -> Result<(), TryReserveError>
Invokes try_reserve on the underlying instance of Vec.
sourcepub fn reserve_exact(&mut self, additional: usize)
pub fn reserve_exact(&mut self, additional: usize)
Invokes reserve_exact on the underlying instance of Vec.
sourcepub fn try_reserve_exact(
&mut self,
additional: usize,
) -> Result<(), TryReserveError>
pub fn try_reserve_exact( &mut self, additional: usize, ) -> Result<(), TryReserveError>
Invokes try_reserve_exact on the underlying instance of Vec.
sourcepub fn shrink_to_fit(&mut self)
pub fn shrink_to_fit(&mut self)
Invokes shrink_to_fit on the underlying instance of Vec.
source§impl TypedPathBuf
impl TypedPathBuf
Reimplementation of TypedPath methods as we cannot implement std::ops::Deref directly.
sourcepub fn as_bytes(&self) -> &[u8] ⓘ
pub fn as_bytes(&self) -> &[u8] ⓘ
Yields the underlying [[u8]] slice.
§Examples
use typed_path::TypedPathBuf;
let bytes = TypedPathBuf::from("foo.txt").as_bytes().to_vec();
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 TypedPathBuf 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::TypedPathBuf;
let path = TypedPathBuf::from("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 TypedPathBuf to a Cow<str>.
Any non-Unicode sequences are replaced with
U+FFFD REPLACEMENT CHARACTER.
§Examples
Calling to_string_lossy on a TypedPathBuf with valid unicode:
use typed_path::TypedPathBuf;
let path = TypedPathBuf::from("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 is_absolute(&self) -> bool
pub fn is_absolute(&self) -> bool
Returns true if the TypedPathBuf is absolute, i.e., if it is independent of
the current directory.
-
On Unix (
UnixPathBuf]), a path is absolute if it starts with the root, sois_absoluteandhas_rootare equivalent. -
On Windows (
WindowsPathBuf), a path is absolute if it has a prefix and starts with the root:c:\windowsis absolute, whilec:tempand\tempare not.
§Examples
use typed_path::TypedPathBuf;
assert!(!TypedPathBuf::from("foo.txt").is_absolute());sourcepub fn is_relative(&self) -> bool
pub fn is_relative(&self) -> bool
Returns true if the TypedPathBuf is relative, i.e., not absolute.
See is_absolute’s documentation for more details.
§Examples
use typed_path::TypedPathBuf;
assert!(TypedPathBuf::from("foo.txt").is_relative());sourcepub fn has_root(&self) -> bool
pub fn has_root(&self) -> bool
Returns true if the TypedPathBuf has a root.
-
On Unix (
UnixPathBuf), a path has a root if it begins with/. -
On Windows (
WindowsPathBuf), 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:\windowsbut 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::TypedPathBuf;
assert!(TypedPathBuf::from("/etc/passwd").has_root());sourcepub fn parent(&self) -> Option<TypedPath<'_>>
pub fn parent(&self) -> Option<TypedPath<'_>>
Returns the TypedPathBuf without its final component, if there is one.
Returns None if the path terminates in a root or prefix.
§Examples
use typed_path::TypedPathBuf;
let path = TypedPathBuf::from("/foo/bar");
let parent = path.parent().unwrap();
assert_eq!(parent, TypedPathBuf::from("/foo"));
let grand_parent = parent.parent().unwrap();
assert_eq!(grand_parent, TypedPathBuf::from("/"));
assert_eq!(grand_parent.parent(), None);sourcepub fn ancestors(&self) -> TypedAncestors<'_> ⓘ
pub fn ancestors(&self) -> TypedAncestors<'_> ⓘ
Produces an iterator over TypedPathBuf and its ancestors.
The iterator will yield the TypedPathBuf 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::{TypedPath, TypedPathBuf};
let path = TypedPathBuf::from("/foo/bar");
let mut ancestors = path.ancestors();
assert_eq!(ancestors.next(), Some(TypedPath::derive("/foo/bar")));
assert_eq!(ancestors.next(), Some(TypedPath::derive("/foo")));
assert_eq!(ancestors.next(), Some(TypedPath::derive("/")));
assert_eq!(ancestors.next(), None);
let path = TypedPathBuf::from("../foo/bar");
let mut ancestors = path.ancestors();
assert_eq!(ancestors.next(), Some(TypedPath::derive("../foo/bar")));
assert_eq!(ancestors.next(), Some(TypedPath::derive("../foo")));
assert_eq!(ancestors.next(), Some(TypedPath::derive("..")));
assert_eq!(ancestors.next(), Some(TypedPath::derive("")));
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 TypedPathBuf, 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::TypedPathBuf;
assert_eq!(Some(b"bin".as_slice()), TypedPathBuf::from("/usr/bin/").file_name());
assert_eq!(Some(b"foo.txt".as_slice()), TypedPathBuf::from("tmp/foo.txt").file_name());
assert_eq!(Some(b"foo.txt".as_slice()), TypedPathBuf::from("foo.txt/.").file_name());
assert_eq!(Some(b"foo.txt".as_slice()), TypedPathBuf::from("foo.txt/.//").file_name());
assert_eq!(None, TypedPathBuf::from("foo.txt/..").file_name());
assert_eq!(None, TypedPathBuf::from("/").file_name());sourcepub fn strip_prefix(
&self,
base: impl AsRef<[u8]>,
) -> Result<TypedPath<'_>, StripPrefixError>
pub fn strip_prefix( &self, base: impl AsRef<[u8]>, ) -> Result<TypedPath<'_>, StripPrefixError>
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::{TypedPath, TypedPathBuf};
let path = TypedPathBuf::from("/test/haha/foo.txt");
assert_eq!(path.strip_prefix("/"), Ok(TypedPath::derive("test/haha/foo.txt")));
assert_eq!(path.strip_prefix("/test"), Ok(TypedPath::derive("haha/foo.txt")));
assert_eq!(path.strip_prefix("/test/"), Ok(TypedPath::derive("haha/foo.txt")));
assert_eq!(path.strip_prefix("/test/haha/foo.txt"), Ok(TypedPath::derive("")));
assert_eq!(path.strip_prefix("/test/haha/foo.txt/"), Ok(TypedPath::derive("")));
assert!(path.strip_prefix("test").is_err());
assert!(path.strip_prefix("/haha").is_err());
let prefix = TypedPathBuf::from("/test/");
assert_eq!(path.strip_prefix(prefix), Ok(TypedPath::derive("haha/foo.txt")));sourcepub fn starts_with(&self, base: impl AsRef<[u8]>) -> bool
pub fn starts_with(&self, base: impl AsRef<[u8]>) -> bool
Determines whether base is a prefix of self.
Only considers whole path components to match.
§Difference from Path
Unlike Path::starts_with, this implementation only supports types that implement
AsRef<[u8]> instead of AsRef<Path>.
§Examples
use typed_path::TypedPathBuf;
let path = TypedPathBuf::from("/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!(!TypedPathBuf::from("/etc/foo.rs").starts_with("/etc/foo"));sourcepub fn ends_with(&self, child: impl AsRef<[u8]>) -> bool
pub fn ends_with(&self, child: impl AsRef<[u8]>) -> bool
Determines whether child is a suffix of self.
Only considers whole path components to match.
§Difference from Path
Unlike Path::ends_with, this implementation only supports types that implement
AsRef<[u8]> instead of AsRef<Path>.
§Examples
use typed_path::TypedPathBuf;
let path = TypedPathBuf::from("/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() insteadsourcepub 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::TypedPathBuf;
assert_eq!(b"foo", TypedPathBuf::from("foo.rs").file_stem().unwrap());
assert_eq!(b"foo.tar", TypedPathBuf::from("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::TypedPathBuf;
// NOTE: A path cannot be created on its own without a defined encoding
assert_eq!(b"rs", TypedPathBuf::from("foo.rs").extension().unwrap());
assert_eq!(b"gz", TypedPathBuf::from("foo.tar.gz").extension().unwrap());sourcepub fn normalize(&self) -> TypedPathBuf
pub fn normalize(&self) -> TypedPathBuf
Returns an owned TypedPathBuf by resolving .. and . segments.
When multiple, sequential path segment separation characters are found (e.g. / for Unix
and either \ or / on Windows), they are replaced by a single instance of the
platform-specific path segment separator (/ on Unix and \ on Windows).
§Examples
use typed_path::TypedPathBuf;
assert_eq!(
TypedPathBuf::from("foo/bar//baz/./asdf/quux/..").normalize(),
TypedPathBuf::from("foo/bar/baz/asdf"),
);When starting with a root directory, any .. segment whose parent is the root directory
will be filtered out:
use typed_path::TypedPathBuf;
assert_eq!(
TypedPathBuf::from("/../foo").normalize(),
TypedPathBuf::from("/foo"),
);If any .. is left unresolved as the path is relative and no parent is found, it is
discarded:
use typed_path::TypedPathBuf;
assert_eq!(
TypedPathBuf::from("../foo/..").normalize(),
TypedPathBuf::from(""),
);
// Windows prefixes also count this way, but the prefix remains
assert_eq!(
TypedPathBuf::from(r"C:..\foo\..").normalize(),
TypedPathBuf::from(r"C:"),
);sourcepub fn absolutize(&self) -> Result<TypedPathBuf>
pub fn absolutize(&self) -> Result<TypedPathBuf>
Converts a path to an absolute form by normalizing the path, returning a
TypedPathBuf.
In the case that the path is relative, the current working directory is prepended prior to normalizing.
§Examples
use typed_path::{utils, TypedPathBuf, UnixEncoding};
// With an absolute path, it is just normalized
let path = TypedPathBuf::from("/a/b/../c/./d");
assert_eq!(path.absolutize().unwrap(), TypedPathBuf::from("/a/c/d"));
// With a relative path, it is first joined with the current working directory
// and then normalized
let cwd = utils::current_dir().unwrap().with_encoding::<UnixEncoding>().to_typed_path_buf();
let path = cwd.join("a/b/../c/./d");
assert_eq!(path.absolutize().unwrap(), cwd.join("a/c/d"));sourcepub fn join(&self, path: impl AsRef<[u8]>) -> TypedPathBuf
pub fn join(&self, path: impl AsRef<[u8]>) -> TypedPathBuf
Creates an owned TypedPathBuf with path adjoined to self.
See TypedPathBuf::push for more details on what it means to adjoin a path.
§Difference from Path
Unlike Path::join, this implementation only supports types that implement
AsRef<[u8]> instead of AsRef<Path>.
§Examples
use typed_path::TypedPathBuf;
assert_eq!(
TypedPathBuf::from("/etc").join("passwd"),
TypedPathBuf::from("/etc/passwd"),
);sourcepub fn join_checked(
&self,
path: impl AsRef<[u8]>,
) -> Result<TypedPathBuf, CheckedPathError>
pub fn join_checked( &self, path: impl AsRef<[u8]>, ) -> Result<TypedPathBuf, CheckedPathError>
Creates an owned TypedPathBuf with path adjoined to self, checking the path to
ensure it is safe to join. When dealing with user-provided paths, this is the preferred
method.
See TypedPathBuf::push_checked for more details on what it means to adjoin a path
safely.
§Difference from Path
Unlike Path::join_checked, this implementation only supports types that implement
AsRef<[u8]> instead of AsRef<Path>.
§Examples
use typed_path::{CheckedPathError, TypedPathBuf};
// Valid path will join successfully
assert_eq!(
TypedPathBuf::from("/etc").join_checked("passwd"),
Ok(TypedPathBuf::from("/etc/passwd")),
);
// Invalid path will fail to join
assert_eq!(
TypedPathBuf::from("/etc").join_checked("/sneaky/path"),
Err(CheckedPathError::UnexpectedRoot),
);sourcepub fn with_file_name<S: AsRef<[u8]>>(&self, file_name: S) -> TypedPathBuf
pub fn with_file_name<S: AsRef<[u8]>>(&self, file_name: S) -> TypedPathBuf
Creates an owned TypedPathBuf like self but with the given file name.
See TypedPathBuf::set_file_name for more details.
§Examples
use typed_path::TypedPathBuf;
let path = TypedPathBuf::from("/tmp/foo.txt");
assert_eq!(path.with_file_name("bar.txt"), TypedPathBuf::from("/tmp/bar.txt"));
let path = TypedPathBuf::from("/tmp");
assert_eq!(path.with_file_name("var"), TypedPathBuf::from("/var"));sourcepub fn with_extension<S: AsRef<[u8]>>(&self, extension: S) -> TypedPathBuf
pub fn with_extension<S: AsRef<[u8]>>(&self, extension: S) -> TypedPathBuf
Creates an owned TypedPathBuf like self but with the given extension.
See TypedPathBuf::set_extension for more details.
§Examples
use typed_path::TypedPathBuf;
let path = TypedPathBuf::from("foo.rs");
assert_eq!(path.with_extension("txt"), TypedPathBuf::from("foo.txt"));
let path = TypedPathBuf::from("foo.tar.gz");
assert_eq!(path.with_extension(""), TypedPathBuf::from("foo.tar"));
assert_eq!(path.with_extension("xz"), TypedPathBuf::from("foo.tar.xz"));
assert_eq!(path.with_extension("").with_extension("txt"), TypedPathBuf::from("foo.txt"));sourcepub fn components(&self) -> TypedComponents<'_> ⓘ
pub fn components(&self) -> TypedComponents<'_> ⓘ
Produces an iterator over the TypedComponents of the path.
When parsing the path, there is a small amount of normalization:
-
Repeated separators are ignored, so
a/banda//bboth haveaandbas 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/ball haveaandbas components, but./a/bstarts with an additionalCurDircomponent. -
A trailing slash is normalized away,
/a/band/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::{TypedPathBuf, TypedComponent};
let path = TypedPathBuf::from("/tmp/foo.txt");
let mut components = path.components();
assert!(components.next().unwrap().is_root());
assert_eq!(components.next().unwrap().as_normal_bytes(), Some(b"tmp".as_slice()));
assert_eq!(components.next().unwrap().as_normal_bytes(), Some(b"foo.txt".as_slice()));
assert_eq!(components.next(), None)sourcepub fn iter(&self) -> TypedIter<'_> ⓘ
pub fn iter(&self) -> TypedIter<'_> ⓘ
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::TypedPathBuf;
let path = TypedPathBuf::from("/tmp/foo.txt");
let mut it = path.iter();
assert_eq!(it.next(), Some(typed_path::constants::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)Trait Implementations§
source§impl AsRef<[u8]> for TypedPathBuf
impl AsRef<[u8]> for TypedPathBuf
source§impl Clone for TypedPathBuf
impl Clone for TypedPathBuf
source§fn clone(&self) -> TypedPathBuf
fn clone(&self) -> TypedPathBuf
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moresource§impl Debug for TypedPathBuf
impl Debug for TypedPathBuf
source§impl<'a> From<&'a [u8]> for TypedPathBuf
impl<'a> From<&'a [u8]> for TypedPathBuf
source§fn from(s: &'a [u8]) -> Self
fn from(s: &'a [u8]) -> Self
Creates a new typed pathbuf from a byte slice by determining if the path represents a
Windows or Unix path. This is accomplished by first trying to parse as a Windows path. If
the resulting path contains a prefix such as C: or begins with a \, it is assumed to be
a WindowsPathBuf; otherwise, the slice will be represented as a UnixPathBuf.
§Examples
use typed_path::TypedPathBuf;
assert!(TypedPathBuf::from(br#"C:\some\path\to\file.txt"#).is_windows());
assert!(TypedPathBuf::from(br#"\some\path\to\file.txt"#).is_windows());
assert!(TypedPathBuf::from(br#"/some/path/to/file.txt"#).is_unix());
// NOTE: If we don't start with a backslash, it's too difficult to
// determine and we therefore just assume a Unix/POSIX path.
assert!(TypedPathBuf::from(br#"some\path\to\file.txt"#).is_unix());
assert!(TypedPathBuf::from(b"file.txt").is_unix());
assert!(TypedPathBuf::from(b"").is_unix());source§impl<'a> From<&'a str> for TypedPathBuf
impl<'a> From<&'a str> for TypedPathBuf
source§impl From<String> for TypedPathBuf
impl From<String> for TypedPathBuf
source§impl Hash for TypedPathBuf
impl Hash for TypedPathBuf
source§impl Ord for TypedPathBuf
impl Ord for TypedPathBuf
source§fn cmp(&self, other: &TypedPathBuf) -> Ordering
fn cmp(&self, other: &TypedPathBuf) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq<TypedPath<'_>> for TypedPathBuf
impl PartialEq<TypedPath<'_>> for TypedPathBuf
source§impl PartialEq<TypedPathBuf> for TypedPath<'_>
impl PartialEq<TypedPathBuf> for TypedPath<'_>
source§impl PartialEq for TypedPathBuf
impl PartialEq for TypedPathBuf
source§impl PartialOrd for TypedPathBuf
impl PartialOrd for TypedPathBuf
source§impl TryFrom<TypedPathBuf> for PathBuf
impl TryFrom<TypedPathBuf> for PathBuf
source§type Error = TypedPathBuf
type Error = TypedPathBuf
source§impl TryFrom<TypedPathBuf> for UnixPathBuf
impl TryFrom<TypedPathBuf> for UnixPathBuf
source§type Error = TypedPathBuf
type Error = TypedPathBuf
source§impl TryFrom<TypedPathBuf> for WindowsPathBuf
impl TryFrom<TypedPathBuf> for WindowsPathBuf
source§type Error = TypedPathBuf
type Error = TypedPathBuf
impl Eq for TypedPathBuf
impl StructuralPartialEq for TypedPathBuf
Auto Trait Implementations§
impl Freeze for TypedPathBuf
impl RefUnwindSafe for TypedPathBuf
impl Send for TypedPathBuf
impl Sync for TypedPathBuf
impl Unpin for TypedPathBuf
impl UnwindSafe for TypedPathBuf
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit)