Struct rasi_syscall::path::PathBuf
source · pub struct PathBuf { /* private fields */ }
Expand description
This struct is an async version of std::path::PathBuf
.
Implementations§
source§impl PathBuf
impl PathBuf
sourcepub fn push<P: AsRef<Path>>(&mut self, path: P)
pub fn push<P: AsRef<Path>>(&mut self, path: P)
Extends self
with path
.
If path
is absolute, it replaces the current path.
On Windows:
- if
path
has a root but no prefix (e.g.,\windows
), it replaces everything except for the prefix (if any) ofself
. - if
path
has a prefix but no root, it replacesself
.
§Examples
Pushing a relative path extends the existing path:
use rasi_syscall::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 rasi_syscall::path::PathBuf;
let mut path = PathBuf::from("/tmp");
path.push("/etc");
assert_eq!(path, PathBuf::from("/etc"));
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 rasi_syscall::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);
sourcepub fn set_file_name<S: AsRef<OsStr>>(&mut self, file_name: S)
pub fn set_file_name<S: AsRef<OsStr>>(&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 rasi_syscall::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"));
sourcepub fn set_extension<S: AsRef<OsStr>>(&mut self, extension: S) -> bool
pub fn set_extension<S: AsRef<OsStr>>(&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 rasi_syscall::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());
sourcepub fn into_os_string(self) -> OsString
pub fn into_os_string(self) -> OsString
Methods from Deref<Target = Path>§
sourcepub fn to_str(&self) -> Option<&str>
pub fn to_str(&self) -> Option<&str>
Returns 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 rasi_syscall::path::Path;
let path = Path::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 rasi_syscall::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"
.
sourcepub fn to_path_buf(&self) -> PathBuf
pub fn to_path_buf(&self) -> PathBuf
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, a path is absolute if it starts with the root, so
is_absolute
andhas_root
are equivalent. -
On Windows, 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 rasi_syscall::path::Path;
assert!(!Path::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 rasi_syscall::path::Path;
assert!(Path::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, 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 notc:windows
- has any non-disk prefix, e.g.
\\server\share
- has no prefix and begins with a separator, e.g.
§Examples
use rasi_syscall::path::Path;
assert!(Path::new("/etc/passwd").has_root());
sourcepub fn parent(&self) -> Option<&Path>
pub fn parent(&self) -> Option<&Path>
Returns the Path
without its final component, if there is one.
Returns None
if the path terminates in a root or prefix.
§Examples
use rasi_syscall::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);
sourcepub fn ancestors(&self) -> Ancestors<'_> ⓘ
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. 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 rasi_syscall::path::Path;
let mut ancestors = Path::new("/foo/bar").ancestors();
assert_eq!(ancestors.next(), Some(Path::new("/foo/bar").into()));
assert_eq!(ancestors.next(), Some(Path::new("/foo").into()));
assert_eq!(ancestors.next(), Some(Path::new("/").into()));
assert_eq!(ancestors.next(), None);
sourcepub fn file_name(&self) -> Option<&OsStr>
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::ffi::OsStr;
use rasi_syscall::path::Path;
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());
sourcepub fn strip_prefix<P>(&self, base: P) -> Result<&Path, StripPrefixError>
pub fn strip_prefix<P>(&self, base: P) -> Result<&Path, StripPrefixError>
Returns a path that becomes self
when joined onto base
.
§Errors
If base
is not a prefix of self
(i.e., starts_with
returns false
), returns Err
.
§Examples
use rasi_syscall::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")));
sourcepub fn starts_with<P: AsRef<Path>>(&self, base: P) -> bool
pub fn starts_with<P: AsRef<Path>>(&self, base: P) -> bool
Determines whether base
is a prefix of self
.
Only considers whole path components to match.
§Examples
use rasi_syscall::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"));
sourcepub fn ends_with<P: AsRef<Path>>(&self, child: P) -> bool
pub fn ends_with<P: AsRef<Path>>(&self, child: P) -> bool
Determines whether child
is a suffix of self
.
Only considers whole path components to match.
§Examples
use rasi_syscall::path::Path;
let path = Path::new("/etc/passwd");
assert!(path.ends_with("passwd"));
sourcepub fn file_stem(&self) -> Option<&OsStr>
pub fn file_stem(&self) -> Option<&OsStr>
Extracts the stem (non-extension) portion of 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 rasi_syscall::path::Path;
let path = Path::new("foo.rs");
assert_eq!("foo", path.file_stem().unwrap());
sourcepub fn extension(&self) -> Option<&OsStr>
pub fn extension(&self) -> Option<&OsStr>
Extracts the extension of file_name
, if possible.
The extension is:
None
, if there is no file nameNone
, 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 rasi_syscall::path::Path;
let path = Path::new("foo.rs");
assert_eq!("rs", path.extension().unwrap());
sourcepub fn join<P: AsRef<Path>>(&self, path: P) -> PathBuf
pub fn join<P: AsRef<Path>>(&self, path: P) -> PathBuf
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 rasi_syscall::path::{Path, PathBuf};
assert_eq!(Path::new("/etc").join("passwd"), PathBuf::from("/etc/passwd"));
sourcepub fn with_file_name<S: AsRef<OsStr>>(&self, file_name: S) -> PathBuf
pub fn with_file_name<S: AsRef<OsStr>>(&self, file_name: S) -> PathBuf
Creates an owned PathBuf
like self
but with the given file name.
See PathBuf::set_file_name
for more details.
§Examples
use rasi_syscall::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"));
sourcepub fn with_extension<S: AsRef<OsStr>>(&self, extension: S) -> PathBuf
pub fn with_extension<S: AsRef<OsStr>>(&self, extension: S) -> PathBuf
Creates an owned PathBuf
like self
but with the given extension.
See PathBuf::set_extension
for more details.
§Examples
use rasi_syscall::path::{Path, PathBuf};
let path = Path::new("foo.rs");
assert_eq!(path.with_extension("txt"), PathBuf::from("foo.txt"));
sourcepub fn components(&self) -> Components<'_> ⓘ
pub fn components(&self) -> 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 std::ffi::OsStr;
use rasi_syscall::path::{Path, Component};
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);
sourcepub fn iter(&self) -> Iter<'_> ⓘ
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::ffi::OsStr;
use rasi_syscall::path::{self, Path};
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)
Trait Implementations§
source§impl<P: AsRef<Path>> Extend<P> for PathBuf
impl<P: AsRef<Path>> Extend<P> for PathBuf
source§fn extend<I: IntoIterator<Item = P>>(&mut self, iter: I)
fn extend<I: IntoIterator<Item = P>>(&mut self, iter: I)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl<'a> IntoIterator for &'a PathBuf
impl<'a> IntoIterator for &'a PathBuf
source§impl Ord for PathBuf
impl Ord for PathBuf
source§impl<'a, 'b> PartialEq<&'a OsStr> for PathBuf
impl<'a, 'b> PartialEq<&'a OsStr> for PathBuf
source§impl<'a, 'b> PartialEq<&'a Path> for PathBuf
impl<'a, 'b> PartialEq<&'a Path> for PathBuf
source§impl<'a, 'b> PartialEq<Cow<'a, OsStr>> for PathBuf
impl<'a, 'b> PartialEq<Cow<'a, OsStr>> for PathBuf
source§impl<'a, 'b> PartialEq<Cow<'a, Path>> for PathBuf
impl<'a, 'b> PartialEq<Cow<'a, Path>> for PathBuf
source§impl<'a, 'b> PartialEq<OsStr> for PathBuf
impl<'a, 'b> PartialEq<OsStr> for PathBuf
source§impl<'a, 'b> PartialEq<OsString> for PathBuf
impl<'a, 'b> PartialEq<OsString> for PathBuf
source§impl<'a, 'b> PartialEq<Path> for PathBuf
impl<'a, 'b> PartialEq<Path> for PathBuf
source§impl<'a, 'b> PartialEq<PathBuf> for &'a OsStr
impl<'a, 'b> PartialEq<PathBuf> for &'a OsStr
source§impl<'a, 'b> PartialEq<PathBuf> for &'a Path
impl<'a, 'b> PartialEq<PathBuf> for &'a Path
source§impl<'a, 'b> PartialEq<PathBuf> for Cow<'a, OsStr>
impl<'a, 'b> PartialEq<PathBuf> for Cow<'a, OsStr>
source§impl<'a, 'b> PartialEq<PathBuf> for Cow<'a, Path>
impl<'a, 'b> PartialEq<PathBuf> for Cow<'a, Path>
source§impl<'a, 'b> PartialEq<PathBuf> for OsStr
impl<'a, 'b> PartialEq<PathBuf> for OsStr
source§impl<'a, 'b> PartialEq<PathBuf> for OsString
impl<'a, 'b> PartialEq<PathBuf> for OsString
source§impl<'a, 'b> PartialEq<PathBuf> for Path
impl<'a, 'b> PartialEq<PathBuf> for Path
source§impl PartialEq for PathBuf
impl PartialEq for PathBuf
source§impl<'a, 'b> PartialOrd<&'a OsStr> for PathBuf
impl<'a, 'b> PartialOrd<&'a OsStr> for PathBuf
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> PartialOrd<&'a Path> for PathBuf
impl<'a, 'b> PartialOrd<&'a Path> for PathBuf
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> PartialOrd<Cow<'a, OsStr>> for PathBuf
impl<'a, 'b> PartialOrd<Cow<'a, OsStr>> for PathBuf
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> PartialOrd<Cow<'a, Path>> for PathBuf
impl<'a, 'b> PartialOrd<Cow<'a, Path>> for PathBuf
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> PartialOrd<OsStr> for PathBuf
impl<'a, 'b> PartialOrd<OsStr> for PathBuf
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> PartialOrd<OsString> for PathBuf
impl<'a, 'b> PartialOrd<OsString> for PathBuf
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> PartialOrd<Path> for PathBuf
impl<'a, 'b> PartialOrd<Path> for PathBuf
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> PartialOrd<PathBuf> for &'a OsStr
impl<'a, 'b> PartialOrd<PathBuf> for &'a OsStr
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> PartialOrd<PathBuf> for &'a Path
impl<'a, 'b> PartialOrd<PathBuf> for &'a Path
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> PartialOrd<PathBuf> for Cow<'a, OsStr>
impl<'a, 'b> PartialOrd<PathBuf> for Cow<'a, OsStr>
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> PartialOrd<PathBuf> for Cow<'a, Path>
impl<'a, 'b> PartialOrd<PathBuf> for Cow<'a, Path>
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> PartialOrd<PathBuf> for OsStr
impl<'a, 'b> PartialOrd<PathBuf> for OsStr
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> PartialOrd<PathBuf> for OsString
impl<'a, 'b> PartialOrd<PathBuf> for OsString
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> PartialOrd<PathBuf> for Path
impl<'a, 'b> PartialOrd<PathBuf> for Path
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 PartialOrd for PathBuf
impl PartialOrd for PathBuf
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 more