pub struct Utf8Path(/* private fields */);
Expand description
A slice of a UTF-8 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 Utf8PathBuf
.
§Examples
use camino::Utf8Path;
// Note: this example does work on Windows
let path = Utf8Path::new("./foo/bar.txt");
let parent = path.parent();
assert_eq!(parent, Some(Utf8Path::new("./foo")));
let file_stem = path.file_stem();
assert_eq!(file_stem, Some("bar"));
let extension = path.extension();
assert_eq!(extension, Some("txt"));
Implementations§
Source§impl Utf8Path
impl Utf8Path
Sourcepub fn new(s: &(impl AsRef<str> + ?Sized)) -> &Utf8Path
pub fn new(s: &(impl AsRef<str> + ?Sized)) -> &Utf8Path
Directly wraps a string slice as a Utf8Path
slice.
This is a cost-free conversion.
§Examples
use camino::Utf8Path;
Utf8Path::new("foo.txt");
You can create Utf8Path
s from String
s, or even other Utf8Path
s:
use camino::Utf8Path;
let string = String::from("foo.txt");
let from_string = Utf8Path::new(&string);
let from_path = Utf8Path::new(&from_string);
assert_eq!(from_string, from_path);
Sourcepub fn from_path(path: &Path) -> Option<&Utf8Path>
pub fn from_path(path: &Path) -> Option<&Utf8Path>
Converts a Path
to a Utf8Path
.
Returns None
if the path is not valid UTF-8.
For a version that returns a type that implements std::error::Error
, use the
TryFrom<&Path>
impl.
§Examples
use camino::Utf8Path;
use std::ffi::OsStr;
use std::os::unix::ffi::OsStrExt;
use std::path::Path;
let unicode_path = Path::new("/valid/unicode");
Utf8Path::from_path(unicode_path).expect("valid Unicode path succeeded");
// Paths on Unix can be non-UTF-8.
let non_unicode_str = OsStr::from_bytes(b"\xFF\xFF\xFF");
let non_unicode_path = Path::new(non_unicode_str);
assert!(Utf8Path::from_path(non_unicode_path).is_none(), "non-Unicode path failed");
Sourcepub fn as_std_path(&self) -> &Path
pub fn as_std_path(&self) -> &Path
Converts a Utf8Path
to a Path
.
This is equivalent to the AsRef<&Path> for &Utf8Path
impl, but may aid in type inference.
§Examples
use camino::Utf8Path;
use std::path::Path;
let utf8_path = Utf8Path::new("foo.txt");
let std_path: &Path = utf8_path.as_std_path();
assert_eq!(std_path.to_str(), Some("foo.txt"));
// Convert back to a Utf8Path.
let new_utf8_path = Utf8Path::from_path(std_path).unwrap();
assert_eq!(new_utf8_path, "foo.txt");
Sourcepub fn as_str(&self) -> &str
pub fn as_str(&self) -> &str
Yields the underlying str
slice.
Unlike Path::to_str
, this always returns a slice because the contents of a Utf8Path
are guaranteed to be valid UTF-8.
§Examples
use camino::Utf8Path;
let s = Utf8Path::new("foo.txt").as_str();
assert_eq!(s, "foo.txt");
Sourcepub fn to_path_buf(&self) -> Utf8PathBuf
pub fn to_path_buf(&self) -> Utf8PathBuf
Converts a Utf8Path
to an owned Utf8PathBuf
.
§Examples
use camino::{Utf8Path, Utf8PathBuf};
let path_buf = Utf8Path::new("foo.txt").to_path_buf();
assert_eq!(path_buf, Utf8PathBuf::from("foo.txt"));
Sourcepub fn is_absolute(&self) -> bool
pub fn is_absolute(&self) -> bool
Returns true
if the Utf8Path
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 camino::Utf8Path;
assert!(!Utf8Path::new("foo.txt").is_absolute());
Sourcepub fn is_relative(&self) -> bool
pub fn is_relative(&self) -> bool
Returns true
if the Utf8Path
is relative, i.e., not absolute.
See is_absolute
’s documentation for more details.
§Examples
use camino::Utf8Path;
assert!(Utf8Path::new("foo.txt").is_relative());
Sourcepub fn has_root(&self) -> bool
pub fn has_root(&self) -> bool
Returns true
if the Utf8Path
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 camino::Utf8Path;
assert!(Utf8Path::new("/etc/passwd").has_root());
Sourcepub fn parent(&self) -> Option<&Utf8Path>
pub fn parent(&self) -> Option<&Utf8Path>
Returns the Path
without its final component, if there is one.
Returns None
if the path terminates in a root or prefix.
§Examples
use camino::Utf8Path;
let path = Utf8Path::new("/foo/bar");
let parent = path.parent().unwrap();
assert_eq!(parent, Utf8Path::new("/foo"));
let grand_parent = parent.parent().unwrap();
assert_eq!(grand_parent, Utf8Path::new("/"));
assert_eq!(grand_parent.parent(), None);
Sourcepub fn ancestors(&self) -> Utf8Ancestors<'_> ⓘ
pub fn ancestors(&self) -> Utf8Ancestors<'_> ⓘ
Produces an iterator over Utf8Path
and its ancestors.
The iterator will yield the Utf8Path
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 camino::Utf8Path;
let mut ancestors = Utf8Path::new("/foo/bar").ancestors();
assert_eq!(ancestors.next(), Some(Utf8Path::new("/foo/bar")));
assert_eq!(ancestors.next(), Some(Utf8Path::new("/foo")));
assert_eq!(ancestors.next(), Some(Utf8Path::new("/")));
assert_eq!(ancestors.next(), None);
let mut ancestors = Utf8Path::new("../foo/bar").ancestors();
assert_eq!(ancestors.next(), Some(Utf8Path::new("../foo/bar")));
assert_eq!(ancestors.next(), Some(Utf8Path::new("../foo")));
assert_eq!(ancestors.next(), Some(Utf8Path::new("..")));
assert_eq!(ancestors.next(), Some(Utf8Path::new("")));
assert_eq!(ancestors.next(), None);
Sourcepub fn file_name(&self) -> Option<&str>
pub fn file_name(&self) -> Option<&str>
Returns the final component of the Utf8Path
, 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 camino::Utf8Path;
assert_eq!(Some("bin"), Utf8Path::new("/usr/bin/").file_name());
assert_eq!(Some("foo.txt"), Utf8Path::new("tmp/foo.txt").file_name());
assert_eq!(Some("foo.txt"), Utf8Path::new("foo.txt/.").file_name());
assert_eq!(Some("foo.txt"), Utf8Path::new("foo.txt/.//").file_name());
assert_eq!(None, Utf8Path::new("foo.txt/..").file_name());
assert_eq!(None, Utf8Path::new("/").file_name());
Sourcepub fn strip_prefix(
&self,
base: impl AsRef<Path>,
) -> Result<&Utf8Path, StripPrefixError>
pub fn strip_prefix( &self, base: impl AsRef<Path>, ) -> Result<&Utf8Path, 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 camino::{Utf8Path, Utf8PathBuf};
let path = Utf8Path::new("/test/haha/foo.txt");
assert_eq!(path.strip_prefix("/"), Ok(Utf8Path::new("test/haha/foo.txt")));
assert_eq!(path.strip_prefix("/test"), Ok(Utf8Path::new("haha/foo.txt")));
assert_eq!(path.strip_prefix("/test/"), Ok(Utf8Path::new("haha/foo.txt")));
assert_eq!(path.strip_prefix("/test/haha/foo.txt"), Ok(Utf8Path::new("")));
assert_eq!(path.strip_prefix("/test/haha/foo.txt/"), Ok(Utf8Path::new("")));
assert!(path.strip_prefix("test").is_err());
assert!(path.strip_prefix("/haha").is_err());
let prefix = Utf8PathBuf::from("/test/");
assert_eq!(path.strip_prefix(prefix), Ok(Utf8Path::new("haha/foo.txt")));
Sourcepub fn starts_with(&self, base: impl AsRef<Path>) -> bool
pub fn starts_with(&self, base: impl AsRef<Path>) -> bool
Determines whether base
is a prefix of self
.
Only considers whole path components to match.
§Examples
use camino::Utf8Path;
let path = Utf8Path::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!(!Utf8Path::new("/etc/foo.rs").starts_with("/etc/foo"));
Sourcepub fn ends_with(&self, base: impl AsRef<Path>) -> bool
pub fn ends_with(&self, base: impl AsRef<Path>) -> bool
Determines whether child
is a suffix of self
.
Only considers whole path components to match.
§Examples
use camino::Utf8Path;
let path = Utf8Path::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<&str>
pub fn file_stem(&self) -> Option<&str>
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 camino::Utf8Path;
assert_eq!("foo", Utf8Path::new("foo.rs").file_stem().unwrap());
assert_eq!("foo.tar", Utf8Path::new("foo.tar.gz").file_stem().unwrap());
Sourcepub fn extension(&self) -> Option<&str>
pub fn extension(&self) -> Option<&str>
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 camino::Utf8Path;
assert_eq!("rs", Utf8Path::new("foo.rs").extension().unwrap());
assert_eq!("gz", Utf8Path::new("foo.tar.gz").extension().unwrap());
Sourcepub fn join(&self, path: impl AsRef<Utf8Path>) -> Utf8PathBuf
pub fn join(&self, path: impl AsRef<Utf8Path>) -> Utf8PathBuf
Creates an owned Utf8PathBuf
with path
adjoined to self
.
See Utf8PathBuf::push
for more details on what it means to adjoin a path.
§Examples
use camino::{Utf8Path, Utf8PathBuf};
assert_eq!(Utf8Path::new("/etc").join("passwd"), Utf8PathBuf::from("/etc/passwd"));
Sourcepub fn join_os(&self, path: impl AsRef<Path>) -> PathBuf
pub fn join_os(&self, path: impl AsRef<Path>) -> 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 camino::Utf8Path;
use std::path::PathBuf;
assert_eq!(Utf8Path::new("/etc").join_os("passwd"), PathBuf::from("/etc/passwd"));
Sourcepub fn with_file_name(&self, file_name: impl AsRef<str>) -> Utf8PathBuf
pub fn with_file_name(&self, file_name: impl AsRef<str>) -> Utf8PathBuf
Creates an owned Utf8PathBuf
like self
but with the given file name.
See Utf8PathBuf::set_file_name
for more details.
§Examples
use camino::{Utf8Path, Utf8PathBuf};
let path = Utf8Path::new("/tmp/foo.txt");
assert_eq!(path.with_file_name("bar.txt"), Utf8PathBuf::from("/tmp/bar.txt"));
let path = Utf8Path::new("/tmp");
assert_eq!(path.with_file_name("var"), Utf8PathBuf::from("/var"));
Sourcepub fn with_extension(&self, extension: impl AsRef<str>) -> Utf8PathBuf
pub fn with_extension(&self, extension: impl AsRef<str>) -> Utf8PathBuf
Creates an owned Utf8PathBuf
like self
but with the given extension.
See Utf8PathBuf::set_extension
for more details.
§Examples
use camino::{Utf8Path, Utf8PathBuf};
let path = Utf8Path::new("foo.rs");
assert_eq!(path.with_extension("txt"), Utf8PathBuf::from("foo.txt"));
let path = Utf8Path::new("foo.tar.gz");
assert_eq!(path.with_extension(""), Utf8PathBuf::from("foo.tar"));
assert_eq!(path.with_extension("xz"), Utf8PathBuf::from("foo.tar.xz"));
assert_eq!(path.with_extension("").with_extension("txt"), Utf8PathBuf::from("foo.txt"));
Sourcepub fn components(&self) -> Utf8Components<'_> ⓘ
pub fn components(&self) -> Utf8Components<'_> ⓘ
Produces an iterator over the Utf8Component
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 camino::{Utf8Component, Utf8Path};
let mut components = Utf8Path::new("/tmp/foo.txt").components();
assert_eq!(components.next(), Some(Utf8Component::RootDir));
assert_eq!(components.next(), Some(Utf8Component::Normal("tmp")));
assert_eq!(components.next(), Some(Utf8Component::Normal("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 str
slices.
For more information about the particulars of how the path is separated
into components, see components
.
§Examples
use camino::Utf8Path;
let mut it = Utf8Path::new("/tmp/foo.txt").iter();
assert_eq!(it.next(), Some(std::path::MAIN_SEPARATOR.to_string().as_str()));
assert_eq!(it.next(), Some("tmp"));
assert_eq!(it.next(), Some("foo.txt"));
assert_eq!(it.next(), None)
Sourcepub fn metadata(&self) -> Result<Metadata>
pub fn metadata(&self) -> Result<Metadata>
Queries the file system to get information about a file, directory, etc.
This function will traverse symbolic links to query information about the destination file.
This is an alias to fs::metadata
.
§Examples
use camino::Utf8Path;
let path = Utf8Path::new("/Minas/tirith");
let metadata = path.metadata().expect("metadata call failed");
println!("{:?}", metadata.file_type());
Sourcepub fn symlink_metadata(&self) -> Result<Metadata>
pub fn symlink_metadata(&self) -> Result<Metadata>
Queries the metadata about a file without following symlinks.
This is an alias to fs::symlink_metadata
.
§Examples
use camino::Utf8Path;
let path = Utf8Path::new("/Minas/tirith");
let metadata = path.symlink_metadata().expect("symlink_metadata call failed");
println!("{:?}", metadata.file_type());
Sourcepub fn canonicalize(&self) -> Result<PathBuf>
pub fn canonicalize(&self) -> Result<PathBuf>
Returns the canonical, absolute form of the path with all intermediate components normalized and symbolic links resolved.
This returns a PathBuf
because even if a symlink is valid Unicode, its target may not
be. For a version that returns a Utf8PathBuf
, see
canonicalize_utf8
.
This is an alias to fs::canonicalize
.
§Examples
use camino::Utf8Path;
use std::path::PathBuf;
let path = Utf8Path::new("/foo/test/../test/bar.rs");
assert_eq!(path.canonicalize().unwrap(), PathBuf::from("/foo/test/bar.rs"));
Sourcepub fn canonicalize_utf8(&self) -> Result<Utf8PathBuf>
pub fn canonicalize_utf8(&self) -> Result<Utf8PathBuf>
Returns the canonical, absolute form of the path with all intermediate components normalized and symbolic links resolved.
This method attempts to convert the resulting PathBuf
into a Utf8PathBuf
. For a
version that does not attempt to do this conversion, see
canonicalize
.
§Errors
The I/O operation may return an error: see the fs::canonicalize
documentation for more.
If the resulting path is not UTF-8, an io::Error
is returned with the
ErrorKind
set to InvalidData
and the payload set to a
FromPathBufError
.
§Examples
use camino::{Utf8Path, Utf8PathBuf};
let path = Utf8Path::new("/foo/test/../test/bar.rs");
assert_eq!(path.canonicalize_utf8().unwrap(), Utf8PathBuf::from("/foo/test/bar.rs"));
Sourcepub fn read_link(&self) -> Result<PathBuf>
pub fn read_link(&self) -> Result<PathBuf>
Reads a symbolic link, returning the file that the link points to.
This returns a PathBuf
because even if a symlink is valid Unicode, its target may not
be. For a version that returns a Utf8PathBuf
, see
read_link_utf8
.
This is an alias to fs::read_link
.
§Examples
use camino::Utf8Path;
let path = Utf8Path::new("/laputa/sky_castle.rs");
let path_link = path.read_link().expect("read_link call failed");
Sourcepub fn read_link_utf8(&self) -> Result<Utf8PathBuf>
pub fn read_link_utf8(&self) -> Result<Utf8PathBuf>
Reads a symbolic link, returning the file that the link points to.
This method attempts to convert the resulting PathBuf
into a Utf8PathBuf
. For a
version that does not attempt to do this conversion, see read_link
.
§Errors
The I/O operation may return an error: see the fs::read_link
documentation for more.
If the resulting path is not UTF-8, an io::Error
is returned with the
ErrorKind
set to InvalidData
and the payload set to a
FromPathBufError
.
§Examples
use camino::Utf8Path;
let path = Utf8Path::new("/laputa/sky_castle.rs");
let path_link = path.read_link_utf8().expect("read_link call failed");
Sourcepub fn read_dir(&self) -> Result<ReadDir>
pub fn read_dir(&self) -> Result<ReadDir>
Returns an iterator over the entries within a directory.
The iterator will yield instances of io::Result
<
fs::DirEntry
>
. New
errors may be encountered after an iterator is initially constructed.
This is an alias to fs::read_dir
.
§Examples
use camino::Utf8Path;
let path = Utf8Path::new("/laputa");
for entry in path.read_dir().expect("read_dir call failed") {
if let Ok(entry) = entry {
println!("{:?}", entry.path());
}
}
Sourcepub fn read_dir_utf8(&self) -> Result<ReadDirUtf8>
pub fn read_dir_utf8(&self) -> Result<ReadDirUtf8>
Returns an iterator over the entries within a directory.
The iterator will yield instances of io::Result
<
Utf8DirEntry
>
. New
errors may be encountered after an iterator is initially constructed.
§Errors
The I/O operation may return an error: see the fs::read_dir
documentation for more.
If a directory entry is not UTF-8, an io::Error
is returned with the
ErrorKind
set to InvalidData
and the payload set to a
FromPathBufError
.
§Examples
use camino::Utf8Path;
let path = Utf8Path::new("/laputa");
for entry in path.read_dir_utf8().expect("read_dir call failed") {
if let Ok(entry) = entry {
println!("{}", entry.path());
}
}
Sourcepub fn exists(&self) -> bool
pub fn exists(&self) -> bool
Returns true
if the path points at an existing entity.
Warning: this method may be error-prone, consider using try_exists()
instead!
It also has a risk of introducing time-of-check to time-of-use (TOCTOU) bugs.
This function will traverse symbolic links to query information about the
destination file. In case of broken symbolic links this will return false
.
If you cannot access the directory containing the file, e.g., because of a
permission error, this will return false
.
§Examples
use camino::Utf8Path;
assert!(!Utf8Path::new("does_not_exist.txt").exists());
§See Also
This is a convenience function that coerces errors to false. If you want to
check errors, call fs::metadata
.
Sourcepub fn try_exists(&self) -> Result<bool>
pub fn try_exists(&self) -> Result<bool>
Returns Ok(true)
if the path points at an existing entity.
This function will traverse symbolic links to query information about the
destination file. In case of broken symbolic links this will return Ok(false)
.
As opposed to the exists()
method, this one doesn’t silently ignore errors
unrelated to the path not existing. (E.g. it will return Err(_)
in case of permission
denied on some of the parent directories.)
Note that while this avoids some pitfalls of the exists()
method, it still can not
prevent time-of-check to time-of-use (TOCTOU) bugs. You should only use it in scenarios
where those bugs are not an issue.
§Examples
use camino::Utf8Path;
assert!(!Utf8Path::new("does_not_exist.txt").try_exists().expect("Can't check existence of file does_not_exist.txt"));
assert!(Utf8Path::new("/root/secret_file.txt").try_exists().is_err());
Sourcepub fn is_file(&self) -> bool
pub fn is_file(&self) -> bool
Returns true
if the path exists on disk and is pointing at a regular file.
This function will traverse symbolic links to query information about the
destination file. In case of broken symbolic links this will return false
.
If you cannot access the directory containing the file, e.g., because of a
permission error, this will return false
.
§Examples
use camino::Utf8Path;
assert_eq!(Utf8Path::new("./is_a_directory/").is_file(), false);
assert_eq!(Utf8Path::new("a_file.txt").is_file(), true);
§See Also
This is a convenience function that coerces errors to false. If you want to
check errors, call fs::metadata
and handle its Result
. Then call
fs::Metadata::is_file
if it was Ok
.
When the goal is simply to read from (or write to) the source, the most
reliable way to test the source can be read (or written to) is to open
it. Only using is_file
can break workflows like diff <( prog_a )
on
a Unix-like system for example. See fs::File::open
or
fs::OpenOptions::open
for more information.
Sourcepub fn is_dir(&self) -> bool
pub fn is_dir(&self) -> bool
Returns true
if the path exists on disk and is pointing at a directory.
This function will traverse symbolic links to query information about the
destination file. In case of broken symbolic links this will return false
.
If you cannot access the directory containing the file, e.g., because of a
permission error, this will return false
.
§Examples
use camino::Utf8Path;
assert_eq!(Utf8Path::new("./is_a_directory/").is_dir(), true);
assert_eq!(Utf8Path::new("a_file.txt").is_dir(), false);
§See Also
This is a convenience function that coerces errors to false. If you want to
check errors, call fs::metadata
and handle its Result
. Then call
fs::Metadata::is_dir
if it was Ok
.
Sourcepub fn is_symlink(&self) -> bool
pub fn is_symlink(&self) -> bool
Returns true
if the path exists on disk and is pointing at a symbolic link.
This function will not traverse symbolic links. In case of a broken symbolic link this will also return true.
If you cannot access the directory containing the file, e.g., because of a permission error, this will return false.
§Examples
use camino::Utf8Path;
use std::os::unix::fs::symlink;
let link_path = Utf8Path::new("link");
symlink("/origin_does_not_exist/", link_path).unwrap();
assert_eq!(link_path.is_symlink(), true);
assert_eq!(link_path.exists(), false);
§See Also
This is a convenience function that coerces errors to false. If you want to
check errors, call Utf8Path::symlink_metadata
and handle its Result
. Then call
fs::Metadata::is_symlink
if it was Ok
.
Sourcepub fn into_path_buf(self: Box<Utf8Path>) -> Utf8PathBuf
pub fn into_path_buf(self: Box<Utf8Path>) -> Utf8PathBuf
Converts a Box<Utf8Path>
into a Utf8PathBuf
without copying or allocating.
Trait Implementations§
Source§impl AsRef<Utf8Path> for Utf8Component<'_>
impl AsRef<Utf8Path> for Utf8Component<'_>
Source§impl AsRef<Utf8Path> for Utf8Components<'_>
impl AsRef<Utf8Path> for Utf8Components<'_>
Source§impl AsRef<Utf8Path> for Utf8PathBuf
impl AsRef<Utf8Path> for Utf8PathBuf
Source§impl Borrow<Utf8Path> for Utf8PathBuf
impl Borrow<Utf8Path> for Utf8PathBuf
Source§impl<'de: 'a, 'a> Deserialize<'de> for &'a Utf8Path
Available on crate feature serde1
only.
impl<'de: 'a, 'a> Deserialize<'de> for &'a Utf8Path
serde1
only.Source§fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
Source§impl<'de> Deserialize<'de> for Box<Utf8Path>
Available on crate feature serde1
only.
impl<'de> Deserialize<'de> for Box<Utf8Path>
serde1
only.Source§fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
Source§impl<'a> IntoIterator for &'a Utf8Path
impl<'a> IntoIterator for &'a Utf8Path
Source§impl<'a, 'b> PartialEq<&'a Utf8Path> for Utf8PathBuf
impl<'a, 'b> PartialEq<&'a Utf8Path> for Utf8PathBuf
Source§impl<'a, 'b> PartialEq<Utf8Path> for Utf8PathBuf
impl<'a, 'b> PartialEq<Utf8Path> for Utf8PathBuf
Source§impl<'a, 'b> PartialEq<Utf8PathBuf> for &'a Utf8Path
impl<'a, 'b> PartialEq<Utf8PathBuf> for &'a Utf8Path
Source§impl<'a, 'b> PartialEq<Utf8PathBuf> for Utf8Path
impl<'a, 'b> PartialEq<Utf8PathBuf> for Utf8Path
Source§impl<'a, 'b> PartialOrd<&'a OsStr> for Utf8Path
impl<'a, 'b> PartialOrd<&'a OsStr> for Utf8Path
Source§impl<'a, 'b> PartialOrd<&'a Path> for Utf8Path
impl<'a, 'b> PartialOrd<&'a Path> for Utf8Path
Source§impl<'a, 'b> PartialOrd<&'b Utf8Path> for Cow<'a, Utf8Path>
impl<'a, 'b> PartialOrd<&'b Utf8Path> for Cow<'a, Utf8Path>
Source§impl<'a, 'b> PartialOrd<&'a Utf8Path> for Cow<'b, OsStr>
impl<'a, 'b> PartialOrd<&'a Utf8Path> for Cow<'b, OsStr>
Source§impl<'a, 'b> PartialOrd<&'a Utf8Path> for Cow<'b, Path>
impl<'a, 'b> PartialOrd<&'a Utf8Path> for Cow<'b, Path>
Source§impl<'a, 'b> PartialOrd<&'a Utf8Path> for Cow<'b, str>
impl<'a, 'b> PartialOrd<&'a Utf8Path> for Cow<'b, str>
Source§impl<'a, 'b> PartialOrd<&'a Utf8Path> for OsStr
impl<'a, 'b> PartialOrd<&'a Utf8Path> for OsStr
Source§impl<'a, 'b> PartialOrd<&'a Utf8Path> for OsString
impl<'a, 'b> PartialOrd<&'a Utf8Path> for OsString
Source§impl<'a, 'b> PartialOrd<&'a Utf8Path> for Path
impl<'a, 'b> PartialOrd<&'a Utf8Path> for Path
Source§impl<'a, 'b> PartialOrd<&'a Utf8Path> for PathBuf
impl<'a, 'b> PartialOrd<&'a Utf8Path> for PathBuf
Source§impl<'a, 'b> PartialOrd<&'a Utf8Path> for String
impl<'a, 'b> PartialOrd<&'a Utf8Path> for String
Source§impl<'a, 'b> PartialOrd<&'a Utf8Path> for Utf8PathBuf
impl<'a, 'b> PartialOrd<&'a Utf8Path> for Utf8PathBuf
Source§impl<'a, 'b> PartialOrd<&'a Utf8Path> for str
impl<'a, 'b> PartialOrd<&'a Utf8Path> for str
Source§impl<'a, 'b> PartialOrd<&'a str> for Utf8Path
impl<'a, 'b> PartialOrd<&'a str> for Utf8Path
Source§impl<'a, 'b> PartialOrd<Cow<'a, OsStr>> for Utf8Path
impl<'a, 'b> PartialOrd<Cow<'a, OsStr>> for Utf8Path
Source§impl<'a, 'b> PartialOrd<Cow<'a, Path>> for Utf8Path
impl<'a, 'b> PartialOrd<Cow<'a, Path>> for Utf8Path
Source§impl<'a, 'b> PartialOrd<Cow<'a, Utf8Path>> for &'b Utf8Path
impl<'a, 'b> PartialOrd<Cow<'a, Utf8Path>> for &'b Utf8Path
Source§impl<'a, 'b> PartialOrd<Cow<'a, Utf8Path>> for Utf8Path
impl<'a, 'b> PartialOrd<Cow<'a, Utf8Path>> for Utf8Path
Source§impl<'a, 'b> PartialOrd<Cow<'a, str>> for Utf8Path
impl<'a, 'b> PartialOrd<Cow<'a, str>> for Utf8Path
Source§impl<'a, 'b> PartialOrd<Cow<'b, OsStr>> for &'a Utf8Path
impl<'a, 'b> PartialOrd<Cow<'b, OsStr>> for &'a Utf8Path
Source§impl<'a, 'b> PartialOrd<Cow<'b, Path>> for &'a Utf8Path
impl<'a, 'b> PartialOrd<Cow<'b, Path>> for &'a Utf8Path
Source§impl<'a, 'b> PartialOrd<Cow<'b, str>> for &'a Utf8Path
impl<'a, 'b> PartialOrd<Cow<'b, str>> for &'a Utf8Path
Source§impl<'a, 'b> PartialOrd<OsStr> for &'a Utf8Path
impl<'a, 'b> PartialOrd<OsStr> for &'a Utf8Path
Source§impl<'a, 'b> PartialOrd<OsStr> for Utf8Path
impl<'a, 'b> PartialOrd<OsStr> for Utf8Path
Source§impl<'a, 'b> PartialOrd<OsString> for &'a Utf8Path
impl<'a, 'b> PartialOrd<OsString> for &'a Utf8Path
Source§impl<'a, 'b> PartialOrd<OsString> for Utf8Path
impl<'a, 'b> PartialOrd<OsString> for Utf8Path
Source§impl<'a, 'b> PartialOrd<Path> for &'a Utf8Path
impl<'a, 'b> PartialOrd<Path> for &'a Utf8Path
Source§impl<'a, 'b> PartialOrd<Path> for Utf8Path
impl<'a, 'b> PartialOrd<Path> for Utf8Path
Source§impl<'a, 'b> PartialOrd<PathBuf> for &'a Utf8Path
impl<'a, 'b> PartialOrd<PathBuf> for &'a Utf8Path
Source§impl<'a, 'b> PartialOrd<PathBuf> for Utf8Path
impl<'a, 'b> PartialOrd<PathBuf> for Utf8Path
Source§impl<'a, 'b> PartialOrd<String> for &'a Utf8Path
impl<'a, 'b> PartialOrd<String> for &'a Utf8Path
Source§impl<'a, 'b> PartialOrd<String> for Utf8Path
impl<'a, 'b> PartialOrd<String> for Utf8Path
Source§impl<'a, 'b> PartialOrd<Utf8Path> for &'a OsStr
impl<'a, 'b> PartialOrd<Utf8Path> for &'a OsStr
Source§impl<'a, 'b> PartialOrd<Utf8Path> for &'a Path
impl<'a, 'b> PartialOrd<Utf8Path> for &'a Path
Source§impl<'a, 'b> PartialOrd<Utf8Path> for &'a str
impl<'a, 'b> PartialOrd<Utf8Path> for &'a str
Source§impl<'a, 'b> PartialOrd<Utf8Path> for Cow<'a, OsStr>
impl<'a, 'b> PartialOrd<Utf8Path> for Cow<'a, OsStr>
Source§impl<'a, 'b> PartialOrd<Utf8Path> for Cow<'a, Path>
impl<'a, 'b> PartialOrd<Utf8Path> for Cow<'a, Path>
Source§impl<'a, 'b> PartialOrd<Utf8Path> for Cow<'a, Utf8Path>
impl<'a, 'b> PartialOrd<Utf8Path> for Cow<'a, Utf8Path>
Source§impl<'a, 'b> PartialOrd<Utf8Path> for Cow<'a, str>
impl<'a, 'b> PartialOrd<Utf8Path> for Cow<'a, str>
Source§impl<'a, 'b> PartialOrd<Utf8Path> for OsStr
impl<'a, 'b> PartialOrd<Utf8Path> for OsStr
Source§impl<'a, 'b> PartialOrd<Utf8Path> for OsString
impl<'a, 'b> PartialOrd<Utf8Path> for OsString
Source§impl<'a, 'b> PartialOrd<Utf8Path> for Path
impl<'a, 'b> PartialOrd<Utf8Path> for Path
Source§impl<'a, 'b> PartialOrd<Utf8Path> for PathBuf
impl<'a, 'b> PartialOrd<Utf8Path> for PathBuf
Source§impl<'a, 'b> PartialOrd<Utf8Path> for String
impl<'a, 'b> PartialOrd<Utf8Path> for String
Source§impl<'a, 'b> PartialOrd<Utf8Path> for Utf8PathBuf
impl<'a, 'b> PartialOrd<Utf8Path> for Utf8PathBuf
Source§impl<'a, 'b> PartialOrd<Utf8Path> for str
impl<'a, 'b> PartialOrd<Utf8Path> for str
Source§impl<'a, 'b> PartialOrd<Utf8PathBuf> for &'a Utf8Path
impl<'a, 'b> PartialOrd<Utf8PathBuf> for &'a Utf8Path
Source§impl<'a, 'b> PartialOrd<Utf8PathBuf> for Utf8Path
impl<'a, 'b> PartialOrd<Utf8PathBuf> for Utf8Path
Source§impl<'a, 'b> PartialOrd<str> for &'a Utf8Path
impl<'a, 'b> PartialOrd<str> for &'a Utf8Path
Source§impl<'a, 'b> PartialOrd<str> for Utf8Path
impl<'a, 'b> PartialOrd<str> for Utf8Path
Source§impl PartialOrd for Utf8Path
impl PartialOrd for Utf8Path
Source§impl ToOwned for Utf8Path
impl ToOwned for Utf8Path
Source§type Owned = Utf8PathBuf
type Owned = Utf8PathBuf
Source§fn to_owned(&self) -> Utf8PathBuf
fn to_owned(&self) -> Utf8PathBuf
1.63.0 · Source§fn clone_into(&self, target: &mut Self::Owned)
fn clone_into(&self, target: &mut Self::Owned)
Source§impl<'a> TryFrom<&'a Path> for &'a Utf8Path
impl<'a> TryFrom<&'a Path> for &'a Utf8Path
Returns FromPathError
if the path is not valid UTF-8.
§Examples
use camino::Utf8Path;
use std::convert::TryFrom;
use std::ffi::OsStr;
use std::os::unix::ffi::OsStrExt;
use std::path::Path;
let unicode_path = Path::new("/valid/unicode");
<&Utf8Path>::try_from(unicode_path).expect("valid Unicode path succeeded");
// Paths on Unix can be non-UTF-8.
let non_unicode_str = OsStr::from_bytes(b"\xFF\xFF\xFF");
let non_unicode_path = Path::new(non_unicode_str);
assert!(<&Utf8Path>::try_from(non_unicode_path).is_err(), "non-Unicode path failed");