Struct unix_path::Path [−][src]
pub struct Path { /* fields omitted */ }
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 /
), 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
.
More details about the overall approach can be found in the crate documentation.
Examples
use unix_path::Path; use unix_str::UnixStr; let path = Path::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(UnixStr::new("bar"))); let extension = path.extension(); assert_eq!(extension, Some(UnixStr::new("txt")));
Implementations
impl Path
[src]
pub fn new<S: AsRef<UnixStr> + ?Sized>(s: &S) -> &Path
[src]
Directly wraps a string slice as a Path
slice.
This is a cost-free conversion.
Examples
use unix_path::Path; Path::new("foo.txt");
You can create Path
s from String
s, or even other Path
s:
use unix_path::Path; let string = String::from("foo.txt"); let from_string = Path::new(&string); let from_path = Path::new(&from_string); assert_eq!(from_string, from_path);
pub fn as_unix_str(&self) -> &UnixStr
[src]
Yields the underlying bytes.
Examples
use unix_path::Path; use unix_str::UnixStr; let os_str = Path::new("foo.txt").as_unix_str(); assert_eq!(os_str, UnixStr::new("foo.txt"));
pub fn to_str(&self) -> Option<&str>
[src]
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 unix_path::Path; let path = Path::new("foo.txt"); assert_eq!(path.to_str(), Some("foo.txt"));
pub fn to_string_lossy(&self) -> Cow<'_, str>
[src]
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 unix_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
[src]
Converts a Path
to an owned PathBuf
.
Examples
use unix_path::Path; let path_buf = Path::new("foo.txt").to_path_buf(); assert_eq!(path_buf, unix_path::PathBuf::from("foo.txt"));
pub fn is_absolute(&self) -> bool
[src]
Returns true
if the Path
is absolute, i.e., if it is independent of
the current directory.
A path is absolute if it starts with the root, so is_absolute
and
has_root
are equivalent.
Examples
use unix_path::Path; assert!(!Path::new("foo.txt").is_absolute());
pub fn is_relative(&self) -> bool
[src]
Returns true
if the Path
is relative, i.e., not absolute.
See is_absolute
’s documentation for more details.
Examples
use unix_path::Path; assert!(Path::new("foo.txt").is_relative());
pub fn has_root(&self) -> bool
[src]
Returns true
if the Path
has a root.
A path has a root if it begins with /
.
Examples
use unix_path::Path; assert!(Path::new("/etc/passwd").has_root());
pub fn parent(&self) -> Option<&Path>
[src]
Returns the Path
without its final component, if there is one.
Returns None
if the path terminates in a root or prefix.
Examples
use unix_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);
pub fn ancestors(&self) -> Ancestors<'_>ⓘ
[src]
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 unix_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);
pub fn file_name(&self) -> Option<&UnixStr>
[src]
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 unix_path::Path; use unix_str::UnixStr; assert_eq!(Some(UnixStr::new("bin")), Path::new("/usr/bin/").file_name()); assert_eq!(Some(UnixStr::new("foo.txt")), Path::new("tmp/foo.txt").file_name()); assert_eq!(Some(UnixStr::new("foo.txt")), Path::new("foo.txt/.").file_name()); assert_eq!(Some(UnixStr::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>,
[src]
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 unix_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_eq!(path.strip_prefix("test").is_ok(), false); assert_eq!(path.strip_prefix("/haha").is_ok(), false); let prefix = PathBuf::from("/test/"); assert_eq!(path.strip_prefix(prefix), Ok(Path::new("haha/foo.txt")));
pub fn starts_with<P: AsRef<Path>>(&self, base: P) -> bool
[src]
Determines whether base
is a prefix of self
.
Only considers whole path components to match.
Examples
use unix_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/")); assert!(!path.starts_with("/e"));
pub fn ends_with<P: AsRef<Path>>(&self, child: P) -> bool
[src]
Determines whether child
is a suffix of self
.
Only considers whole path components to match.
Examples
use unix_path::Path; let path = Path::new("/etc/passwd"); assert!(path.ends_with("passwd"));
pub fn file_stem(&self) -> Option<&UnixStr>
[src]
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 unix_path::Path; let path = Path::new("foo.rs"); assert_eq!("foo", path.file_stem().unwrap());
pub fn extension(&self) -> Option<&UnixStr>
[src]
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 unix_path::Path; use unix_str::UnixStr; let path = Path::new("foo.rs"); assert_eq!(UnixStr::new("rs"), path.extension().unwrap());
#[must_use]pub fn join<P: AsRef<Path>>(&self, path: P) -> PathBuf
[src]
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 unix_path::{Path, PathBuf}; assert_eq!(Path::new("/etc").join("passwd"), PathBuf::from("/etc/passwd"));
pub fn with_file_name<S: AsRef<UnixStr>>(&self, file_name: S) -> PathBuf
[src]
Creates an owned PathBuf
like self
but with the given file name.
See PathBuf::set_file_name
for more details.
Examples
use unix_path::{Path, PathBuf}; let path = Path::new("/tmp/foo.txt"); 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: AsRef<UnixStr>>(&self, extension: S) -> PathBuf
[src]
Creates an owned PathBuf
like self
but with the given extension.
See PathBuf::set_extension
for more details.
Examples
use unix_path::{Path, PathBuf}; let path = Path::new("foo.rs"); assert_eq!(path.with_extension("txt"), PathBuf::from("foo.txt"));
pub fn components(&self) -> Components<'_>ⓘNotable traits for Components<'a>
impl<'a> Iterator for Components<'a> type Item = Component<'a>;
[src]
Notable traits for Components<'a>
impl<'a> Iterator for Components<'a> type Item = Component<'a>;
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 unix_path::{Path, Component}; use unix_str::UnixStr; let mut components = Path::new("/tmp/foo.txt").components(); assert_eq!(components.next(), Some(Component::RootDir)); assert_eq!(components.next(), Some(Component::Normal(UnixStr::new("tmp")))); assert_eq!(components.next(), Some(Component::Normal(UnixStr::new("foo.txt")))); assert_eq!(components.next(), None)
pub fn iter(&self) -> Iter<'_>ⓘ
[src]
Produces an iterator over the path’s components viewed as UnixStr
slices.
For more information about the particulars of how the path is separated
into components, see components
.
Examples
use unix_path::{self, Path}; use unix_str::UnixStr; let mut it = Path::new("/tmp/foo.txt").iter(); assert_eq!(it.next(), Some(UnixStr::new("/"))); assert_eq!(it.next(), Some(UnixStr::new("tmp"))); assert_eq!(it.next(), Some(UnixStr::new("foo.txt"))); assert_eq!(it.next(), None)
pub fn into_path_buf(self: Box<Path>) -> PathBuf
[src]
Converts a Box<Path>
into a PathBuf
without copying or
allocating.
pub fn display(&self) -> Display<'_>
[src]
Returns a newtype that implements Display for safely printing paths that may contain non-Unicode data.
Trait Implementations
impl AsRef<Path> for Component<'_>
[src]
impl AsRef<Path> for Components<'_>
[src]
impl AsRef<Path> for Iter<'_>
[src]
impl AsRef<Path> for Path
[src]
impl AsRef<Path> for PathBuf
[src]
impl AsRef<UnixStr> for Path
[src]
impl Borrow<Path> for PathBuf
[src]
impl Debug for Path
[src]
impl Eq for Path
[src]
impl Hash for Path
[src]
fn hash<H: Hasher>(&self, h: &mut H)
[src]
pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl<'a> IntoIterator for &'a Path
[src]
type Item = &'a UnixStr
The type of the elements being iterated over.
type IntoIter = Iter<'a>
Which kind of iterator are we turning this into?