1 //! Cross-platform path manipulation.
3 //! This module provides two types, [`PathBuf`] and [`Path`] (akin to [`String`]
4 //! and [`str`]), for working with paths abstractly. These types are thin wrappers
5 //! around [`OsString`] and [`OsStr`] respectively, meaning that they work directly
6 //! on strings according to the local platform's path syntax.
8 //! Paths can be parsed into [`Component`]s by iterating over the structure
9 //! returned by the [`components`] method on [`Path`]. [`Component`]s roughly
10 //! correspond to the substrings between path separators (`/` or `\`). You can
11 //! reconstruct an equivalent path from components with the [`push`] method on
12 //! [`PathBuf`]; note that the paths may differ syntactically by the
13 //! normalization described in the documentation for the [`components`] method.
17 //! Path manipulation includes both parsing components from slices and building
20 //! To parse a path, you can create a [`Path`] slice from a [`str`]
21 //! slice and start asking questions:
24 //! use std::path::Path;
25 //! use std::ffi::OsStr;
27 //! let path = Path::new("/tmp/foo/bar.txt");
29 //! let parent = path.parent();
30 //! assert_eq!(parent, Some(Path::new("/tmp/foo")));
32 //! let file_stem = path.file_stem();
33 //! assert_eq!(file_stem, Some(OsStr::new("bar")));
35 //! let extension = path.extension();
36 //! assert_eq!(extension, Some(OsStr::new("txt")));
39 //! To build or modify paths, use [`PathBuf`]:
42 //! use std::path::PathBuf;
44 //! // This way works...
45 //! let mut path = PathBuf::from("c:\\");
47 //! path.push("windows");
48 //! path.push("system32");
50 //! path.set_extension("dll");
52 //! // ... but push is best used if you don't know everything up
53 //! // front. If you do, this way is better:
54 //! let path: PathBuf = ["c:\\", "windows", "system32.dll"].iter().collect();
57 //! [`components`]: Path::components
58 //! [`push`]: PathBuf::push
60 #![stable(feature = "rust1", since = "1.0.0")]
61 #![deny(unsafe_op_in_unsafe_fn)]
66 use crate::borrow::{Borrow, Cow};
68 use crate::error::Error;
71 use crate::hash::{Hash, Hasher};
73 use crate::iter::{self, FusedIterator};
74 use crate::ops::{self, Deref};
76 use crate::str::FromStr;
79 use crate::ffi::{OsStr, OsString};
81 use crate::sys::path::{is_sep_byte, is_verbatim_sep, parse_prefix, MAIN_SEP_STR};
83 ////////////////////////////////////////////////////////////////////////////////
85 ////////////////////////////////////////////////////////////////////////////////
87 // Parsing in this module is done by directly transmuting OsStr to [u8] slices,
88 // taking advantage of the fact that OsStr always encodes ASCII characters
89 // as-is. Eventually, this transmutation should be replaced by direct uses of
90 // OsStr APIs for parsing, but it will take a while for those to become
93 ////////////////////////////////////////////////////////////////////////////////
95 ////////////////////////////////////////////////////////////////////////////////
97 /// Windows path prefixes, e.g., `C:` or `\\server\share`.
99 /// Windows uses a variety of path prefix styles, including references to drive
100 /// volumes (like `C:`), network shared folders (like `\\server\share`), and
101 /// others. In addition, some path prefixes are "verbatim" (i.e., prefixed with
102 /// `\\?\`), in which case `/` is *not* treated as a separator and essentially
103 /// no normalization is performed.
108 /// use std::path::{Component, Path, Prefix};
109 /// use std::path::Prefix::*;
110 /// use std::ffi::OsStr;
112 /// fn get_path_prefix(s: &str) -> Prefix {
113 /// let path = Path::new(s);
114 /// match path.components().next().unwrap() {
115 /// Component::Prefix(prefix_component) => prefix_component.kind(),
120 /// # if cfg!(windows) {
121 /// assert_eq!(Verbatim(OsStr::new("pictures")),
122 /// get_path_prefix(r"\\?\pictures\kittens"));
123 /// assert_eq!(VerbatimUNC(OsStr::new("server"), OsStr::new("share")),
124 /// get_path_prefix(r"\\?\UNC\server\share"));
125 /// assert_eq!(VerbatimDisk(b'C'), get_path_prefix(r"\\?\c:\"));
126 /// assert_eq!(DeviceNS(OsStr::new("BrainInterface")),
127 /// get_path_prefix(r"\\.\BrainInterface"));
128 /// assert_eq!(UNC(OsStr::new("server"), OsStr::new("share")),
129 /// get_path_prefix(r"\\server\share"));
130 /// assert_eq!(Disk(b'C'), get_path_prefix(r"C:\Users\Rust\Pictures\Ferris"));
133 #[derive(Copy, Clone, Debug, Hash, PartialOrd, Ord, PartialEq, Eq)]
134 #[stable(feature = "rust1", since = "1.0.0")]
135 pub enum Prefix<'a> {
136 /// Verbatim prefix, e.g., `\\?\cat_pics`.
138 /// Verbatim prefixes consist of `\\?\` immediately followed by the given
140 #[stable(feature = "rust1", since = "1.0.0")]
141 Verbatim(#[stable(feature = "rust1", since = "1.0.0")] &'a OsStr),
143 /// Verbatim prefix using Windows' _**U**niform **N**aming **C**onvention_,
144 /// e.g., `\\?\UNC\server\share`.
146 /// Verbatim UNC prefixes consist of `\\?\UNC\` immediately followed by the
147 /// server's hostname and a share name.
148 #[stable(feature = "rust1", since = "1.0.0")]
150 #[stable(feature = "rust1", since = "1.0.0")] &'a OsStr,
151 #[stable(feature = "rust1", since = "1.0.0")] &'a OsStr,
154 /// Verbatim disk prefix, e.g., `\\?\C:`.
156 /// Verbatim disk prefixes consist of `\\?\` immediately followed by the
157 /// drive letter and `:`.
158 #[stable(feature = "rust1", since = "1.0.0")]
159 VerbatimDisk(#[stable(feature = "rust1", since = "1.0.0")] u8),
161 /// Device namespace prefix, e.g., `\\.\COM42`.
163 /// Device namespace prefixes consist of `\\.\` immediately followed by the
165 #[stable(feature = "rust1", since = "1.0.0")]
166 DeviceNS(#[stable(feature = "rust1", since = "1.0.0")] &'a OsStr),
168 /// Prefix using Windows' _**U**niform **N**aming **C**onvention_, e.g.
169 /// `\\server\share`.
171 /// UNC prefixes consist of the server's hostname and a share name.
172 #[stable(feature = "rust1", since = "1.0.0")]
174 #[stable(feature = "rust1", since = "1.0.0")] &'a OsStr,
175 #[stable(feature = "rust1", since = "1.0.0")] &'a OsStr,
178 /// Prefix `C:` for the given disk drive.
179 #[stable(feature = "rust1", since = "1.0.0")]
180 Disk(#[stable(feature = "rust1", since = "1.0.0")] u8),
183 impl<'a> Prefix<'a> {
185 fn len(&self) -> usize {
187 fn os_str_len(s: &OsStr) -> usize {
188 os_str_as_u8_slice(s).len()
191 Verbatim(x) => 4 + os_str_len(x),
192 VerbatimUNC(x, y) => {
193 8 + os_str_len(x) + if os_str_len(y) > 0 { 1 + os_str_len(y) } else { 0 }
195 VerbatimDisk(_) => 6,
196 UNC(x, y) => 2 + os_str_len(x) + if os_str_len(y) > 0 { 1 + os_str_len(y) } else { 0 },
197 DeviceNS(x) => 4 + os_str_len(x),
202 /// Determines if the prefix is verbatim, i.e., begins with `\\?\`.
207 /// use std::path::Prefix::*;
208 /// use std::ffi::OsStr;
210 /// assert!(Verbatim(OsStr::new("pictures")).is_verbatim());
211 /// assert!(VerbatimUNC(OsStr::new("server"), OsStr::new("share")).is_verbatim());
212 /// assert!(VerbatimDisk(b'C').is_verbatim());
213 /// assert!(!DeviceNS(OsStr::new("BrainInterface")).is_verbatim());
214 /// assert!(!UNC(OsStr::new("server"), OsStr::new("share")).is_verbatim());
215 /// assert!(!Disk(b'C').is_verbatim());
218 #[stable(feature = "rust1", since = "1.0.0")]
219 pub fn is_verbatim(&self) -> bool {
221 matches!(*self, Verbatim(_) | VerbatimDisk(_) | VerbatimUNC(..))
225 fn is_drive(&self) -> bool {
226 matches!(*self, Prefix::Disk(_))
230 fn has_implicit_root(&self) -> bool {
235 ////////////////////////////////////////////////////////////////////////////////
236 // Exposed parsing helpers
237 ////////////////////////////////////////////////////////////////////////////////
239 /// Determines whether the character is one of the permitted path
240 /// separators for the current platform.
247 /// assert!(path::is_separator('/')); // '/' works for both Unix and Windows
248 /// assert!(!path::is_separator('❤'));
250 #[stable(feature = "rust1", since = "1.0.0")]
251 pub fn is_separator(c: char) -> bool {
252 c.is_ascii() && is_sep_byte(c as u8)
255 /// The primary separator of path components for the current platform.
257 /// For example, `/` on Unix and `\` on Windows.
258 #[stable(feature = "rust1", since = "1.0.0")]
259 pub const MAIN_SEPARATOR: char = crate::sys::path::MAIN_SEP;
261 ////////////////////////////////////////////////////////////////////////////////
263 ////////////////////////////////////////////////////////////////////////////////
265 // Iterate through `iter` while it matches `prefix`; return `None` if `prefix`
266 // is not a prefix of `iter`, otherwise return `Some(iter_after_prefix)` giving
267 // `iter` after having exhausted `prefix`.
268 fn iter_after<'a, 'b, I, J>(mut iter: I, mut prefix: J) -> Option<I>
270 I: Iterator<Item = Component<'a>> + Clone,
271 J: Iterator<Item = Component<'b>>,
274 let mut iter_next = iter.clone();
275 match (iter_next.next(), prefix.next()) {
276 (Some(ref x), Some(ref y)) if x == y => (),
277 (Some(_), Some(_)) => return None,
278 (Some(_), None) => return Some(iter),
279 (None, None) => return Some(iter),
280 (None, Some(_)) => return None,
286 // See note at the top of this module to understand why these are used:
288 // These casts are safe as OsStr is internally a wrapper around [u8] on all
291 // Note that currently this relies on the special knowledge that libstd has;
292 // these types are single-element structs but are not marked repr(transparent)
293 // or repr(C) which would make these casts allowable outside std.
294 fn os_str_as_u8_slice(s: &OsStr) -> &[u8] {
295 unsafe { &*(s as *const OsStr as *const [u8]) }
297 unsafe fn u8_slice_as_os_str(s: &[u8]) -> &OsStr {
298 // SAFETY: see the comment of `os_str_as_u8_slice`
299 unsafe { &*(s as *const [u8] as *const OsStr) }
302 // Detect scheme on Redox
303 fn has_redox_scheme(s: &[u8]) -> bool {
304 cfg!(target_os = "redox") && s.contains(&b':')
307 ////////////////////////////////////////////////////////////////////////////////
308 // Cross-platform, iterator-independent parsing
309 ////////////////////////////////////////////////////////////////////////////////
311 /// Says whether the first byte after the prefix is a separator.
312 fn has_physical_root(s: &[u8], prefix: Option<Prefix<'_>>) -> bool {
313 let path = if let Some(p) = prefix { &s[p.len()..] } else { s };
314 !path.is_empty() && is_sep_byte(path[0])
317 // basic workhorse for splitting stem and extension
318 fn split_file_at_dot(file: &OsStr) -> (Option<&OsStr>, Option<&OsStr>) {
319 if os_str_as_u8_slice(file) == b".." {
320 return (Some(file), None);
323 // The unsafety here stems from converting between &OsStr and &[u8]
324 // and back. This is safe to do because (1) we only look at ASCII
325 // contents of the encoding and (2) new &OsStr values are produced
326 // only from ASCII-bounded slices of existing &OsStr values.
327 let mut iter = os_str_as_u8_slice(file).rsplitn(2, |b| *b == b'.');
328 let after = iter.next();
329 let before = iter.next();
330 if before == Some(b"") {
333 unsafe { (before.map(|s| u8_slice_as_os_str(s)), after.map(|s| u8_slice_as_os_str(s))) }
337 ////////////////////////////////////////////////////////////////////////////////
338 // The core iterators
339 ////////////////////////////////////////////////////////////////////////////////
341 /// Component parsing works by a double-ended state machine; the cursors at the
342 /// front and back of the path each keep track of what parts of the path have
343 /// been consumed so far.
345 /// Going front to back, a path is made up of a prefix, a starting
346 /// directory component, and a body (of normal components)
347 #[derive(Copy, Clone, PartialEq, PartialOrd, Debug)]
350 StartDir = 1, // / or . or nothing
351 Body = 2, // foo/bar/baz
355 /// A structure wrapping a Windows path prefix as well as its unparsed string
358 /// In addition to the parsed [`Prefix`] information returned by [`kind`],
359 /// `PrefixComponent` also holds the raw and unparsed [`OsStr`] slice,
360 /// returned by [`as_os_str`].
362 /// Instances of this `struct` can be obtained by matching against the
363 /// [`Prefix` variant] on [`Component`].
365 /// Does not occur on Unix.
370 /// # if cfg!(windows) {
371 /// use std::path::{Component, Path, Prefix};
372 /// use std::ffi::OsStr;
374 /// let path = Path::new(r"c:\you\later\");
375 /// match path.components().next().unwrap() {
376 /// Component::Prefix(prefix_component) => {
377 /// assert_eq!(Prefix::Disk(b'C'), prefix_component.kind());
378 /// assert_eq!(OsStr::new("c:"), prefix_component.as_os_str());
380 /// _ => unreachable!(),
385 /// [`as_os_str`]: PrefixComponent::as_os_str
386 /// [`kind`]: PrefixComponent::kind
387 /// [`Prefix` variant]: Component::Prefix
388 #[stable(feature = "rust1", since = "1.0.0")]
389 #[derive(Copy, Clone, Eq, Debug)]
390 pub struct PrefixComponent<'a> {
391 /// The prefix as an unparsed `OsStr` slice.
394 /// The parsed prefix data.
398 impl<'a> PrefixComponent<'a> {
399 /// Returns the parsed prefix data.
401 /// See [`Prefix`]'s documentation for more information on the different
402 /// kinds of prefixes.
403 #[stable(feature = "rust1", since = "1.0.0")]
404 pub fn kind(&self) -> Prefix<'a> {
408 /// Returns the raw [`OsStr`] slice for this prefix.
409 #[stable(feature = "rust1", since = "1.0.0")]
410 pub fn as_os_str(&self) -> &'a OsStr {
415 #[stable(feature = "rust1", since = "1.0.0")]
416 impl<'a> cmp::PartialEq for PrefixComponent<'a> {
417 fn eq(&self, other: &PrefixComponent<'a>) -> bool {
418 cmp::PartialEq::eq(&self.parsed, &other.parsed)
422 #[stable(feature = "rust1", since = "1.0.0")]
423 impl<'a> cmp::PartialOrd for PrefixComponent<'a> {
424 fn partial_cmp(&self, other: &PrefixComponent<'a>) -> Option<cmp::Ordering> {
425 cmp::PartialOrd::partial_cmp(&self.parsed, &other.parsed)
429 #[stable(feature = "rust1", since = "1.0.0")]
430 impl cmp::Ord for PrefixComponent<'_> {
431 fn cmp(&self, other: &Self) -> cmp::Ordering {
432 cmp::Ord::cmp(&self.parsed, &other.parsed)
436 #[stable(feature = "rust1", since = "1.0.0")]
437 impl Hash for PrefixComponent<'_> {
438 fn hash<H: Hasher>(&self, h: &mut H) {
443 /// A single component of a path.
445 /// A `Component` roughly corresponds to a substring between path separators
448 /// This `enum` is created by iterating over [`Components`], which in turn is
449 /// created by the [`components`](Path::components) method on [`Path`].
454 /// use std::path::{Component, Path};
456 /// let path = Path::new("/tmp/foo/bar.txt");
457 /// let components = path.components().collect::<Vec<_>>();
458 /// assert_eq!(&components, &[
459 /// Component::RootDir,
460 /// Component::Normal("tmp".as_ref()),
461 /// Component::Normal("foo".as_ref()),
462 /// Component::Normal("bar.txt".as_ref()),
465 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
466 #[stable(feature = "rust1", since = "1.0.0")]
467 pub enum Component<'a> {
468 /// A Windows path prefix, e.g., `C:` or `\\server\share`.
470 /// There is a large variety of prefix types, see [`Prefix`]'s documentation
473 /// Does not occur on Unix.
474 #[stable(feature = "rust1", since = "1.0.0")]
475 Prefix(#[stable(feature = "rust1", since = "1.0.0")] PrefixComponent<'a>),
477 /// The root directory component, appears after any prefix and before anything else.
479 /// It represents a separator that designates that a path starts from root.
480 #[stable(feature = "rust1", since = "1.0.0")]
483 /// A reference to the current directory, i.e., `.`.
484 #[stable(feature = "rust1", since = "1.0.0")]
487 /// A reference to the parent directory, i.e., `..`.
488 #[stable(feature = "rust1", since = "1.0.0")]
491 /// A normal component, e.g., `a` and `b` in `a/b`.
493 /// This variant is the most common one, it represents references to files
495 #[stable(feature = "rust1", since = "1.0.0")]
496 Normal(#[stable(feature = "rust1", since = "1.0.0")] &'a OsStr),
499 impl<'a> Component<'a> {
500 /// Extracts the underlying [`OsStr`] slice.
505 /// use std::path::Path;
507 /// let path = Path::new("./tmp/foo/bar.txt");
508 /// let components: Vec<_> = path.components().map(|comp| comp.as_os_str()).collect();
509 /// assert_eq!(&components, &[".", "tmp", "foo", "bar.txt"]);
511 #[stable(feature = "rust1", since = "1.0.0")]
512 pub fn as_os_str(self) -> &'a OsStr {
514 Component::Prefix(p) => p.as_os_str(),
515 Component::RootDir => OsStr::new(MAIN_SEP_STR),
516 Component::CurDir => OsStr::new("."),
517 Component::ParentDir => OsStr::new(".."),
518 Component::Normal(path) => path,
523 #[stable(feature = "rust1", since = "1.0.0")]
524 impl AsRef<OsStr> for Component<'_> {
525 fn as_ref(&self) -> &OsStr {
530 #[stable(feature = "path_component_asref", since = "1.25.0")]
531 impl AsRef<Path> for Component<'_> {
532 fn as_ref(&self) -> &Path {
533 self.as_os_str().as_ref()
537 /// An iterator over the [`Component`]s of a [`Path`].
539 /// This `struct` is created by the [`components`] method on [`Path`].
540 /// See its documentation for more.
545 /// use std::path::Path;
547 /// let path = Path::new("/tmp/foo/bar.txt");
549 /// for component in path.components() {
550 /// println!("{:?}", component);
554 /// [`components`]: Path::components
556 #[stable(feature = "rust1", since = "1.0.0")]
557 pub struct Components<'a> {
558 // The path left to parse components from
561 // The prefix as it was originally parsed, if any
562 prefix: Option<Prefix<'a>>,
564 // true if path *physically* has a root separator; for most Windows
565 // prefixes, it may have a "logical" rootseparator for the purposes of
566 // normalization, e.g., \\server\share == \\server\share\.
567 has_physical_root: bool,
569 // The iterator is double-ended, and these two states keep track of what has
570 // been produced from either end
575 /// An iterator over the [`Component`]s of a [`Path`], as [`OsStr`] slices.
577 /// This `struct` is created by the [`iter`] method on [`Path`].
578 /// See its documentation for more.
580 /// [`iter`]: Path::iter
582 #[stable(feature = "rust1", since = "1.0.0")]
583 pub struct Iter<'a> {
584 inner: Components<'a>,
587 #[stable(feature = "path_components_debug", since = "1.13.0")]
588 impl fmt::Debug for Components<'_> {
589 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
590 struct DebugHelper<'a>(&'a Path);
592 impl fmt::Debug for DebugHelper<'_> {
593 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
594 f.debug_list().entries(self.0.components()).finish()
598 f.debug_tuple("Components").field(&DebugHelper(self.as_path())).finish()
602 impl<'a> Components<'a> {
603 // how long is the prefix, if any?
605 fn prefix_len(&self) -> usize {
606 self.prefix.as_ref().map(Prefix::len).unwrap_or(0)
610 fn prefix_verbatim(&self) -> bool {
611 self.prefix.as_ref().map(Prefix::is_verbatim).unwrap_or(false)
614 /// how much of the prefix is left from the point of view of iteration?
616 fn prefix_remaining(&self) -> usize {
617 if self.front == State::Prefix { self.prefix_len() } else { 0 }
620 // Given the iteration so far, how much of the pre-State::Body path is left?
622 fn len_before_body(&self) -> usize {
623 let root = if self.front <= State::StartDir && self.has_physical_root { 1 } else { 0 };
624 let cur_dir = if self.front <= State::StartDir && self.include_cur_dir() { 1 } else { 0 };
625 self.prefix_remaining() + root + cur_dir
628 // is the iteration complete?
630 fn finished(&self) -> bool {
631 self.front == State::Done || self.back == State::Done || self.front > self.back
635 fn is_sep_byte(&self, b: u8) -> bool {
636 if self.prefix_verbatim() { is_verbatim_sep(b) } else { is_sep_byte(b) }
639 /// Extracts a slice corresponding to the portion of the path remaining for iteration.
644 /// use std::path::Path;
646 /// let mut components = Path::new("/tmp/foo/bar.txt").components();
647 /// components.next();
648 /// components.next();
650 /// assert_eq!(Path::new("foo/bar.txt"), components.as_path());
652 #[stable(feature = "rust1", since = "1.0.0")]
653 pub fn as_path(&self) -> &'a Path {
654 let mut comps = self.clone();
655 if comps.front == State::Body {
658 if comps.back == State::Body {
661 unsafe { Path::from_u8_slice(comps.path) }
664 /// Is the *original* path rooted?
665 fn has_root(&self) -> bool {
666 if self.has_physical_root {
669 if let Some(p) = self.prefix {
670 if p.has_implicit_root() {
677 /// Should the normalized path include a leading . ?
678 fn include_cur_dir(&self) -> bool {
682 let mut iter = self.path[self.prefix_len()..].iter();
683 match (iter.next(), iter.next()) {
684 (Some(&b'.'), None) => true,
685 (Some(&b'.'), Some(&b)) => self.is_sep_byte(b),
690 // parse a given byte sequence into the corresponding path component
691 fn parse_single_component<'b>(&self, comp: &'b [u8]) -> Option<Component<'b>> {
693 b"." if self.prefix_verbatim() => Some(Component::CurDir),
694 b"." => None, // . components are normalized away, except at
695 // the beginning of a path, which is treated
696 // separately via `include_cur_dir`
697 b".." => Some(Component::ParentDir),
699 _ => Some(Component::Normal(unsafe { u8_slice_as_os_str(comp) })),
703 // parse a component from the left, saying how many bytes to consume to
704 // remove the component
705 fn parse_next_component(&self) -> (usize, Option<Component<'a>>) {
706 debug_assert!(self.front == State::Body);
707 let (extra, comp) = match self.path.iter().position(|b| self.is_sep_byte(*b)) {
708 None => (0, self.path),
709 Some(i) => (1, &self.path[..i]),
711 (comp.len() + extra, self.parse_single_component(comp))
714 // parse a component from the right, saying how many bytes to consume to
715 // remove the component
716 fn parse_next_component_back(&self) -> (usize, Option<Component<'a>>) {
717 debug_assert!(self.back == State::Body);
718 let start = self.len_before_body();
719 let (extra, comp) = match self.path[start..].iter().rposition(|b| self.is_sep_byte(*b)) {
720 None => (0, &self.path[start..]),
721 Some(i) => (1, &self.path[start + i + 1..]),
723 (comp.len() + extra, self.parse_single_component(comp))
726 // trim away repeated separators (i.e., empty components) on the left
727 fn trim_left(&mut self) {
728 while !self.path.is_empty() {
729 let (size, comp) = self.parse_next_component();
733 self.path = &self.path[size..];
738 // trim away repeated separators (i.e., empty components) on the right
739 fn trim_right(&mut self) {
740 while self.path.len() > self.len_before_body() {
741 let (size, comp) = self.parse_next_component_back();
745 self.path = &self.path[..self.path.len() - size];
751 #[stable(feature = "rust1", since = "1.0.0")]
752 impl AsRef<Path> for Components<'_> {
753 fn as_ref(&self) -> &Path {
758 #[stable(feature = "rust1", since = "1.0.0")]
759 impl AsRef<OsStr> for Components<'_> {
760 fn as_ref(&self) -> &OsStr {
761 self.as_path().as_os_str()
765 #[stable(feature = "path_iter_debug", since = "1.13.0")]
766 impl fmt::Debug for Iter<'_> {
767 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
768 struct DebugHelper<'a>(&'a Path);
770 impl fmt::Debug for DebugHelper<'_> {
771 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
772 f.debug_list().entries(self.0.iter()).finish()
776 f.debug_tuple("Iter").field(&DebugHelper(self.as_path())).finish()
781 /// Extracts a slice corresponding to the portion of the path remaining for iteration.
786 /// use std::path::Path;
788 /// let mut iter = Path::new("/tmp/foo/bar.txt").iter();
792 /// assert_eq!(Path::new("foo/bar.txt"), iter.as_path());
794 #[stable(feature = "rust1", since = "1.0.0")]
795 pub fn as_path(&self) -> &'a Path {
800 #[stable(feature = "rust1", since = "1.0.0")]
801 impl AsRef<Path> for Iter<'_> {
802 fn as_ref(&self) -> &Path {
807 #[stable(feature = "rust1", since = "1.0.0")]
808 impl AsRef<OsStr> for Iter<'_> {
809 fn as_ref(&self) -> &OsStr {
810 self.as_path().as_os_str()
814 #[stable(feature = "rust1", since = "1.0.0")]
815 impl<'a> Iterator for Iter<'a> {
816 type Item = &'a OsStr;
818 fn next(&mut self) -> Option<&'a OsStr> {
819 self.inner.next().map(Component::as_os_str)
823 #[stable(feature = "rust1", since = "1.0.0")]
824 impl<'a> DoubleEndedIterator for Iter<'a> {
825 fn next_back(&mut self) -> Option<&'a OsStr> {
826 self.inner.next_back().map(Component::as_os_str)
830 #[stable(feature = "fused", since = "1.26.0")]
831 impl FusedIterator for Iter<'_> {}
833 #[stable(feature = "rust1", since = "1.0.0")]
834 impl<'a> Iterator for Components<'a> {
835 type Item = Component<'a>;
837 fn next(&mut self) -> Option<Component<'a>> {
838 while !self.finished() {
840 State::Prefix if self.prefix_len() > 0 => {
841 self.front = State::StartDir;
842 debug_assert!(self.prefix_len() <= self.path.len());
843 let raw = &self.path[..self.prefix_len()];
844 self.path = &self.path[self.prefix_len()..];
845 return Some(Component::Prefix(PrefixComponent {
846 raw: unsafe { u8_slice_as_os_str(raw) },
847 parsed: self.prefix.unwrap(),
851 self.front = State::StartDir;
854 self.front = State::Body;
855 if self.has_physical_root {
856 debug_assert!(!self.path.is_empty());
857 self.path = &self.path[1..];
858 return Some(Component::RootDir);
859 } else if let Some(p) = self.prefix {
860 if p.has_implicit_root() && !p.is_verbatim() {
861 return Some(Component::RootDir);
863 } else if self.include_cur_dir() {
864 debug_assert!(!self.path.is_empty());
865 self.path = &self.path[1..];
866 return Some(Component::CurDir);
869 State::Body if !self.path.is_empty() => {
870 let (size, comp) = self.parse_next_component();
871 self.path = &self.path[size..];
877 self.front = State::Done;
879 State::Done => unreachable!(),
886 #[stable(feature = "rust1", since = "1.0.0")]
887 impl<'a> DoubleEndedIterator for Components<'a> {
888 fn next_back(&mut self) -> Option<Component<'a>> {
889 while !self.finished() {
891 State::Body if self.path.len() > self.len_before_body() => {
892 let (size, comp) = self.parse_next_component_back();
893 self.path = &self.path[..self.path.len() - size];
899 self.back = State::StartDir;
902 self.back = State::Prefix;
903 if self.has_physical_root {
904 self.path = &self.path[..self.path.len() - 1];
905 return Some(Component::RootDir);
906 } else if let Some(p) = self.prefix {
907 if p.has_implicit_root() && !p.is_verbatim() {
908 return Some(Component::RootDir);
910 } else if self.include_cur_dir() {
911 self.path = &self.path[..self.path.len() - 1];
912 return Some(Component::CurDir);
915 State::Prefix if self.prefix_len() > 0 => {
916 self.back = State::Done;
917 return Some(Component::Prefix(PrefixComponent {
918 raw: unsafe { u8_slice_as_os_str(self.path) },
919 parsed: self.prefix.unwrap(),
923 self.back = State::Done;
926 State::Done => unreachable!(),
933 #[stable(feature = "fused", since = "1.26.0")]
934 impl FusedIterator for Components<'_> {}
936 #[stable(feature = "rust1", since = "1.0.0")]
937 impl<'a> cmp::PartialEq for Components<'a> {
938 fn eq(&self, other: &Components<'a>) -> bool {
939 Iterator::eq(self.clone(), other.clone())
943 #[stable(feature = "rust1", since = "1.0.0")]
944 impl cmp::Eq for Components<'_> {}
946 #[stable(feature = "rust1", since = "1.0.0")]
947 impl<'a> cmp::PartialOrd for Components<'a> {
948 fn partial_cmp(&self, other: &Components<'a>) -> Option<cmp::Ordering> {
949 Iterator::partial_cmp(self.clone(), other.clone())
953 #[stable(feature = "rust1", since = "1.0.0")]
954 impl cmp::Ord for Components<'_> {
955 fn cmp(&self, other: &Self) -> cmp::Ordering {
956 Iterator::cmp(self.clone(), other.clone())
960 /// An iterator over [`Path`] and its ancestors.
962 /// This `struct` is created by the [`ancestors`] method on [`Path`].
963 /// See its documentation for more.
968 /// use std::path::Path;
970 /// let path = Path::new("/foo/bar");
972 /// for ancestor in path.ancestors() {
973 /// println!("{}", ancestor.display());
977 /// [`ancestors`]: Path::ancestors
978 #[derive(Copy, Clone, Debug)]
979 #[stable(feature = "path_ancestors", since = "1.28.0")]
980 pub struct Ancestors<'a> {
981 next: Option<&'a Path>,
984 #[stable(feature = "path_ancestors", since = "1.28.0")]
985 impl<'a> Iterator for Ancestors<'a> {
986 type Item = &'a Path;
988 fn next(&mut self) -> Option<Self::Item> {
989 let next = self.next;
990 self.next = next.and_then(Path::parent);
995 #[stable(feature = "path_ancestors", since = "1.28.0")]
996 impl FusedIterator for Ancestors<'_> {}
998 ////////////////////////////////////////////////////////////////////////////////
999 // Basic types and traits
1000 ////////////////////////////////////////////////////////////////////////////////
1002 /// An owned, mutable path (akin to [`String`]).
1004 /// This type provides methods like [`push`] and [`set_extension`] that mutate
1005 /// the path in place. It also implements [`Deref`] to [`Path`], meaning that
1006 /// all methods on [`Path`] slices are available on `PathBuf` values as well.
1008 /// [`push`]: PathBuf::push
1009 /// [`set_extension`]: PathBuf::set_extension
1011 /// More details about the overall approach can be found in
1012 /// the [module documentation](self).
1016 /// You can use [`push`] to build up a `PathBuf` from
1020 /// use std::path::PathBuf;
1022 /// let mut path = PathBuf::new();
1024 /// path.push(r"C:\");
1025 /// path.push("windows");
1026 /// path.push("system32");
1028 /// path.set_extension("dll");
1031 /// However, [`push`] is best used for dynamic situations. This is a better way
1032 /// to do this when you know all of the components ahead of time:
1035 /// use std::path::PathBuf;
1037 /// let path: PathBuf = [r"C:\", "windows", "system32.dll"].iter().collect();
1040 /// We can still do better than this! Since these are all strings, we can use
1044 /// use std::path::PathBuf;
1046 /// let path = PathBuf::from(r"C:\windows\system32.dll");
1049 /// Which method works best depends on what kind of situation you're in.
1051 #[stable(feature = "rust1", since = "1.0.0")]
1053 // `PathBuf::as_mut_vec` current implementation relies
1054 // on `PathBuf` being layout-compatible with `Vec<u8>`.
1055 // When attribute privacy is implemented, `PathBuf` should be annotated as `#[repr(transparent)]`.
1056 // Anyway, `PathBuf` representation and layout are considered implementation detail, are
1057 // not documented and must not be relied upon.
1058 pub struct PathBuf {
1063 fn as_mut_vec(&mut self) -> &mut Vec<u8> {
1064 unsafe { &mut *(self as *mut PathBuf as *mut Vec<u8>) }
1067 /// Allocates an empty `PathBuf`.
1072 /// use std::path::PathBuf;
1074 /// let path = PathBuf::new();
1076 #[stable(feature = "rust1", since = "1.0.0")]
1077 pub fn new() -> PathBuf {
1078 PathBuf { inner: OsString::new() }
1081 /// Creates a new `PathBuf` with a given capacity used to create the
1082 /// internal [`OsString`]. See [`with_capacity`] defined on [`OsString`].
1087 /// use std::path::PathBuf;
1089 /// let mut path = PathBuf::with_capacity(10);
1090 /// let capacity = path.capacity();
1092 /// // This push is done without reallocating
1093 /// path.push(r"C:\");
1095 /// assert_eq!(capacity, path.capacity());
1098 /// [`with_capacity`]: OsString::with_capacity
1099 #[stable(feature = "path_buf_capacity", since = "1.44.0")]
1100 pub fn with_capacity(capacity: usize) -> PathBuf {
1101 PathBuf { inner: OsString::with_capacity(capacity) }
1104 /// Coerces to a [`Path`] slice.
1109 /// use std::path::{Path, PathBuf};
1111 /// let p = PathBuf::from("/test");
1112 /// assert_eq!(Path::new("/test"), p.as_path());
1114 #[stable(feature = "rust1", since = "1.0.0")]
1115 pub fn as_path(&self) -> &Path {
1119 /// Extends `self` with `path`.
1121 /// If `path` is absolute, it replaces the current path.
1125 /// * if `path` has a root but no prefix (e.g., `\windows`), it
1126 /// replaces everything except for the prefix (if any) of `self`.
1127 /// * if `path` has a prefix but no root, it replaces `self`.
1131 /// Pushing a relative path extends the existing path:
1134 /// use std::path::PathBuf;
1136 /// let mut path = PathBuf::from("/tmp");
1137 /// path.push("file.bk");
1138 /// assert_eq!(path, PathBuf::from("/tmp/file.bk"));
1141 /// Pushing an absolute path replaces the existing path:
1144 /// use std::path::PathBuf;
1146 /// let mut path = PathBuf::from("/tmp");
1147 /// path.push("/etc");
1148 /// assert_eq!(path, PathBuf::from("/etc"));
1150 #[stable(feature = "rust1", since = "1.0.0")]
1151 pub fn push<P: AsRef<Path>>(&mut self, path: P) {
1152 self._push(path.as_ref())
1155 fn _push(&mut self, path: &Path) {
1156 // in general, a separator is needed if the rightmost byte is not a separator
1157 let mut need_sep = self.as_mut_vec().last().map(|c| !is_sep_byte(*c)).unwrap_or(false);
1159 // in the special case of `C:` on Windows, do *not* add a separator
1161 let comps = self.components();
1162 if comps.prefix_len() > 0
1163 && comps.prefix_len() == comps.path.len()
1164 && comps.prefix.unwrap().is_drive()
1170 // absolute `path` replaces `self`
1171 if path.is_absolute() || path.prefix().is_some() {
1172 self.as_mut_vec().truncate(0);
1174 // `path` has a root but no prefix, e.g., `\windows` (Windows only)
1175 } else if path.has_root() {
1176 let prefix_len = self.components().prefix_remaining();
1177 self.as_mut_vec().truncate(prefix_len);
1179 // `path` is a pure relative path
1180 } else if need_sep {
1181 self.inner.push(MAIN_SEP_STR);
1184 self.inner.push(path);
1187 /// Truncates `self` to [`self.parent`].
1189 /// Returns `false` and does nothing if [`self.parent`] is [`None`].
1190 /// Otherwise, returns `true`.
1192 /// [`self.parent`]: Path::parent
1197 /// use std::path::{Path, PathBuf};
1199 /// let mut p = PathBuf::from("/spirited/away.rs");
1202 /// assert_eq!(Path::new("/spirited"), p);
1204 /// assert_eq!(Path::new("/"), p);
1206 #[stable(feature = "rust1", since = "1.0.0")]
1207 pub fn pop(&mut self) -> bool {
1208 match self.parent().map(|p| p.as_u8_slice().len()) {
1210 self.as_mut_vec().truncate(len);
1217 /// Updates [`self.file_name`] to `file_name`.
1219 /// If [`self.file_name`] was [`None`], this is equivalent to pushing
1222 /// Otherwise it is equivalent to calling [`pop`] and then pushing
1223 /// `file_name`. The new path will be a sibling of the original path.
1224 /// (That is, it will have the same parent.)
1226 /// [`self.file_name`]: Path::file_name
1227 /// [`pop`]: PathBuf::pop
1232 /// use std::path::PathBuf;
1234 /// let mut buf = PathBuf::from("/");
1235 /// assert!(buf.file_name() == None);
1236 /// buf.set_file_name("bar");
1237 /// assert!(buf == PathBuf::from("/bar"));
1238 /// assert!(buf.file_name().is_some());
1239 /// buf.set_file_name("baz.txt");
1240 /// assert!(buf == PathBuf::from("/baz.txt"));
1242 #[stable(feature = "rust1", since = "1.0.0")]
1243 pub fn set_file_name<S: AsRef<OsStr>>(&mut self, file_name: S) {
1244 self._set_file_name(file_name.as_ref())
1247 fn _set_file_name(&mut self, file_name: &OsStr) {
1248 if self.file_name().is_some() {
1249 let popped = self.pop();
1250 debug_assert!(popped);
1252 self.push(file_name);
1255 /// Updates [`self.extension`] to `extension`.
1257 /// Returns `false` and does nothing if [`self.file_name`] is [`None`],
1258 /// returns `true` and updates the extension otherwise.
1260 /// If [`self.extension`] is [`None`], the extension is added; otherwise
1263 /// [`self.file_name`]: Path::file_name
1264 /// [`self.extension`]: Path::extension
1269 /// use std::path::{Path, PathBuf};
1271 /// let mut p = PathBuf::from("/feel/the");
1273 /// p.set_extension("force");
1274 /// assert_eq!(Path::new("/feel/the.force"), p.as_path());
1276 /// p.set_extension("dark_side");
1277 /// assert_eq!(Path::new("/feel/the.dark_side"), p.as_path());
1279 #[stable(feature = "rust1", since = "1.0.0")]
1280 pub fn set_extension<S: AsRef<OsStr>>(&mut self, extension: S) -> bool {
1281 self._set_extension(extension.as_ref())
1284 fn _set_extension(&mut self, extension: &OsStr) -> bool {
1285 let file_stem = match self.file_stem() {
1286 None => return false,
1287 Some(f) => os_str_as_u8_slice(f),
1290 // truncate until right after the file stem
1291 let end_file_stem = file_stem[file_stem.len()..].as_ptr() as usize;
1292 let start = os_str_as_u8_slice(&self.inner).as_ptr() as usize;
1293 let v = self.as_mut_vec();
1294 v.truncate(end_file_stem.wrapping_sub(start));
1296 // add the new extension, if any
1297 let new = os_str_as_u8_slice(extension);
1298 if !new.is_empty() {
1299 v.reserve_exact(new.len() + 1);
1301 v.extend_from_slice(new);
1307 /// Consumes the `PathBuf`, yielding its internal [`OsString`] storage.
1312 /// use std::path::PathBuf;
1314 /// let p = PathBuf::from("/the/head");
1315 /// let os_str = p.into_os_string();
1317 #[stable(feature = "rust1", since = "1.0.0")]
1318 pub fn into_os_string(self) -> OsString {
1322 /// Converts this `PathBuf` into a [boxed](Box) [`Path`].
1323 #[stable(feature = "into_boxed_path", since = "1.20.0")]
1324 pub fn into_boxed_path(self) -> Box<Path> {
1325 let rw = Box::into_raw(self.inner.into_boxed_os_str()) as *mut Path;
1326 unsafe { Box::from_raw(rw) }
1329 /// Invokes [`capacity`] on the underlying instance of [`OsString`].
1331 /// [`capacity`]: OsString::capacity
1332 #[stable(feature = "path_buf_capacity", since = "1.44.0")]
1333 pub fn capacity(&self) -> usize {
1334 self.inner.capacity()
1337 /// Invokes [`clear`] on the underlying instance of [`OsString`].
1339 /// [`clear`]: OsString::clear
1340 #[stable(feature = "path_buf_capacity", since = "1.44.0")]
1341 pub fn clear(&mut self) {
1345 /// Invokes [`reserve`] on the underlying instance of [`OsString`].
1347 /// [`reserve`]: OsString::reserve
1348 #[stable(feature = "path_buf_capacity", since = "1.44.0")]
1349 pub fn reserve(&mut self, additional: usize) {
1350 self.inner.reserve(additional)
1353 /// Invokes [`reserve_exact`] on the underlying instance of [`OsString`].
1355 /// [`reserve_exact`]: OsString::reserve_exact
1356 #[stable(feature = "path_buf_capacity", since = "1.44.0")]
1357 pub fn reserve_exact(&mut self, additional: usize) {
1358 self.inner.reserve_exact(additional)
1361 /// Invokes [`shrink_to_fit`] on the underlying instance of [`OsString`].
1363 /// [`shrink_to_fit`]: OsString::shrink_to_fit
1364 #[stable(feature = "path_buf_capacity", since = "1.44.0")]
1365 pub fn shrink_to_fit(&mut self) {
1366 self.inner.shrink_to_fit()
1369 /// Invokes [`shrink_to`] on the underlying instance of [`OsString`].
1371 /// [`shrink_to`]: OsString::shrink_to
1372 #[unstable(feature = "shrink_to", issue = "56431")]
1373 pub fn shrink_to(&mut self, min_capacity: usize) {
1374 self.inner.shrink_to(min_capacity)
1378 #[stable(feature = "box_from_path", since = "1.17.0")]
1379 impl From<&Path> for Box<Path> {
1380 fn from(path: &Path) -> Box<Path> {
1381 let boxed: Box<OsStr> = path.inner.into();
1382 let rw = Box::into_raw(boxed) as *mut Path;
1383 unsafe { Box::from_raw(rw) }
1387 #[stable(feature = "box_from_cow", since = "1.45.0")]
1388 impl From<Cow<'_, Path>> for Box<Path> {
1390 fn from(cow: Cow<'_, Path>) -> Box<Path> {
1392 Cow::Borrowed(path) => Box::from(path),
1393 Cow::Owned(path) => Box::from(path),
1398 #[stable(feature = "path_buf_from_box", since = "1.18.0")]
1399 impl From<Box<Path>> for PathBuf {
1400 /// Converts a `Box<Path>` into a `PathBuf`
1402 /// This conversion does not allocate or copy memory.
1403 fn from(boxed: Box<Path>) -> PathBuf {
1404 boxed.into_path_buf()
1408 #[stable(feature = "box_from_path_buf", since = "1.20.0")]
1409 impl From<PathBuf> for Box<Path> {
1410 /// Converts a `PathBuf` into a `Box<Path>`
1412 /// This conversion currently should not allocate memory,
1413 /// but this behavior is not guaranteed on all platforms or in all future versions.
1414 fn from(p: PathBuf) -> Box<Path> {
1419 #[stable(feature = "more_box_slice_clone", since = "1.29.0")]
1420 impl Clone for Box<Path> {
1422 fn clone(&self) -> Self {
1423 self.to_path_buf().into_boxed_path()
1427 #[stable(feature = "rust1", since = "1.0.0")]
1428 impl<T: ?Sized + AsRef<OsStr>> From<&T> for PathBuf {
1429 fn from(s: &T) -> PathBuf {
1430 PathBuf::from(s.as_ref().to_os_string())
1434 #[stable(feature = "rust1", since = "1.0.0")]
1435 impl From<OsString> for PathBuf {
1436 /// Converts a `OsString` into a `PathBuf`
1438 /// This conversion does not allocate or copy memory.
1440 fn from(s: OsString) -> PathBuf {
1441 PathBuf { inner: s }
1445 #[stable(feature = "from_path_buf_for_os_string", since = "1.14.0")]
1446 impl From<PathBuf> for OsString {
1447 /// Converts a `PathBuf` into a `OsString`
1449 /// This conversion does not allocate or copy memory.
1450 fn from(path_buf: PathBuf) -> OsString {
1455 #[stable(feature = "rust1", since = "1.0.0")]
1456 impl From<String> for PathBuf {
1457 /// Converts a `String` into a `PathBuf`
1459 /// This conversion does not allocate or copy memory.
1460 fn from(s: String) -> PathBuf {
1461 PathBuf::from(OsString::from(s))
1465 #[stable(feature = "path_from_str", since = "1.32.0")]
1466 impl FromStr for PathBuf {
1467 type Err = core::convert::Infallible;
1469 fn from_str(s: &str) -> Result<Self, Self::Err> {
1470 Ok(PathBuf::from(s))
1474 #[stable(feature = "rust1", since = "1.0.0")]
1475 impl<P: AsRef<Path>> iter::FromIterator<P> for PathBuf {
1476 fn from_iter<I: IntoIterator<Item = P>>(iter: I) -> PathBuf {
1477 let mut buf = PathBuf::new();
1483 #[stable(feature = "rust1", since = "1.0.0")]
1484 impl<P: AsRef<Path>> iter::Extend<P> for PathBuf {
1485 fn extend<I: IntoIterator<Item = P>>(&mut self, iter: I) {
1486 iter.into_iter().for_each(move |p| self.push(p.as_ref()));
1490 fn extend_one(&mut self, p: P) {
1491 self.push(p.as_ref());
1495 #[stable(feature = "rust1", since = "1.0.0")]
1496 impl fmt::Debug for PathBuf {
1497 fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
1498 fmt::Debug::fmt(&**self, formatter)
1502 #[stable(feature = "rust1", since = "1.0.0")]
1503 impl ops::Deref for PathBuf {
1506 fn deref(&self) -> &Path {
1507 Path::new(&self.inner)
1511 #[stable(feature = "rust1", since = "1.0.0")]
1512 impl Borrow<Path> for PathBuf {
1513 fn borrow(&self) -> &Path {
1518 #[stable(feature = "default_for_pathbuf", since = "1.17.0")]
1519 impl Default for PathBuf {
1520 fn default() -> Self {
1525 #[stable(feature = "cow_from_path", since = "1.6.0")]
1526 impl<'a> From<&'a Path> for Cow<'a, Path> {
1528 fn from(s: &'a Path) -> Cow<'a, Path> {
1533 #[stable(feature = "cow_from_path", since = "1.6.0")]
1534 impl<'a> From<PathBuf> for Cow<'a, Path> {
1536 fn from(s: PathBuf) -> Cow<'a, Path> {
1541 #[stable(feature = "cow_from_pathbuf_ref", since = "1.28.0")]
1542 impl<'a> From<&'a PathBuf> for Cow<'a, Path> {
1544 fn from(p: &'a PathBuf) -> Cow<'a, Path> {
1545 Cow::Borrowed(p.as_path())
1549 #[stable(feature = "pathbuf_from_cow_path", since = "1.28.0")]
1550 impl<'a> From<Cow<'a, Path>> for PathBuf {
1552 fn from(p: Cow<'a, Path>) -> Self {
1557 #[stable(feature = "shared_from_slice2", since = "1.24.0")]
1558 impl From<PathBuf> for Arc<Path> {
1559 /// Converts a `PathBuf` into an `Arc` by moving the `PathBuf` data into a new `Arc` buffer.
1561 fn from(s: PathBuf) -> Arc<Path> {
1562 let arc: Arc<OsStr> = Arc::from(s.into_os_string());
1563 unsafe { Arc::from_raw(Arc::into_raw(arc) as *const Path) }
1567 #[stable(feature = "shared_from_slice2", since = "1.24.0")]
1568 impl From<&Path> for Arc<Path> {
1569 /// Converts a `Path` into an `Arc` by copying the `Path` data into a new `Arc` buffer.
1571 fn from(s: &Path) -> Arc<Path> {
1572 let arc: Arc<OsStr> = Arc::from(s.as_os_str());
1573 unsafe { Arc::from_raw(Arc::into_raw(arc) as *const Path) }
1577 #[stable(feature = "shared_from_slice2", since = "1.24.0")]
1578 impl From<PathBuf> for Rc<Path> {
1579 /// Converts a `PathBuf` into an `Rc` by moving the `PathBuf` data into a new `Rc` buffer.
1581 fn from(s: PathBuf) -> Rc<Path> {
1582 let rc: Rc<OsStr> = Rc::from(s.into_os_string());
1583 unsafe { Rc::from_raw(Rc::into_raw(rc) as *const Path) }
1587 #[stable(feature = "shared_from_slice2", since = "1.24.0")]
1588 impl From<&Path> for Rc<Path> {
1589 /// Converts a `Path` into an `Rc` by copying the `Path` data into a new `Rc` buffer.
1591 fn from(s: &Path) -> Rc<Path> {
1592 let rc: Rc<OsStr> = Rc::from(s.as_os_str());
1593 unsafe { Rc::from_raw(Rc::into_raw(rc) as *const Path) }
1597 #[stable(feature = "rust1", since = "1.0.0")]
1598 impl ToOwned for Path {
1599 type Owned = PathBuf;
1600 fn to_owned(&self) -> PathBuf {
1603 fn clone_into(&self, target: &mut PathBuf) {
1604 self.inner.clone_into(&mut target.inner);
1608 #[stable(feature = "rust1", since = "1.0.0")]
1609 impl cmp::PartialEq for PathBuf {
1610 fn eq(&self, other: &PathBuf) -> bool {
1611 self.components() == other.components()
1615 #[stable(feature = "rust1", since = "1.0.0")]
1616 impl Hash for PathBuf {
1617 fn hash<H: Hasher>(&self, h: &mut H) {
1618 self.as_path().hash(h)
1622 #[stable(feature = "rust1", since = "1.0.0")]
1623 impl cmp::Eq for PathBuf {}
1625 #[stable(feature = "rust1", since = "1.0.0")]
1626 impl cmp::PartialOrd for PathBuf {
1627 fn partial_cmp(&self, other: &PathBuf) -> Option<cmp::Ordering> {
1628 self.components().partial_cmp(other.components())
1632 #[stable(feature = "rust1", since = "1.0.0")]
1633 impl cmp::Ord for PathBuf {
1634 fn cmp(&self, other: &PathBuf) -> cmp::Ordering {
1635 self.components().cmp(other.components())
1639 #[stable(feature = "rust1", since = "1.0.0")]
1640 impl AsRef<OsStr> for PathBuf {
1641 fn as_ref(&self) -> &OsStr {
1646 /// A slice of a path (akin to [`str`]).
1648 /// This type supports a number of operations for inspecting a path, including
1649 /// breaking the path into its components (separated by `/` on Unix and by either
1650 /// `/` or `\` on Windows), extracting the file name, determining whether the path
1651 /// is absolute, and so on.
1653 /// This is an *unsized* type, meaning that it must always be used behind a
1654 /// pointer like `&` or [`Box`]. For an owned version of this type,
1655 /// see [`PathBuf`].
1657 /// More details about the overall approach can be found in
1658 /// the [module documentation](self).
1663 /// use std::path::Path;
1664 /// use std::ffi::OsStr;
1666 /// // Note: this example does work on Windows
1667 /// let path = Path::new("./foo/bar.txt");
1669 /// let parent = path.parent();
1670 /// assert_eq!(parent, Some(Path::new("./foo")));
1672 /// let file_stem = path.file_stem();
1673 /// assert_eq!(file_stem, Some(OsStr::new("bar")));
1675 /// let extension = path.extension();
1676 /// assert_eq!(extension, Some(OsStr::new("txt")));
1678 #[stable(feature = "rust1", since = "1.0.0")]
1680 // `Path::new` current implementation relies
1681 // on `Path` being layout-compatible with `OsStr`.
1682 // When attribute privacy is implemented, `Path` should be annotated as `#[repr(transparent)]`.
1683 // Anyway, `Path` representation and layout are considered implementation detail, are
1684 // not documented and must not be relied upon.
1689 /// An error returned from [`Path::strip_prefix`] if the prefix was not found.
1691 /// This `struct` is created by the [`strip_prefix`] method on [`Path`].
1692 /// See its documentation for more.
1694 /// [`strip_prefix`]: Path::strip_prefix
1695 #[derive(Debug, Clone, PartialEq, Eq)]
1696 #[stable(since = "1.7.0", feature = "strip_prefix")]
1697 pub struct StripPrefixError(());
1700 // The following (private!) function allows construction of a path from a u8
1701 // slice, which is only safe when it is known to follow the OsStr encoding.
1702 unsafe fn from_u8_slice(s: &[u8]) -> &Path {
1703 unsafe { Path::new(u8_slice_as_os_str(s)) }
1705 // The following (private!) function reveals the byte encoding used for OsStr.
1706 fn as_u8_slice(&self) -> &[u8] {
1707 os_str_as_u8_slice(&self.inner)
1710 /// Directly wraps a string slice as a `Path` slice.
1712 /// This is a cost-free conversion.
1717 /// use std::path::Path;
1719 /// Path::new("foo.txt");
1722 /// You can create `Path`s from `String`s, or even other `Path`s:
1725 /// use std::path::Path;
1727 /// let string = String::from("foo.txt");
1728 /// let from_string = Path::new(&string);
1729 /// let from_path = Path::new(&from_string);
1730 /// assert_eq!(from_string, from_path);
1732 #[stable(feature = "rust1", since = "1.0.0")]
1733 pub fn new<S: AsRef<OsStr> + ?Sized>(s: &S) -> &Path {
1734 unsafe { &*(s.as_ref() as *const OsStr as *const Path) }
1737 /// Yields the underlying [`OsStr`] slice.
1742 /// use std::path::Path;
1744 /// let os_str = Path::new("foo.txt").as_os_str();
1745 /// assert_eq!(os_str, std::ffi::OsStr::new("foo.txt"));
1747 #[stable(feature = "rust1", since = "1.0.0")]
1748 pub fn as_os_str(&self) -> &OsStr {
1752 /// Yields a [`&str`] slice if the `Path` is valid unicode.
1754 /// This conversion may entail doing a check for UTF-8 validity.
1755 /// Note that validation is performed because non-UTF-8 strings are
1756 /// perfectly valid for some OS.
1763 /// use std::path::Path;
1765 /// let path = Path::new("foo.txt");
1766 /// assert_eq!(path.to_str(), Some("foo.txt"));
1768 #[stable(feature = "rust1", since = "1.0.0")]
1769 pub fn to_str(&self) -> Option<&str> {
1773 /// Converts a `Path` to a [`Cow<str>`].
1775 /// Any non-Unicode sequences are replaced with
1776 /// [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD].
1778 /// [`Cow<str>`]: Cow
1779 /// [U+FFFD]: super::char::REPLACEMENT_CHARACTER
1783 /// Calling `to_string_lossy` on a `Path` with valid unicode:
1786 /// use std::path::Path;
1788 /// let path = Path::new("foo.txt");
1789 /// assert_eq!(path.to_string_lossy(), "foo.txt");
1792 /// Had `path` contained invalid unicode, the `to_string_lossy` call might
1793 /// have returned `"fo�.txt"`.
1794 #[stable(feature = "rust1", since = "1.0.0")]
1795 pub fn to_string_lossy(&self) -> Cow<'_, str> {
1796 self.inner.to_string_lossy()
1799 /// Converts a `Path` to an owned [`PathBuf`].
1804 /// use std::path::Path;
1806 /// let path_buf = Path::new("foo.txt").to_path_buf();
1807 /// assert_eq!(path_buf, std::path::PathBuf::from("foo.txt"));
1809 #[rustc_conversion_suggestion]
1810 #[stable(feature = "rust1", since = "1.0.0")]
1811 pub fn to_path_buf(&self) -> PathBuf {
1812 PathBuf::from(self.inner.to_os_string())
1815 /// Returns `true` if the `Path` is absolute, i.e., if it is independent of
1816 /// the current directory.
1818 /// * On Unix, a path is absolute if it starts with the root, so
1819 /// `is_absolute` and [`has_root`] are equivalent.
1821 /// * On Windows, a path is absolute if it has a prefix and starts with the
1822 /// root: `c:\windows` is absolute, while `c:temp` and `\temp` are not.
1827 /// use std::path::Path;
1829 /// assert!(!Path::new("foo.txt").is_absolute());
1832 /// [`has_root`]: Path::has_root
1833 #[stable(feature = "rust1", since = "1.0.0")]
1834 #[allow(deprecated)]
1835 pub fn is_absolute(&self) -> bool {
1836 if cfg!(target_os = "redox") {
1837 // FIXME: Allow Redox prefixes
1838 self.has_root() || has_redox_scheme(self.as_u8_slice())
1840 self.has_root() && (cfg!(any(unix, target_os = "wasi")) || self.prefix().is_some())
1844 /// Returns `true` if the `Path` is relative, i.e., not absolute.
1846 /// See [`is_absolute`]'s documentation for more details.
1851 /// use std::path::Path;
1853 /// assert!(Path::new("foo.txt").is_relative());
1856 /// [`is_absolute`]: Path::is_absolute
1857 #[stable(feature = "rust1", since = "1.0.0")]
1858 pub fn is_relative(&self) -> bool {
1862 fn prefix(&self) -> Option<Prefix<'_>> {
1863 self.components().prefix
1866 /// Returns `true` if the `Path` has a root.
1868 /// * On Unix, a path has a root if it begins with `/`.
1870 /// * On Windows, a path has a root if it:
1871 /// * has no prefix and begins with a separator, e.g., `\windows`
1872 /// * has a prefix followed by a separator, e.g., `c:\windows` but not `c:windows`
1873 /// * has any non-disk prefix, e.g., `\\server\share`
1878 /// use std::path::Path;
1880 /// assert!(Path::new("/etc/passwd").has_root());
1882 #[stable(feature = "rust1", since = "1.0.0")]
1883 pub fn has_root(&self) -> bool {
1884 self.components().has_root()
1887 /// Returns the `Path` without its final component, if there is one.
1889 /// Returns [`None`] if the path terminates in a root or prefix.
1894 /// use std::path::Path;
1896 /// let path = Path::new("/foo/bar");
1897 /// let parent = path.parent().unwrap();
1898 /// assert_eq!(parent, Path::new("/foo"));
1900 /// let grand_parent = parent.parent().unwrap();
1901 /// assert_eq!(grand_parent, Path::new("/"));
1902 /// assert_eq!(grand_parent.parent(), None);
1904 #[stable(feature = "rust1", since = "1.0.0")]
1905 pub fn parent(&self) -> Option<&Path> {
1906 let mut comps = self.components();
1907 let comp = comps.next_back();
1908 comp.and_then(|p| match p {
1909 Component::Normal(_) | Component::CurDir | Component::ParentDir => {
1910 Some(comps.as_path())
1916 /// Produces an iterator over `Path` and its ancestors.
1918 /// The iterator will yield the `Path` that is returned if the [`parent`] method is used zero
1919 /// or more times. That means, the iterator will yield `&self`, `&self.parent().unwrap()`,
1920 /// `&self.parent().unwrap().parent().unwrap()` and so on. If the [`parent`] method returns
1921 /// [`None`], the iterator will do likewise. The iterator will always yield at least one value,
1927 /// use std::path::Path;
1929 /// let mut ancestors = Path::new("/foo/bar").ancestors();
1930 /// assert_eq!(ancestors.next(), Some(Path::new("/foo/bar")));
1931 /// assert_eq!(ancestors.next(), Some(Path::new("/foo")));
1932 /// assert_eq!(ancestors.next(), Some(Path::new("/")));
1933 /// assert_eq!(ancestors.next(), None);
1935 /// let mut ancestors = Path::new("../foo/bar").ancestors();
1936 /// assert_eq!(ancestors.next(), Some(Path::new("../foo/bar")));
1937 /// assert_eq!(ancestors.next(), Some(Path::new("../foo")));
1938 /// assert_eq!(ancestors.next(), Some(Path::new("..")));
1939 /// assert_eq!(ancestors.next(), Some(Path::new("")));
1940 /// assert_eq!(ancestors.next(), None);
1943 /// [`parent`]: Path::parent
1944 #[stable(feature = "path_ancestors", since = "1.28.0")]
1945 pub fn ancestors(&self) -> Ancestors<'_> {
1946 Ancestors { next: Some(&self) }
1949 /// Returns the final component of the `Path`, if there is one.
1951 /// If the path is a normal file, this is the file name. If it's the path of a directory, this
1952 /// is the directory name.
1954 /// Returns [`None`] if the path terminates in `..`.
1959 /// use std::path::Path;
1960 /// use std::ffi::OsStr;
1962 /// assert_eq!(Some(OsStr::new("bin")), Path::new("/usr/bin/").file_name());
1963 /// assert_eq!(Some(OsStr::new("foo.txt")), Path::new("tmp/foo.txt").file_name());
1964 /// assert_eq!(Some(OsStr::new("foo.txt")), Path::new("foo.txt/.").file_name());
1965 /// assert_eq!(Some(OsStr::new("foo.txt")), Path::new("foo.txt/.//").file_name());
1966 /// assert_eq!(None, Path::new("foo.txt/..").file_name());
1967 /// assert_eq!(None, Path::new("/").file_name());
1969 #[stable(feature = "rust1", since = "1.0.0")]
1970 pub fn file_name(&self) -> Option<&OsStr> {
1971 self.components().next_back().and_then(|p| match p {
1972 Component::Normal(p) => Some(p),
1977 /// Returns a path that, when joined onto `base`, yields `self`.
1981 /// If `base` is not a prefix of `self` (i.e., [`starts_with`]
1982 /// returns `false`), returns [`Err`].
1984 /// [`starts_with`]: Path::starts_with
1989 /// use std::path::{Path, PathBuf};
1991 /// let path = Path::new("/test/haha/foo.txt");
1993 /// assert_eq!(path.strip_prefix("/"), Ok(Path::new("test/haha/foo.txt")));
1994 /// assert_eq!(path.strip_prefix("/test"), Ok(Path::new("haha/foo.txt")));
1995 /// assert_eq!(path.strip_prefix("/test/"), Ok(Path::new("haha/foo.txt")));
1996 /// assert_eq!(path.strip_prefix("/test/haha/foo.txt"), Ok(Path::new("")));
1997 /// assert_eq!(path.strip_prefix("/test/haha/foo.txt/"), Ok(Path::new("")));
1999 /// assert!(path.strip_prefix("test").is_err());
2000 /// assert!(path.strip_prefix("/haha").is_err());
2002 /// let prefix = PathBuf::from("/test/");
2003 /// assert_eq!(path.strip_prefix(prefix), Ok(Path::new("haha/foo.txt")));
2005 #[stable(since = "1.7.0", feature = "path_strip_prefix")]
2006 pub fn strip_prefix<P>(&self, base: P) -> Result<&Path, StripPrefixError>
2010 self._strip_prefix(base.as_ref())
2013 fn _strip_prefix(&self, base: &Path) -> Result<&Path, StripPrefixError> {
2014 iter_after(self.components(), base.components())
2015 .map(|c| c.as_path())
2016 .ok_or(StripPrefixError(()))
2019 /// Determines whether `base` is a prefix of `self`.
2021 /// Only considers whole path components to match.
2026 /// use std::path::Path;
2028 /// let path = Path::new("/etc/passwd");
2030 /// assert!(path.starts_with("/etc"));
2031 /// assert!(path.starts_with("/etc/"));
2032 /// assert!(path.starts_with("/etc/passwd"));
2033 /// assert!(path.starts_with("/etc/passwd/")); // extra slash is okay
2034 /// assert!(path.starts_with("/etc/passwd///")); // multiple extra slashes are okay
2036 /// assert!(!path.starts_with("/e"));
2037 /// assert!(!path.starts_with("/etc/passwd.txt"));
2039 /// assert!(!Path::new("/etc/foo.rs").starts_with("/etc/foo"));
2041 #[stable(feature = "rust1", since = "1.0.0")]
2042 pub fn starts_with<P: AsRef<Path>>(&self, base: P) -> bool {
2043 self._starts_with(base.as_ref())
2046 fn _starts_with(&self, base: &Path) -> bool {
2047 iter_after(self.components(), base.components()).is_some()
2050 /// Determines whether `child` is a suffix of `self`.
2052 /// Only considers whole path components to match.
2057 /// use std::path::Path;
2059 /// let path = Path::new("/etc/resolv.conf");
2061 /// assert!(path.ends_with("resolv.conf"));
2062 /// assert!(path.ends_with("etc/resolv.conf"));
2063 /// assert!(path.ends_with("/etc/resolv.conf"));
2065 /// assert!(!path.ends_with("/resolv.conf"));
2066 /// assert!(!path.ends_with("conf")); // use .extension() instead
2068 #[stable(feature = "rust1", since = "1.0.0")]
2069 pub fn ends_with<P: AsRef<Path>>(&self, child: P) -> bool {
2070 self._ends_with(child.as_ref())
2073 fn _ends_with(&self, child: &Path) -> bool {
2074 iter_after(self.components().rev(), child.components().rev()).is_some()
2077 /// Extracts the stem (non-extension) portion of [`self.file_name`].
2079 /// [`self.file_name`]: Path::file_name
2083 /// * [`None`], if there is no file name;
2084 /// * The entire file name if there is no embedded `.`;
2085 /// * The entire file name if the file name begins with `.` and has no other `.`s within;
2086 /// * Otherwise, the portion of the file name before the final `.`
2091 /// use std::path::Path;
2093 /// assert_eq!("foo", Path::new("foo.rs").file_stem().unwrap());
2094 /// assert_eq!("foo.tar", Path::new("foo.tar.gz").file_stem().unwrap());
2096 #[stable(feature = "rust1", since = "1.0.0")]
2097 pub fn file_stem(&self) -> Option<&OsStr> {
2098 self.file_name().map(split_file_at_dot).and_then(|(before, after)| before.or(after))
2101 /// Extracts the extension of [`self.file_name`], if possible.
2103 /// The extension is:
2105 /// * [`None`], if there is no file name;
2106 /// * [`None`], if there is no embedded `.`;
2107 /// * [`None`], if the file name begins with `.` and has no other `.`s within;
2108 /// * Otherwise, the portion of the file name after the final `.`
2110 /// [`self.file_name`]: Path::file_name
2115 /// use std::path::Path;
2117 /// assert_eq!("rs", Path::new("foo.rs").extension().unwrap());
2118 /// assert_eq!("gz", Path::new("foo.tar.gz").extension().unwrap());
2120 #[stable(feature = "rust1", since = "1.0.0")]
2121 pub fn extension(&self) -> Option<&OsStr> {
2122 self.file_name().map(split_file_at_dot).and_then(|(before, after)| before.and(after))
2125 /// Creates an owned [`PathBuf`] with `path` adjoined to `self`.
2127 /// See [`PathBuf::push`] for more details on what it means to adjoin a path.
2132 /// use std::path::{Path, PathBuf};
2134 /// assert_eq!(Path::new("/etc").join("passwd"), PathBuf::from("/etc/passwd"));
2136 #[stable(feature = "rust1", since = "1.0.0")]
2138 pub fn join<P: AsRef<Path>>(&self, path: P) -> PathBuf {
2139 self._join(path.as_ref())
2142 fn _join(&self, path: &Path) -> PathBuf {
2143 let mut buf = self.to_path_buf();
2148 /// Creates an owned [`PathBuf`] like `self` but with the given file name.
2150 /// See [`PathBuf::set_file_name`] for more details.
2155 /// use std::path::{Path, PathBuf};
2157 /// let path = Path::new("/tmp/foo.txt");
2158 /// assert_eq!(path.with_file_name("bar.txt"), PathBuf::from("/tmp/bar.txt"));
2160 /// let path = Path::new("/tmp");
2161 /// assert_eq!(path.with_file_name("var"), PathBuf::from("/var"));
2163 #[stable(feature = "rust1", since = "1.0.0")]
2164 pub fn with_file_name<S: AsRef<OsStr>>(&self, file_name: S) -> PathBuf {
2165 self._with_file_name(file_name.as_ref())
2168 fn _with_file_name(&self, file_name: &OsStr) -> PathBuf {
2169 let mut buf = self.to_path_buf();
2170 buf.set_file_name(file_name);
2174 /// Creates an owned [`PathBuf`] like `self` but with the given extension.
2176 /// See [`PathBuf::set_extension`] for more details.
2181 /// use std::path::{Path, PathBuf};
2183 /// let path = Path::new("foo.rs");
2184 /// assert_eq!(path.with_extension("txt"), PathBuf::from("foo.txt"));
2186 /// let path = Path::new("foo.tar.gz");
2187 /// assert_eq!(path.with_extension(""), PathBuf::from("foo.tar"));
2188 /// assert_eq!(path.with_extension("xz"), PathBuf::from("foo.tar.xz"));
2189 /// assert_eq!(path.with_extension("").with_extension("txt"), PathBuf::from("foo.txt"));
2191 #[stable(feature = "rust1", since = "1.0.0")]
2192 pub fn with_extension<S: AsRef<OsStr>>(&self, extension: S) -> PathBuf {
2193 self._with_extension(extension.as_ref())
2196 fn _with_extension(&self, extension: &OsStr) -> PathBuf {
2197 let mut buf = self.to_path_buf();
2198 buf.set_extension(extension);
2202 /// Produces an iterator over the [`Component`]s of the path.
2204 /// When parsing the path, there is a small amount of normalization:
2206 /// * Repeated separators are ignored, so `a/b` and `a//b` both have
2207 /// `a` and `b` as components.
2209 /// * Occurrences of `.` are normalized away, except if they are at the
2210 /// beginning of the path. For example, `a/./b`, `a/b/`, `a/b/.` and
2211 /// `a/b` all have `a` and `b` as components, but `./a/b` starts with
2212 /// an additional [`CurDir`] component.
2214 /// * A trailing slash is normalized away, `/a/b` and `/a/b/` are equivalent.
2216 /// Note that no other normalization takes place; in particular, `a/c`
2217 /// and `a/b/../c` are distinct, to account for the possibility that `b`
2218 /// is a symbolic link (so its parent isn't `a`).
2223 /// use std::path::{Path, Component};
2224 /// use std::ffi::OsStr;
2226 /// let mut components = Path::new("/tmp/foo.txt").components();
2228 /// assert_eq!(components.next(), Some(Component::RootDir));
2229 /// assert_eq!(components.next(), Some(Component::Normal(OsStr::new("tmp"))));
2230 /// assert_eq!(components.next(), Some(Component::Normal(OsStr::new("foo.txt"))));
2231 /// assert_eq!(components.next(), None)
2234 /// [`CurDir`]: Component::CurDir
2235 #[stable(feature = "rust1", since = "1.0.0")]
2236 pub fn components(&self) -> Components<'_> {
2237 let prefix = parse_prefix(self.as_os_str());
2239 path: self.as_u8_slice(),
2241 has_physical_root: has_physical_root(self.as_u8_slice(), prefix)
2242 || has_redox_scheme(self.as_u8_slice()),
2243 front: State::Prefix,
2248 /// Produces an iterator over the path's components viewed as [`OsStr`]
2251 /// For more information about the particulars of how the path is separated
2252 /// into components, see [`components`].
2254 /// [`components`]: Path::components
2259 /// use std::path::{self, Path};
2260 /// use std::ffi::OsStr;
2262 /// let mut it = Path::new("/tmp/foo.txt").iter();
2263 /// assert_eq!(it.next(), Some(OsStr::new(&path::MAIN_SEPARATOR.to_string())));
2264 /// assert_eq!(it.next(), Some(OsStr::new("tmp")));
2265 /// assert_eq!(it.next(), Some(OsStr::new("foo.txt")));
2266 /// assert_eq!(it.next(), None)
2268 #[stable(feature = "rust1", since = "1.0.0")]
2269 pub fn iter(&self) -> Iter<'_> {
2270 Iter { inner: self.components() }
2273 /// Returns an object that implements [`Display`] for safely printing paths
2274 /// that may contain non-Unicode data.
2276 /// [`Display`]: fmt::Display
2281 /// use std::path::Path;
2283 /// let path = Path::new("/tmp/foo.rs");
2285 /// println!("{}", path.display());
2287 #[stable(feature = "rust1", since = "1.0.0")]
2288 pub fn display(&self) -> Display<'_> {
2289 Display { path: self }
2292 /// Queries the file system to get information about a file, directory, etc.
2294 /// This function will traverse symbolic links to query information about the
2295 /// destination file.
2297 /// This is an alias to [`fs::metadata`].
2302 /// use std::path::Path;
2304 /// let path = Path::new("/Minas/tirith");
2305 /// let metadata = path.metadata().expect("metadata call failed");
2306 /// println!("{:?}", metadata.file_type());
2308 #[stable(feature = "path_ext", since = "1.5.0")]
2309 pub fn metadata(&self) -> io::Result<fs::Metadata> {
2313 /// Queries the metadata about a file without following symlinks.
2315 /// This is an alias to [`fs::symlink_metadata`].
2320 /// use std::path::Path;
2322 /// let path = Path::new("/Minas/tirith");
2323 /// let metadata = path.symlink_metadata().expect("symlink_metadata call failed");
2324 /// println!("{:?}", metadata.file_type());
2326 #[stable(feature = "path_ext", since = "1.5.0")]
2327 pub fn symlink_metadata(&self) -> io::Result<fs::Metadata> {
2328 fs::symlink_metadata(self)
2331 /// Returns the canonical, absolute form of the path with all intermediate
2332 /// components normalized and symbolic links resolved.
2334 /// This is an alias to [`fs::canonicalize`].
2339 /// use std::path::{Path, PathBuf};
2341 /// let path = Path::new("/foo/test/../test/bar.rs");
2342 /// assert_eq!(path.canonicalize().unwrap(), PathBuf::from("/foo/test/bar.rs"));
2344 #[stable(feature = "path_ext", since = "1.5.0")]
2345 pub fn canonicalize(&self) -> io::Result<PathBuf> {
2346 fs::canonicalize(self)
2349 /// Reads a symbolic link, returning the file that the link points to.
2351 /// This is an alias to [`fs::read_link`].
2356 /// use std::path::Path;
2358 /// let path = Path::new("/laputa/sky_castle.rs");
2359 /// let path_link = path.read_link().expect("read_link call failed");
2361 #[stable(feature = "path_ext", since = "1.5.0")]
2362 pub fn read_link(&self) -> io::Result<PathBuf> {
2366 /// Returns an iterator over the entries within a directory.
2368 /// The iterator will yield instances of [`io::Result`]`<`[`fs::DirEntry`]`>`. New
2369 /// errors may be encountered after an iterator is initially constructed.
2371 /// This is an alias to [`fs::read_dir`].
2376 /// use std::path::Path;
2378 /// let path = Path::new("/laputa");
2379 /// for entry in path.read_dir().expect("read_dir call failed") {
2380 /// if let Ok(entry) = entry {
2381 /// println!("{:?}", entry.path());
2385 #[stable(feature = "path_ext", since = "1.5.0")]
2386 pub fn read_dir(&self) -> io::Result<fs::ReadDir> {
2390 /// Returns `true` if the path points at an existing entity.
2392 /// This function will traverse symbolic links to query information about the
2393 /// destination file. In case of broken symbolic links this will return `false`.
2395 /// If you cannot access the directory containing the file, e.g., because of a
2396 /// permission error, this will return `false`.
2401 /// use std::path::Path;
2402 /// assert!(!Path::new("does_not_exist.txt").exists());
2407 /// This is a convenience function that coerces errors to false. If you want to
2408 /// check errors, call [`fs::metadata`].
2409 #[stable(feature = "path_ext", since = "1.5.0")]
2410 pub fn exists(&self) -> bool {
2411 fs::metadata(self).is_ok()
2414 /// Returns `true` if the path exists on disk and is pointing at a regular file.
2416 /// This function will traverse symbolic links to query information about the
2417 /// destination file. In case of broken symbolic links this will return `false`.
2419 /// If you cannot access the directory containing the file, e.g., because of a
2420 /// permission error, this will return `false`.
2425 /// use std::path::Path;
2426 /// assert_eq!(Path::new("./is_a_directory/").is_file(), false);
2427 /// assert_eq!(Path::new("a_file.txt").is_file(), true);
2432 /// This is a convenience function that coerces errors to false. If you want to
2433 /// check errors, call [`fs::metadata`] and handle its [`Result`]. Then call
2434 /// [`fs::Metadata::is_file`] if it was [`Ok`].
2436 /// When the goal is simply to read from (or write to) the source, the most
2437 /// reliable way to test the source can be read (or written to) is to open
2438 /// it. Only using `is_file` can break workflows like `diff <( prog_a )` on
2439 /// a Unix-like system for example. See [`fs::File::open`] or
2440 /// [`fs::OpenOptions::open`] for more information.
2441 #[stable(feature = "path_ext", since = "1.5.0")]
2442 pub fn is_file(&self) -> bool {
2443 fs::metadata(self).map(|m| m.is_file()).unwrap_or(false)
2446 /// Returns `true` if the path exists on disk and is pointing at a directory.
2448 /// This function will traverse symbolic links to query information about the
2449 /// destination file. In case of broken symbolic links this will return `false`.
2451 /// If you cannot access the directory containing the file, e.g., because of a
2452 /// permission error, this will return `false`.
2457 /// use std::path::Path;
2458 /// assert_eq!(Path::new("./is_a_directory/").is_dir(), true);
2459 /// assert_eq!(Path::new("a_file.txt").is_dir(), false);
2464 /// This is a convenience function that coerces errors to false. If you want to
2465 /// check errors, call [`fs::metadata`] and handle its [`Result`]. Then call
2466 /// [`fs::Metadata::is_dir`] if it was [`Ok`].
2467 #[stable(feature = "path_ext", since = "1.5.0")]
2468 pub fn is_dir(&self) -> bool {
2469 fs::metadata(self).map(|m| m.is_dir()).unwrap_or(false)
2472 /// Converts a [`Box<Path>`](Box) into a [`PathBuf`] without copying or
2474 #[stable(feature = "into_boxed_path", since = "1.20.0")]
2475 pub fn into_path_buf(self: Box<Path>) -> PathBuf {
2476 let rw = Box::into_raw(self) as *mut OsStr;
2477 let inner = unsafe { Box::from_raw(rw) };
2478 PathBuf { inner: OsString::from(inner) }
2482 #[stable(feature = "rust1", since = "1.0.0")]
2483 impl AsRef<OsStr> for Path {
2484 fn as_ref(&self) -> &OsStr {
2489 #[stable(feature = "rust1", since = "1.0.0")]
2490 impl fmt::Debug for Path {
2491 fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
2492 fmt::Debug::fmt(&self.inner, formatter)
2496 /// Helper struct for safely printing paths with [`format!`] and `{}`.
2498 /// A [`Path`] might contain non-Unicode data. This `struct` implements the
2499 /// [`Display`] trait in a way that mitigates that. It is created by the
2500 /// [`display`](Path::display) method on [`Path`].
2505 /// use std::path::Path;
2507 /// let path = Path::new("/tmp/foo.rs");
2509 /// println!("{}", path.display());
2512 /// [`Display`]: fmt::Display
2513 /// [`format!`]: crate::format
2514 #[stable(feature = "rust1", since = "1.0.0")]
2515 pub struct Display<'a> {
2519 #[stable(feature = "rust1", since = "1.0.0")]
2520 impl fmt::Debug for Display<'_> {
2521 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2522 fmt::Debug::fmt(&self.path, f)
2526 #[stable(feature = "rust1", since = "1.0.0")]
2527 impl fmt::Display for Display<'_> {
2528 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2529 self.path.inner.display(f)
2533 #[stable(feature = "rust1", since = "1.0.0")]
2534 impl cmp::PartialEq for Path {
2535 fn eq(&self, other: &Path) -> bool {
2536 self.components().eq(other.components())
2540 #[stable(feature = "rust1", since = "1.0.0")]
2541 impl Hash for Path {
2542 fn hash<H: Hasher>(&self, h: &mut H) {
2543 for component in self.components() {
2549 #[stable(feature = "rust1", since = "1.0.0")]
2550 impl cmp::Eq for Path {}
2552 #[stable(feature = "rust1", since = "1.0.0")]
2553 impl cmp::PartialOrd for Path {
2554 fn partial_cmp(&self, other: &Path) -> Option<cmp::Ordering> {
2555 self.components().partial_cmp(other.components())
2559 #[stable(feature = "rust1", since = "1.0.0")]
2560 impl cmp::Ord for Path {
2561 fn cmp(&self, other: &Path) -> cmp::Ordering {
2562 self.components().cmp(other.components())
2566 #[stable(feature = "rust1", since = "1.0.0")]
2567 impl AsRef<Path> for Path {
2568 fn as_ref(&self) -> &Path {
2573 #[stable(feature = "rust1", since = "1.0.0")]
2574 impl AsRef<Path> for OsStr {
2575 fn as_ref(&self) -> &Path {
2580 #[stable(feature = "cow_os_str_as_ref_path", since = "1.8.0")]
2581 impl AsRef<Path> for Cow<'_, OsStr> {
2582 fn as_ref(&self) -> &Path {
2587 #[stable(feature = "rust1", since = "1.0.0")]
2588 impl AsRef<Path> for OsString {
2589 fn as_ref(&self) -> &Path {
2594 #[stable(feature = "rust1", since = "1.0.0")]
2595 impl AsRef<Path> for str {
2597 fn as_ref(&self) -> &Path {
2602 #[stable(feature = "rust1", since = "1.0.0")]
2603 impl AsRef<Path> for String {
2604 fn as_ref(&self) -> &Path {
2609 #[stable(feature = "rust1", since = "1.0.0")]
2610 impl AsRef<Path> for PathBuf {
2612 fn as_ref(&self) -> &Path {
2617 #[stable(feature = "path_into_iter", since = "1.6.0")]
2618 impl<'a> IntoIterator for &'a PathBuf {
2619 type Item = &'a OsStr;
2620 type IntoIter = Iter<'a>;
2621 fn into_iter(self) -> Iter<'a> {
2626 #[stable(feature = "path_into_iter", since = "1.6.0")]
2627 impl<'a> IntoIterator for &'a Path {
2628 type Item = &'a OsStr;
2629 type IntoIter = Iter<'a>;
2630 fn into_iter(self) -> Iter<'a> {
2635 macro_rules! impl_cmp {
2636 ($lhs:ty, $rhs: ty) => {
2637 #[stable(feature = "partialeq_path", since = "1.6.0")]
2638 impl<'a, 'b> PartialEq<$rhs> for $lhs {
2640 fn eq(&self, other: &$rhs) -> bool {
2641 <Path as PartialEq>::eq(self, other)
2645 #[stable(feature = "partialeq_path", since = "1.6.0")]
2646 impl<'a, 'b> PartialEq<$lhs> for $rhs {
2648 fn eq(&self, other: &$lhs) -> bool {
2649 <Path as PartialEq>::eq(self, other)
2653 #[stable(feature = "cmp_path", since = "1.8.0")]
2654 impl<'a, 'b> PartialOrd<$rhs> for $lhs {
2656 fn partial_cmp(&self, other: &$rhs) -> Option<cmp::Ordering> {
2657 <Path as PartialOrd>::partial_cmp(self, other)
2661 #[stable(feature = "cmp_path", since = "1.8.0")]
2662 impl<'a, 'b> PartialOrd<$lhs> for $rhs {
2664 fn partial_cmp(&self, other: &$lhs) -> Option<cmp::Ordering> {
2665 <Path as PartialOrd>::partial_cmp(self, other)
2671 impl_cmp!(PathBuf, Path);
2672 impl_cmp!(PathBuf, &'a Path);
2673 impl_cmp!(Cow<'a, Path>, Path);
2674 impl_cmp!(Cow<'a, Path>, &'b Path);
2675 impl_cmp!(Cow<'a, Path>, PathBuf);
2677 macro_rules! impl_cmp_os_str {
2678 ($lhs:ty, $rhs: ty) => {
2679 #[stable(feature = "cmp_path", since = "1.8.0")]
2680 impl<'a, 'b> PartialEq<$rhs> for $lhs {
2682 fn eq(&self, other: &$rhs) -> bool {
2683 <Path as PartialEq>::eq(self, other.as_ref())
2687 #[stable(feature = "cmp_path", since = "1.8.0")]
2688 impl<'a, 'b> PartialEq<$lhs> for $rhs {
2690 fn eq(&self, other: &$lhs) -> bool {
2691 <Path as PartialEq>::eq(self.as_ref(), other)
2695 #[stable(feature = "cmp_path", since = "1.8.0")]
2696 impl<'a, 'b> PartialOrd<$rhs> for $lhs {
2698 fn partial_cmp(&self, other: &$rhs) -> Option<cmp::Ordering> {
2699 <Path as PartialOrd>::partial_cmp(self, other.as_ref())
2703 #[stable(feature = "cmp_path", since = "1.8.0")]
2704 impl<'a, 'b> PartialOrd<$lhs> for $rhs {
2706 fn partial_cmp(&self, other: &$lhs) -> Option<cmp::Ordering> {
2707 <Path as PartialOrd>::partial_cmp(self.as_ref(), other)
2713 impl_cmp_os_str!(PathBuf, OsStr);
2714 impl_cmp_os_str!(PathBuf, &'a OsStr);
2715 impl_cmp_os_str!(PathBuf, Cow<'a, OsStr>);
2716 impl_cmp_os_str!(PathBuf, OsString);
2717 impl_cmp_os_str!(Path, OsStr);
2718 impl_cmp_os_str!(Path, &'a OsStr);
2719 impl_cmp_os_str!(Path, Cow<'a, OsStr>);
2720 impl_cmp_os_str!(Path, OsString);
2721 impl_cmp_os_str!(&'a Path, OsStr);
2722 impl_cmp_os_str!(&'a Path, Cow<'b, OsStr>);
2723 impl_cmp_os_str!(&'a Path, OsString);
2724 impl_cmp_os_str!(Cow<'a, Path>, OsStr);
2725 impl_cmp_os_str!(Cow<'a, Path>, &'b OsStr);
2726 impl_cmp_os_str!(Cow<'a, Path>, OsString);
2728 #[stable(since = "1.7.0", feature = "strip_prefix")]
2729 impl fmt::Display for StripPrefixError {
2730 #[allow(deprecated, deprecated_in_future)]
2731 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2732 self.description().fmt(f)
2736 #[stable(since = "1.7.0", feature = "strip_prefix")]
2737 impl Error for StripPrefixError {
2738 #[allow(deprecated)]
2739 fn description(&self) -> &str {