Struct unix_path::PathBuf [−][src]
pub struct PathBuf { /* fields omitted */ }
An owned, mutable path (akin to String
).
This type provides methods like push
and set_extension
that mutate
the path in place. It also implements Deref
to Path
, meaning that
all methods on Path
slices are available on PathBuf
values as well.
More details about the overall approach can be found in the crate documentation.
Examples
You can use push
to build up a PathBuf
from
components:
use unix_path::PathBuf; let mut path = PathBuf::new(); path.push("/"); path.push("feel"); path.push("the"); path.set_extension("force");
However, push
is best used for dynamic situations. This is a better way
to do this when you know all of the components ahead of time:
use unix_path::PathBuf; let path: PathBuf = ["/", "feel", "the.force"].iter().collect();
We can still do better than this! Since these are all strings, we can use
From::from
:
use unix_path::PathBuf; let path = PathBuf::from(r"/feel/the.force");
Which method works best depends on what kind of situation you’re in.
Implementations
impl PathBuf
[src]
pub fn new() -> PathBuf
[src]
pub fn with_capacity(capacity: usize) -> PathBuf
[src]
Creates a new PathBuf
with a given capacity used to create the
internal UnixString
. See with_capacity
defined on UnixString
.
Examples
use unix_path::PathBuf; let mut path = PathBuf::with_capacity(10); let capacity = path.capacity(); // This push is done without reallocating path.push("/"); assert_eq!(capacity, path.capacity());
pub fn as_path(&self) -> &Path
[src]
Coerces to a Path
slice.
Examples
use unix_path::{Path, PathBuf}; let p = PathBuf::from("/test"); assert_eq!(Path::new("/test"), p.as_path());
pub fn push<P: AsRef<Path>>(&mut self, path: P)
[src]
Extends self
with path
.
If path
is absolute, it replaces the current path.
Examples
Pushing a relative path extends the existing path:
use unix_path::PathBuf; let mut path = PathBuf::from("/tmp"); path.push("file.bk"); assert_eq!(path, PathBuf::from("/tmp/file.bk"));
Pushing an absolute path replaces the existing path:
use unix_path::PathBuf; let mut path = PathBuf::from("/tmp"); path.push("/etc"); assert_eq!(path, PathBuf::from("/etc"));
pub fn pop(&mut self) -> bool
[src]
Truncates self
to self.parent
.
Returns false
and does nothing if self.parent
is None
.
Otherwise, returns true
.
Examples
use unix_path::{Path, PathBuf}; let mut p = PathBuf::from("/test/test.rs"); p.pop(); assert_eq!(Path::new("/test"), p); p.pop(); assert_eq!(Path::new("/"), p);
pub fn set_file_name<S: AsRef<UnixStr>>(&mut self, file_name: S)
[src]
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 unix_path::PathBuf; let mut buf = PathBuf::from("/"); assert!(buf.file_name() == None); buf.set_file_name("bar"); assert!(buf == PathBuf::from("/bar")); assert!(buf.file_name().is_some()); buf.set_file_name("baz.txt"); assert!(buf == PathBuf::from("/baz.txt"));
pub fn set_extension<S: AsRef<UnixStr>>(&mut self, extension: S) -> bool
[src]
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 unix_path::{Path, PathBuf}; let mut p = PathBuf::from("/feel/the"); p.set_extension("force"); assert_eq!(Path::new("/feel/the.force"), p.as_path()); p.set_extension("dark_side"); assert_eq!(Path::new("/feel/the.dark_side"), p.as_path());
pub fn into_unix_string(self) -> UnixString
[src]
Consumes the PathBuf
, yielding its internal UnixString
storage.
Examples
use unix_path::PathBuf; let p = PathBuf::from("/the/head"); let bytes = p.into_unix_string();
pub fn into_boxed_path(self) -> Box<Path>
[src]
Converts this PathBuf
into a boxed Path
.
pub fn capacity(&self) -> usize
[src]
Invokes capacity
on the underlying instance of UnixString
.
pub fn clear(&mut self)
[src]
Invokes clear
on the underlying instance of UnixString
.
pub fn reserve(&mut self, additional: usize)
[src]
Invokes reserve
on the underlying instance of UnixString
.
pub fn reserve_exact(&mut self, additional: usize)
[src]
Invokes reserve_exact
on the underlying instance of UnixString
.
pub fn shrink_to_fit(&mut self)
[src]
Invokes shrink_to_fit
on the underlying instance of UnixString
.
Methods from Deref<Target = 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 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 PathBuf
[src]
impl AsRef<UnixStr> for PathBuf
[src]
impl Borrow<Path> for PathBuf
[src]
impl Clone for PathBuf
[src]
impl Debug for PathBuf
[src]
impl Default for PathBuf
[src]
impl Deref for PathBuf
[src]
impl Eq for PathBuf
[src]
impl<P: AsRef<Path>> Extend<P> for PathBuf
[src]
fn extend<I: IntoIterator<Item = P>>(&mut self, iter: I)
[src]
pub fn extend_one(&mut self, item: A)
[src]
pub fn extend_reserve(&mut self, additional: usize)
[src]
impl<T: ?Sized + AsRef<UnixStr>> From<&'_ T> for PathBuf
[src]
impl From<Box<Path, Global>> for PathBuf
[src]
fn from(boxed: Box<Path>) -> PathBuf
[src]
Converts a Box<Path>
into a PathBuf
This conversion does not allocate or copy memory.
impl<'a> From<Cow<'a, Path>> for PathBuf
[src]
impl From<String> for PathBuf
[src]
fn from(s: String) -> PathBuf
[src]
Converts a String
into a PathBuf
This conversion does not allocate or copy memory.
impl From<UnixString> for PathBuf
[src]
fn from(s: UnixString) -> Self
[src]
Converts a UnixString
into a PathBuf
This conversion does not allocate or copy memory.
impl<P: AsRef<Path>> FromIterator<P> for PathBuf
[src]
fn from_iter<I: IntoIterator<Item = P>>(iter: I) -> PathBuf
[src]
impl FromStr for PathBuf
[src]
type Err = Infallible
The associated error which can be returned from parsing.
fn from_str(s: &str) -> Result<Self, Self::Err>
[src]
impl Hash for PathBuf
[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 PathBuf
[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?
fn into_iter(self) -> Iter<'a>ⓘ
[src]
impl Ord for PathBuf
[src]
fn cmp(&self, other: &PathBuf) -> Ordering
[src]
#[must_use]pub fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self
1.50.0[src]
impl<'a, 'b> PartialEq<&'a Path> for PathBuf
[src]
fn eq(&self, other: &&'a Path) -> bool
[src]
#[must_use]pub fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl<'a, 'b> PartialEq<Cow<'a, Path>> for PathBuf
[src]
fn eq(&self, other: &Cow<'a, Path>) -> bool
[src]
#[must_use]pub fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl<'a, 'b> PartialEq<Path> for PathBuf
[src]
impl PartialEq<PathBuf> for PathBuf
[src]
fn eq(&self, other: &PathBuf) -> bool
[src]
#[must_use]pub fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl<'a, 'b> PartialEq<PathBuf> for Path
[src]
fn eq(&self, other: &PathBuf) -> bool
[src]
#[must_use]pub fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl<'a, 'b> PartialEq<PathBuf> for &'a Path
[src]
fn eq(&self, other: &PathBuf) -> bool
[src]
#[must_use]pub fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl<'a, 'b> PartialOrd<&'a Path> for PathBuf
[src]
fn partial_cmp(&self, other: &&'a Path) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl<'a, 'b> PartialOrd<Cow<'a, Path>> for PathBuf
[src]
fn partial_cmp(&self, other: &Cow<'a, Path>) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl<'a, 'b> PartialOrd<Path> for PathBuf
[src]
fn partial_cmp(&self, other: &Path) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl PartialOrd<PathBuf> for PathBuf
[src]
fn partial_cmp(&self, other: &PathBuf) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl<'a, 'b> PartialOrd<PathBuf> for Path
[src]
fn partial_cmp(&self, other: &PathBuf) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl<'a, 'b> PartialOrd<PathBuf> for &'a Path
[src]
Auto Trait Implementations
impl RefUnwindSafe for PathBuf
impl Send for PathBuf
impl Sync for PathBuf
impl Unpin for PathBuf
impl UnwindSafe for PathBuf
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,