Struct prelude::Path 1.0.0
[−]
[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 /
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 PathBuf
.
More details about the overall approach can be found in the module documentation.
Examples
use std::path::Path; use std::ffi::OsStr; // Note: this example does work on Windows 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(OsStr::new("bar"))); let extension = path.extension(); assert_eq!(extension, Some(OsStr::new("txt")));
Methods
impl Path
[src]
fn new<S>(s: &S) -> &Path where
S: AsRef<OsStr> + ?Sized,
[src]
S: AsRef<OsStr> + ?Sized,
Directly wraps a string slice as a Path
slice.
This is a cost-free conversion.
Examples
use std::path::Path; Path::new("foo.txt");
You can create Path
s from String
s, or even other Path
s:
use std::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);
fn as_os_str(&self) -> &OsStr
[src]
Yields the underlying OsStr
slice.
Examples
use std::path::Path; let os_str = Path::new("foo.txt").as_os_str(); assert_eq!(os_str, std::ffi::OsStr::new("foo.txt"));
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.
Examples
use std::path::Path; let path = Path::new("foo.txt"); assert_eq!(path.to_str(), Some("foo.txt"));
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 std::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"
.
fn to_path_buf(&self) -> PathBuf
[src]
Converts a Path
to an owned PathBuf
.
Examples
use std::path::Path; let path_buf = Path::new("foo.txt").to_path_buf(); assert_eq!(path_buf, std::path::PathBuf::from("foo.txt"));
fn is_absolute(&self) -> bool
[src]
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 std::path::Path; assert!(!Path::new("foo.txt").is_absolute());
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 std::path::Path; assert!(Path::new("foo.txt").is_relative());
fn has_root(&self) -> bool
[src]
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 std::path::Path; assert!(Path::new("/etc/passwd").has_root());
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 std::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);
fn file_name(&self) -> Option<&OsStr>
[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 std::path::Path; use std::ffi::OsStr; 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());
fn strip_prefix<P>(&'a self, base: &'a P) -> Result<&'a Path, StripPrefixError> where
P: AsRef<Path> + ?Sized,
1.7.0[src]
P: AsRef<Path> + ?Sized,
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 std::path::Path; let path = Path::new("/test/haha/foo.txt"); assert_eq!(path.strip_prefix("/test"), Ok(Path::new("haha/foo.txt"))); assert_eq!(path.strip_prefix("test").is_ok(), false); assert_eq!(path.strip_prefix("/haha").is_ok(), false);
fn starts_with<P>(&self, base: P) -> bool where
P: AsRef<Path>,
[src]
P: AsRef<Path>,
Determines whether base
is a prefix of self
.
Only considers whole path components to match.
Examples
use std::path::Path; let path = Path::new("/etc/passwd"); assert!(path.starts_with("/etc")); assert!(!path.starts_with("/e"));
fn ends_with<P>(&self, child: P) -> bool where
P: AsRef<Path>,
[src]
P: AsRef<Path>,
Determines whether child
is a suffix of self
.
Only considers whole path components to match.
Examples
use std::path::Path; let path = Path::new("/etc/passwd"); assert!(path.ends_with("passwd"));
fn file_stem(&self) -> Option<&OsStr>
[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 std::path::Path; let path = Path::new("foo.rs"); assert_eq!("foo", path.file_stem().unwrap());
fn extension(&self) -> Option<&OsStr>
[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 std::path::Path; let path = Path::new("foo.rs"); assert_eq!("rs", path.extension().unwrap());
fn join<P>(&self, path: P) -> PathBuf where
P: AsRef<Path>,
[src]
P: AsRef<Path>,
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 std::path::{Path, PathBuf}; assert_eq!(Path::new("/etc").join("passwd"), PathBuf::from("/etc/passwd"));
fn with_file_name<S>(&self, file_name: S) -> PathBuf where
S: AsRef<OsStr>,
[src]
S: AsRef<OsStr>,
Creates an owned PathBuf
like self
but with the given file name.
See PathBuf::set_file_name
for more details.
Examples
use std::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"));
fn with_extension<S>(&self, extension: S) -> PathBuf where
S: AsRef<OsStr>,
[src]
S: AsRef<OsStr>,
Creates an owned PathBuf
like self
but with the given extension.
See PathBuf::set_extension
for more details.
Examples
use std::path::{Path, PathBuf}; let path = Path::new("foo.rs"); assert_eq!(path.with_extension("txt"), PathBuf::from("foo.txt"));
fn components(&self) -> Components
[src]
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.
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::path::{Path, Component}; use std::ffi::OsStr; 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)
fn iter(&self) -> Iter
[src]
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::path::{self, Path}; use std::ffi::OsStr; 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)
fn display(&self) -> Display
[src]
Returns an object that implements Display
for safely printing paths
that may contain non-Unicode data.
Examples
use std::path::Path; let path = Path::new("/tmp/foo.rs"); println!("{}", path.display());
fn metadata(&self) -> Result<Metadata, Error>
1.5.0[src]
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 std::path::Path; let path = Path::new("/Minas/tirith"); let metadata = path.metadata().expect("metadata call failed"); println!("{:?}", metadata.file_type());
fn symlink_metadata(&self) -> Result<Metadata, Error>
1.5.0[src]
Queries the metadata about a file without following symlinks.
This is an alias to fs::symlink_metadata
.
Examples
use std::path::Path; let path = Path::new("/Minas/tirith"); let metadata = path.symlink_metadata().expect("symlink_metadata call failed"); println!("{:?}", metadata.file_type());
fn canonicalize(&self) -> Result<PathBuf, Error>
1.5.0[src]
Returns the canonical form of the path with all intermediate components normalized and symbolic links resolved.
This is an alias to fs::canonicalize
.
Examples
use std::path::{Path, PathBuf}; let path = Path::new("/foo/test/../test/bar.rs"); assert_eq!(path.canonicalize().unwrap(), PathBuf::from("/foo/test/bar.rs"));
fn read_link(&self) -> Result<PathBuf, Error>
1.5.0[src]
Reads a symbolic link, returning the file that the link points to.
This is an alias to fs::read_link
.
Examples
use std::path::Path; let path = Path::new("/laputa/sky_castle.rs"); let path_link = path.read_link().expect("read_link call failed");
fn read_dir(&self) -> Result<ReadDir, Error>
1.5.0[src]
Returns an iterator over the entries within a directory.
The iterator will yield instances of io::Result
<
DirEntry
>
. New
errors may be encountered after an iterator is initially constructed.
This is an alias to fs::read_dir
.
Examples
use std::path::Path; let path = Path::new("/laputa"); for entry in path.read_dir().expect("read_dir call failed") { if let Ok(entry) = entry { println!("{:?}", entry.path()); } }
fn exists(&self) -> bool
1.5.0[src]
Returns whether 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 false
.
If you cannot access the directory containing the file, e.g. because of a
permission error, this will return false
.
Examples
use std::path::Path; assert_eq!(Path::new("does_not_exist.txt").exists(), false);
See Also
This is a convenience function that coerces errors to false. If you want to check errors, call fs::metadata.
fn is_file(&self) -> bool
1.5.0[src]
Returns whether 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 std::path::Path; assert_eq!(Path::new("./is_a_directory/").is_file(), false); assert_eq!(Path::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.
fn is_dir(&self) -> bool
1.5.0[src]
Returns whether 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 std::path::Path; assert_eq!(Path::new("./is_a_directory/").is_dir(), true); assert_eq!(Path::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.
fn into_path_buf(self: Box<Path>) -> PathBuf
1.20.0[src]
Trait Implementations
impl Debug for Path
[src]
fn fmt(&self, formatter: &mut Formatter) -> Result<(), Error>
[src]
Formats the value using the given formatter.