library/std/src/path.rs

   1 //! Cross-platform path manipulation.
   2 //!
   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.
   7 //!
   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.
  14 //!
  15 //! ## Case sensitivity
  16 //!
  17 //! Unless otherwise indicated path methods that do not access the filesystem,
  18 //! such as [`Path::starts_with`] and [`Path::ends_with`], are case sensitive no
  19 //! matter the platform or filesystem. An exception to this is made for Windows
  20 //! drive letters.
  21 //!
  22 //! ## Simple usage
  23 //!
  24 //! Path manipulation includes both parsing components from slices and building
  25 //! new owned paths.
  26 //!
  27 //! To parse a path, you can create a [`Path`] slice from a [`str`]
  28 //! slice and start asking questions:
  29 //!
  30 //! ```
  31 //! use std::path::Path;
  32 //! use std::ffi::OsStr;
  33 //!
  34 //! let path = Path::new("/tmp/foo/bar.txt");
  35 //!
  36 //! let parent = path.parent();
  37 //! assert_eq!(parent, Some(Path::new("/tmp/foo")));
  38 //!
  39 //! let file_stem = path.file_stem();
  40 //! assert_eq!(file_stem, Some(OsStr::new("bar")));
  41 //!
  42 //! let extension = path.extension();
  43 //! assert_eq!(extension, Some(OsStr::new("txt")));
  44 //! ```
  45 //!
  46 //! To build or modify paths, use [`PathBuf`]:
  47 //!
  48 //! ```
  49 //! use std::path::PathBuf;
  50 //!
  51 //! // This way works...
  52 //! let mut path = PathBuf::from("c:\\");
  53 //!
  54 //! path.push("windows");
  55 //! path.push("system32");
  56 //!
  57 //! path.set_extension("dll");
  58 //!
  59 //! // ... but push is best used if you don't know everything up
  60 //! // front. If you do, this way is better:
  61 //! let path: PathBuf = ["c:\\", "windows", "system32.dll"].iter().collect();
  62 //! ```
  63 //!
  64 //! [`components`]: Path::components
  65 //! [`push`]: PathBuf::push
  66
  67 #![stable(feature = "rust1", since = "1.0.0")]
  68 #![deny(unsafe_op_in_unsafe_fn)]
  69
  70 #[cfg(test)]
  71 mod tests;
  72
  73 use crate::borrow::{Borrow, Cow};
  74 use crate::cmp;
  75 use crate::collections::TryReserveError;
  76 use crate::error::Error;
  77 use crate::fmt;
  78 use crate::fs;
  79 use crate::hash::{Hash, Hasher};
  80 use crate::io;
  81 use crate::iter::{self, FusedIterator};
  82 use crate::ops::{self, Deref};
  83 use crate::rc::Rc;
  84 use crate::str::FromStr;
  85 use crate::sync::Arc;
  86
  87 use crate::ffi::{OsStr, OsString};
  88 use crate::sys;
  89 use crate::sys::path::{is_sep_byte, is_verbatim_sep, parse_prefix, MAIN_SEP_STR};
  90
  91 ////////////////////////////////////////////////////////////////////////////////
  92 // GENERAL NOTES
  93 ////////////////////////////////////////////////////////////////////////////////
  94 //
  95 // Parsing in this module is done by directly transmuting OsStr to [u8] slices,
  96 // taking advantage of the fact that OsStr always encodes ASCII characters
  97 // as-is.  Eventually, this transmutation should be replaced by direct uses of
  98 // OsStr APIs for parsing, but it will take a while for those to become
  99 // available.
 100
 101 ////////////////////////////////////////////////////////////////////////////////
 102 // Windows Prefixes
 103 ////////////////////////////////////////////////////////////////////////////////
 104
 105 /// Windows path prefixes, e.g., `C:` or `\\server\share`.
 106 ///
 107 /// Windows uses a variety of path prefix styles, including references to drive
 108 /// volumes (like `C:`), network shared folders (like `\\server\share`), and
 109 /// others. In addition, some path prefixes are "verbatim" (i.e., prefixed with
 110 /// `\\?\`), in which case `/` is *not* treated as a separator and essentially
 111 /// no normalization is performed.
 112 ///
 113 /// # Examples
 114 ///
 115 /// ```
 116 /// use std::path::{Component, Path, Prefix};
 117 /// use std::path::Prefix::*;
 118 /// use std::ffi::OsStr;
 119 ///
 120 /// fn get_path_prefix(s: &str) -> Prefix {
 121 ///     let path = Path::new(s);
 122 ///     match path.components().next().unwrap() {
 123 ///         Component::Prefix(prefix_component) => prefix_component.kind(),
 124 ///         _ => panic!(),
 125 ///     }
 126 /// }
 127 ///
 128 /// # if cfg!(windows) {
 129 /// assert_eq!(Verbatim(OsStr::new("pictures")),
 130 ///            get_path_prefix(r"\\?\pictures\kittens"));
 131 /// assert_eq!(VerbatimUNC(OsStr::new("server"), OsStr::new("share")),
 132 ///            get_path_prefix(r"\\?\UNC\server\share"));
 133 /// assert_eq!(VerbatimDisk(b'C'), get_path_prefix(r"\\?\c:\"));
 134 /// assert_eq!(DeviceNS(OsStr::new("BrainInterface")),
 135 ///            get_path_prefix(r"\\.\BrainInterface"));
 136 /// assert_eq!(UNC(OsStr::new("server"), OsStr::new("share")),
 137 ///            get_path_prefix(r"\\server\share"));
 138 /// assert_eq!(Disk(b'C'), get_path_prefix(r"C:\Users\Rust\Pictures\Ferris"));
 139 /// # }
 140 /// ```
 141 #[derive(Copy, Clone, Debug, Hash, PartialOrd, Ord, PartialEq, Eq)]
 142 #[stable(feature = "rust1", since = "1.0.0")]
 143 pub enum Prefix<'a> {
 144     /// Verbatim prefix, e.g., `\\?\cat_pics`.
 145     ///
 146     /// Verbatim prefixes consist of `\\?\` immediately followed by the given
 147     /// component.
 148     #[stable(feature = "rust1", since = "1.0.0")]
 149     Verbatim(#[stable(feature = "rust1", since = "1.0.0")] &'a OsStr),
 150
 151     /// Verbatim prefix using Windows' _**U**niform **N**aming **C**onvention_,
 152     /// e.g., `\\?\UNC\server\share`.
 153     ///
 154     /// Verbatim UNC prefixes consist of `\\?\UNC\` immediately followed by the
 155     /// server's hostname and a share name.
 156     #[stable(feature = "rust1", since = "1.0.0")]
 157     VerbatimUNC(
 158         #[stable(feature = "rust1", since = "1.0.0")] &'a OsStr,
 159         #[stable(feature = "rust1", since = "1.0.0")] &'a OsStr,
 160     ),
 161
 162     /// Verbatim disk prefix, e.g., `\\?\C:`.
 163     ///
 164     /// Verbatim disk prefixes consist of `\\?\` immediately followed by the
 165     /// drive letter and `:`.
 166     #[stable(feature = "rust1", since = "1.0.0")]
 167     VerbatimDisk(#[stable(feature = "rust1", since = "1.0.0")] u8),
 168
 169     /// Device namespace prefix, e.g., `\\.\COM42`.
 170     ///
 171     /// Device namespace prefixes consist of `\\.\` (possibly using `/`
 172     /// instead of `\`), immediately followed by the device name.
 173     #[stable(feature = "rust1", since = "1.0.0")]
 174     DeviceNS(#[stable(feature = "rust1", since = "1.0.0")] &'a OsStr),
 175
 176     /// Prefix using Windows' _**U**niform **N**aming **C**onvention_, e.g.
 177     /// `\\server\share`.
 178     ///
 179     /// UNC prefixes consist of the server's hostname and a share name.
 180     #[stable(feature = "rust1", since = "1.0.0")]
 181     UNC(
 182         #[stable(feature = "rust1", since = "1.0.0")] &'a OsStr,
 183         #[stable(feature = "rust1", since = "1.0.0")] &'a OsStr,
 184     ),
 185
 186     /// Prefix `C:` for the given disk drive.
 187     #[stable(feature = "rust1", since = "1.0.0")]
 188     Disk(#[stable(feature = "rust1", since = "1.0.0")] u8),
 189 }
 190
 191 impl<'a> Prefix<'a> {
 192     #[inline]
 193     fn len(&self) -> usize {
 194         use self::Prefix::*;
 195         fn os_str_len(s: &OsStr) -> usize {
 196             s.bytes().len()
 197         }
 198         match *self {
 199             Verbatim(x) => 4 + os_str_len(x),
 200             VerbatimUNC(x, y) => {
 201                 8 + os_str_len(x) + if os_str_len(y) > 0 { 1 + os_str_len(y) } else { 0 }
 202             }
 203             VerbatimDisk(_) => 6,
 204             UNC(x, y) => 2 + os_str_len(x) + if os_str_len(y) > 0 { 1 + os_str_len(y) } else { 0 },
 205             DeviceNS(x) => 4 + os_str_len(x),
 206             Disk(_) => 2,
 207         }
 208     }
 209
 210     /// Determines if the prefix is verbatim, i.e., begins with `\\?\`.
 211     ///
 212     /// # Examples
 213     ///
 214     /// ```
 215     /// use std::path::Prefix::*;
 216     /// use std::ffi::OsStr;
 217     ///
 218     /// assert!(Verbatim(OsStr::new("pictures")).is_verbatim());
 219     /// assert!(VerbatimUNC(OsStr::new("server"), OsStr::new("share")).is_verbatim());
 220     /// assert!(VerbatimDisk(b'C').is_verbatim());
 221     /// assert!(!DeviceNS(OsStr::new("BrainInterface")).is_verbatim());
 222     /// assert!(!UNC(OsStr::new("server"), OsStr::new("share")).is_verbatim());
 223     /// assert!(!Disk(b'C').is_verbatim());
 224     /// ```
 225     #[inline]
 226     #[must_use]
 227     #[stable(feature = "rust1", since = "1.0.0")]
 228     pub fn is_verbatim(&self) -> bool {
 229         use self::Prefix::*;
 230         matches!(*self, Verbatim(_) | VerbatimDisk(_) | VerbatimUNC(..))
 231     }
 232
 233     #[inline]
 234     fn is_drive(&self) -> bool {
 235         matches!(*self, Prefix::Disk(_))
 236     }
 237
 238     #[inline]
 239     fn has_implicit_root(&self) -> bool {
 240         !self.is_drive()
 241     }
 242 }
 243
 244 ////////////////////////////////////////////////////////////////////////////////
 245 // Exposed parsing helpers
 246 ////////////////////////////////////////////////////////////////////////////////
 247
 248 /// Determines whether the character is one of the permitted path
 249 /// separators for the current platform.
 250 ///
 251 /// # Examples
 252 ///
 253 /// ```
 254 /// use std::path;
 255 ///
 256 /// assert!(path::is_separator('/')); // '/' works for both Unix and Windows
 257 /// assert!(!path::is_separator('❤'));
 258 /// ```
 259 #[must_use]
 260 #[stable(feature = "rust1", since = "1.0.0")]
 261 pub fn is_separator(c: char) -> bool {
 262     c.is_ascii() && is_sep_byte(c as u8)
 263 }
 264
 265 /// The primary separator of path components for the current platform.
 266 ///
 267 /// For example, `/` on Unix and `\` on Windows.
 268 #[stable(feature = "rust1", since = "1.0.0")]
 269 pub const MAIN_SEPARATOR: char = crate::sys::path::MAIN_SEP;
 270
 271 /// The primary separator of path components for the current platform.
 272 ///
 273 /// For example, `/` on Unix and `\` on Windows.
 274 #[unstable(feature = "main_separator_str", issue = "94071")]
 275 pub const MAIN_SEPARATOR_STR: &str = crate::sys::path::MAIN_SEP_STR;
 276
 277 ////////////////////////////////////////////////////////////////////////////////
 278 // Misc helpers
 279 ////////////////////////////////////////////////////////////////////////////////
 280
 281 // Iterate through `iter` while it matches `prefix`; return `None` if `prefix`
 282 // is not a prefix of `iter`, otherwise return `Some(iter_after_prefix)` giving
 283 // `iter` after having exhausted `prefix`.
 284 fn iter_after<'a, 'b, I, J>(mut iter: I, mut prefix: J) -> Option<I>
 285 where
 286     I: Iterator<Item = Component<'a>> + Clone,
 287     J: Iterator<Item = Component<'b>>,
 288 {
 289     loop {
 290         let mut iter_next = iter.clone();
 291         match (iter_next.next(), prefix.next()) {
 292             (Some(ref x), Some(ref y)) if x == y => (),
 293             (Some(_), Some(_)) => return None,
 294             (Some(_), None) => return Some(iter),
 295             (None, None) => return Some(iter),
 296             (None, Some(_)) => return None,
 297         }
 298         iter = iter_next;
 299     }
 300 }
 301
 302 unsafe fn u8_slice_as_os_str(s: &[u8]) -> &OsStr {
 303     // SAFETY: See note at the top of this module to understand why this and
 304     // `OsStr::bytes` are used:
 305     //
 306     // This casts are safe as OsStr is internally a wrapper around [u8] on all
 307     // platforms.
 308     //
 309     // Note that currently this relies on the special knowledge that libstd has;
 310     // these types are single-element structs but are not marked
 311     // repr(transparent) or repr(C) which would make these casts not allowable
 312     // outside std.
 313     unsafe { &*(s as *const [u8] as *const OsStr) }
 314 }
 315
 316 // Detect scheme on Redox
 317 fn has_redox_scheme(s: &[u8]) -> bool {
 318     cfg!(target_os = "redox") && s.contains(&b':')
 319 }
 320
 321 ////////////////////////////////////////////////////////////////////////////////
 322 // Cross-platform, iterator-independent parsing
 323 ////////////////////////////////////////////////////////////////////////////////
 324
 325 /// Says whether the first byte after the prefix is a separator.
 326 fn has_physical_root(s: &[u8], prefix: Option<Prefix<'_>>) -> bool {
 327     let path = if let Some(p) = prefix { &s[p.len()..] } else { s };
 328     !path.is_empty() && is_sep_byte(path[0])
 329 }
 330
 331 // basic workhorse for splitting stem and extension
 332 fn rsplit_file_at_dot(file: &OsStr) -> (Option<&OsStr>, Option<&OsStr>) {
 333     if file.bytes() == b".." {
 334         return (Some(file), None);
 335     }
 336
 337     // The unsafety here stems from converting between &OsStr and &[u8]
 338     // and back. This is safe to do because (1) we only look at ASCII
 339     // contents of the encoding and (2) new &OsStr values are produced
 340     // only from ASCII-bounded slices of existing &OsStr values.
 341     let mut iter = file.bytes().rsplitn(2, |b| *b == b'.');
 342     let after = iter.next();
 343     let before = iter.next();
 344     if before == Some(b"") {
 345         (Some(file), None)
 346     } else {
 347         unsafe { (before.map(|s| u8_slice_as_os_str(s)), after.map(|s| u8_slice_as_os_str(s))) }
 348     }
 349 }
 350
 351 fn split_file_at_dot(file: &OsStr) -> (&OsStr, Option<&OsStr>) {
 352     let slice = file.bytes();
 353     if slice == b".." {
 354         return (file, None);
 355     }
 356
 357     // The unsafety here stems from converting between &OsStr and &[u8]
 358     // and back. This is safe to do because (1) we only look at ASCII
 359     // contents of the encoding and (2) new &OsStr values are produced
 360     // only from ASCII-bounded slices of existing &OsStr values.
 361     let i = match slice[1..].iter().position(|b| *b == b'.') {
 362         Some(i) => i + 1,
 363         None => return (file, None),
 364     };
 365     let before = &slice[..i];
 366     let after = &slice[i + 1..];
 367     unsafe { (u8_slice_as_os_str(before), Some(u8_slice_as_os_str(after))) }
 368 }
 369
 370 ////////////////////////////////////////////////////////////////////////////////
 371 // The core iterators
 372 ////////////////////////////////////////////////////////////////////////////////
 373
 374 /// Component parsing works by a double-ended state machine; the cursors at the
 375 /// front and back of the path each keep track of what parts of the path have
 376 /// been consumed so far.
 377 ///
 378 /// Going front to back, a path is made up of a prefix, a starting
 379 /// directory component, and a body (of normal components)
 380 #[derive(Copy, Clone, PartialEq, PartialOrd, Debug)]
 381 enum State {
 382     Prefix = 0,   // c:
 383     StartDir = 1, // / or . or nothing
 384     Body = 2,     // foo/bar/baz
 385     Done = 3,
 386 }
 387
 388 /// A structure wrapping a Windows path prefix as well as its unparsed string
 389 /// representation.
 390 ///
 391 /// In addition to the parsed [`Prefix`] information returned by [`kind`],
 392 /// `PrefixComponent` also holds the raw and unparsed [`OsStr`] slice,
 393 /// returned by [`as_os_str`].
 394 ///
 395 /// Instances of this `struct` can be obtained by matching against the
 396 /// [`Prefix` variant] on [`Component`].
 397 ///
 398 /// Does not occur on Unix.
 399 ///
 400 /// # Examples
 401 ///
 402 /// ```
 403 /// # if cfg!(windows) {
 404 /// use std::path::{Component, Path, Prefix};
 405 /// use std::ffi::OsStr;
 406 ///
 407 /// let path = Path::new(r"c:\you\later\");
 408 /// match path.components().next().unwrap() {
 409 ///     Component::Prefix(prefix_component) => {
 410 ///         assert_eq!(Prefix::Disk(b'C'), prefix_component.kind());
 411 ///         assert_eq!(OsStr::new("c:"), prefix_component.as_os_str());
 412 ///     }
 413 ///     _ => unreachable!(),
 414 /// }
 415 /// # }
 416 /// ```
 417 ///
 418 /// [`as_os_str`]: PrefixComponent::as_os_str
 419 /// [`kind`]: PrefixComponent::kind
 420 /// [`Prefix` variant]: Component::Prefix
 421 #[stable(feature = "rust1", since = "1.0.0")]
 422 #[derive(Copy, Clone, Eq, Debug)]
 423 pub struct PrefixComponent<'a> {
 424     /// The prefix as an unparsed `OsStr` slice.
 425     raw: &'a OsStr,
 426
 427     /// The parsed prefix data.
 428     parsed: Prefix<'a>,
 429 }
 430
 431 impl<'a> PrefixComponent<'a> {
 432     /// Returns the parsed prefix data.
 433     ///
 434     /// See [`Prefix`]'s documentation for more information on the different
 435     /// kinds of prefixes.
 436     #[stable(feature = "rust1", since = "1.0.0")]
 437     #[must_use]
 438     #[inline]
 439     pub fn kind(&self) -> Prefix<'a> {
 440         self.parsed
 441     }
 442
 443     /// Returns the raw [`OsStr`] slice for this prefix.
 444     #[stable(feature = "rust1", since = "1.0.0")]
 445     #[must_use]
 446     #[inline]
 447     pub fn as_os_str(&self) -> &'a OsStr {
 448         self.raw
 449     }
 450 }
 451
 452 #[stable(feature = "rust1", since = "1.0.0")]
 453 impl<'a> cmp::PartialEq for PrefixComponent<'a> {
 454     #[inline]
 455     fn eq(&self, other: &PrefixComponent<'a>) -> bool {
 456         cmp::PartialEq::eq(&self.parsed, &other.parsed)
 457     }
 458 }
 459
 460 #[stable(feature = "rust1", since = "1.0.0")]
 461 impl<'a> cmp::PartialOrd for PrefixComponent<'a> {
 462     #[inline]
 463     fn partial_cmp(&self, other: &PrefixComponent<'a>) -> Option<cmp::Ordering> {
 464         cmp::PartialOrd::partial_cmp(&self.parsed, &other.parsed)
 465     }
 466 }
 467
 468 #[stable(feature = "rust1", since = "1.0.0")]
 469 impl cmp::Ord for PrefixComponent<'_> {
 470     #[inline]
 471     fn cmp(&self, other: &Self) -> cmp::Ordering {
 472         cmp::Ord::cmp(&self.parsed, &other.parsed)
 473     }
 474 }
 475
 476 #[stable(feature = "rust1", since = "1.0.0")]
 477 impl Hash for PrefixComponent<'_> {
 478     fn hash<H: Hasher>(&self, h: &mut H) {
 479         self.parsed.hash(h);
 480     }
 481 }
 482
 483 /// A single component of a path.
 484 ///
 485 /// A `Component` roughly corresponds to a substring between path separators
 486 /// (`/` or `\`).
 487 ///
 488 /// This `enum` is created by iterating over [`Components`], which in turn is
 489 /// created by the [`components`](Path::components) method on [`Path`].
 490 ///
 491 /// # Examples
 492 ///
 493 /// ```rust
 494 /// use std::path::{Component, Path};
 495 ///
 496 /// let path = Path::new("/tmp/foo/bar.txt");
 497 /// let components = path.components().collect::<Vec<_>>();
 498 /// assert_eq!(&components, &[
 499 ///     Component::RootDir,
 500 ///     Component::Normal("tmp".as_ref()),
 501 ///     Component::Normal("foo".as_ref()),
 502 ///     Component::Normal("bar.txt".as_ref()),
 503 /// ]);
 504 /// ```
 505 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
 506 #[stable(feature = "rust1", since = "1.0.0")]
 507 pub enum Component<'a> {
 508     /// A Windows path prefix, e.g., `C:` or `\\server\share`.
 509     ///
 510     /// There is a large variety of prefix types, see [`Prefix`]'s documentation
 511     /// for more.
 512     ///
 513     /// Does not occur on Unix.
 514     #[stable(feature = "rust1", since = "1.0.0")]
 515     Prefix(#[stable(feature = "rust1", since = "1.0.0")] PrefixComponent<'a>),
 516
 517     /// The root directory component, appears after any prefix and before anything else.
 518     ///
 519     /// It represents a separator that designates that a path starts from root.
 520     #[stable(feature = "rust1", since = "1.0.0")]
 521     RootDir,
 522
 523     /// A reference to the current directory, i.e., `.`.
 524     #[stable(feature = "rust1", since = "1.0.0")]
 525     CurDir,
 526
 527     /// A reference to the parent directory, i.e., `..`.
 528     #[stable(feature = "rust1", since = "1.0.0")]
 529     ParentDir,
 530
 531     /// A normal component, e.g., `a` and `b` in `a/b`.
 532     ///
 533     /// This variant is the most common one, it represents references to files
 534     /// or directories.
 535     #[stable(feature = "rust1", since = "1.0.0")]
 536     Normal(#[stable(feature = "rust1", since = "1.0.0")] &'a OsStr),
 537 }
 538
 539 impl<'a> Component<'a> {
 540     /// Extracts the underlying [`OsStr`] slice.
 541     ///
 542     /// # Examples
 543     ///
 544     /// ```
 545     /// use std::path::Path;
 546     ///
 547     /// let path = Path::new("./tmp/foo/bar.txt");
 548     /// let components: Vec<_> = path.components().map(|comp| comp.as_os_str()).collect();
 549     /// assert_eq!(&components, &[".", "tmp", "foo", "bar.txt"]);
 550     /// ```
 551     #[must_use = "`self` will be dropped if the result is not used"]
 552     #[stable(feature = "rust1", since = "1.0.0")]
 553     pub fn as_os_str(self) -> &'a OsStr {
 554         match self {
 555             Component::Prefix(p) => p.as_os_str(),
 556             Component::RootDir => OsStr::new(MAIN_SEP_STR),
 557             Component::CurDir => OsStr::new("."),
 558             Component::ParentDir => OsStr::new(".."),
 559             Component::Normal(path) => path,
 560         }
 561     }
 562 }
 563
 564 #[stable(feature = "rust1", since = "1.0.0")]
 565 impl AsRef<OsStr> for Component<'_> {
 566     #[inline]
 567     fn as_ref(&self) -> &OsStr {
 568         self.as_os_str()
 569     }
 570 }
 571
 572 #[stable(feature = "path_component_asref", since = "1.25.0")]
 573 impl AsRef<Path> for Component<'_> {
 574     #[inline]
 575     fn as_ref(&self) -> &Path {
 576         self.as_os_str().as_ref()
 577     }
 578 }
 579
 580 /// An iterator over the [`Component`]s of a [`Path`].
 581 ///
 582 /// This `struct` is created by the [`components`] method on [`Path`].
 583 /// See its documentation for more.
 584 ///
 585 /// # Examples
 586 ///
 587 /// ```
 588 /// use std::path::Path;
 589 ///
 590 /// let path = Path::new("/tmp/foo/bar.txt");
 591 ///
 592 /// for component in path.components() {
 593 ///     println!("{component:?}");
 594 /// }
 595 /// ```
 596 ///
 597 /// [`components`]: Path::components
 598 #[derive(Clone)]
 599 #[must_use = "iterators are lazy and do nothing unless consumed"]
 600 #[stable(feature = "rust1", since = "1.0.0")]
 601 pub struct Components<'a> {
 602     // The path left to parse components from
 603     path: &'a [u8],
 604
 605     // The prefix as it was originally parsed, if any
 606     prefix: Option<Prefix<'a>>,
 607
 608     // true if path *physically* has a root separator; for most Windows
 609     // prefixes, it may have a "logical" root separator for the purposes of
 610     // normalization, e.g.,  \\server\share == \\server\share\.
 611     has_physical_root: bool,
 612
 613     // The iterator is double-ended, and these two states keep track of what has
 614     // been produced from either end
 615     front: State,
 616     back: State,
 617 }
 618
 619 /// An iterator over the [`Component`]s of a [`Path`], as [`OsStr`] slices.
 620 ///
 621 /// This `struct` is created by the [`iter`] method on [`Path`].
 622 /// See its documentation for more.
 623 ///
 624 /// [`iter`]: Path::iter
 625 #[derive(Clone)]
 626 #[must_use = "iterators are lazy and do nothing unless consumed"]
 627 #[stable(feature = "rust1", since = "1.0.0")]
 628 pub struct Iter<'a> {
 629     inner: Components<'a>,
 630 }
 631
 632 #[stable(feature = "path_components_debug", since = "1.13.0")]
 633 impl fmt::Debug for Components<'_> {
 634     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 635         struct DebugHelper<'a>(&'a Path);
 636
 637         impl fmt::Debug for DebugHelper<'_> {
 638             fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 639                 f.debug_list().entries(self.0.components()).finish()
 640             }
 641         }
 642
 643         f.debug_tuple("Components").field(&DebugHelper(self.as_path())).finish()
 644     }
 645 }
 646
 647 impl<'a> Components<'a> {
 648     // how long is the prefix, if any?
 649     #[inline]
 650     fn prefix_len(&self) -> usize {
 651         self.prefix.as_ref().map(Prefix::len).unwrap_or(0)
 652     }
 653
 654     #[inline]
 655     fn prefix_verbatim(&self) -> bool {
 656         self.prefix.as_ref().map(Prefix::is_verbatim).unwrap_or(false)
 657     }
 658
 659     /// how much of the prefix is left from the point of view of iteration?
 660     #[inline]
 661     fn prefix_remaining(&self) -> usize {
 662         if self.front == State::Prefix { self.prefix_len() } else { 0 }
 663     }
 664
 665     // Given the iteration so far, how much of the pre-State::Body path is left?
 666     #[inline]
 667     fn len_before_body(&self) -> usize {
 668         let root = if self.front <= State::StartDir && self.has_physical_root { 1 } else { 0 };
 669         let cur_dir = if self.front <= State::StartDir && self.include_cur_dir() { 1 } else { 0 };
 670         self.prefix_remaining() + root + cur_dir
 671     }
 672
 673     // is the iteration complete?
 674     #[inline]
 675     fn finished(&self) -> bool {
 676         self.front == State::Done || self.back == State::Done || self.front > self.back
 677     }
 678
 679     #[inline]
 680     fn is_sep_byte(&self, b: u8) -> bool {
 681         if self.prefix_verbatim() { is_verbatim_sep(b) } else { is_sep_byte(b) }
 682     }
 683
 684     /// Extracts a slice corresponding to the portion of the path remaining for iteration.
 685     ///
 686     /// # Examples
 687     ///
 688     /// ```
 689     /// use std::path::Path;
 690     ///
 691     /// let mut components = Path::new("/tmp/foo/bar.txt").components();
 692     /// components.next();
 693     /// components.next();
 694     ///
 695     /// assert_eq!(Path::new("foo/bar.txt"), components.as_path());
 696     /// ```
 697     #[must_use]
 698     #[stable(feature = "rust1", since = "1.0.0")]
 699     pub fn as_path(&self) -> &'a Path {
 700         let mut comps = self.clone();
 701         if comps.front == State::Body {
 702             comps.trim_left();
 703         }
 704         if comps.back == State::Body {
 705             comps.trim_right();
 706         }
 707         unsafe { Path::from_u8_slice(comps.path) }
 708     }
 709
 710     /// Is the *original* path rooted?
 711     fn has_root(&self) -> bool {
 712         if self.has_physical_root {
 713             return true;
 714         }
 715         if let Some(p) = self.prefix {
 716             if p.has_implicit_root() {
 717                 return true;
 718             }
 719         }
 720         false
 721     }
 722
 723     /// Should the normalized path include a leading . ?
 724     fn include_cur_dir(&self) -> bool {
 725         if self.has_root() {
 726             return false;
 727         }
 728         let mut iter = self.path[self.prefix_remaining()..].iter();
 729         match (iter.next(), iter.next()) {
 730             (Some(&b'.'), None) => true,
 731             (Some(&b'.'), Some(&b)) => self.is_sep_byte(b),
 732             _ => false,
 733         }
 734     }
 735
 736     // parse a given byte sequence into the corresponding path component
 737     fn parse_single_component<'b>(&self, comp: &'b [u8]) -> Option<Component<'b>> {
 738         match comp {
 739             b"." if self.prefix_verbatim() => Some(Component::CurDir),
 740             b"." => None, // . components are normalized away, except at
 741             // the beginning of a path, which is treated
 742             // separately via `include_cur_dir`
 743             b".." => Some(Component::ParentDir),
 744             b"" => None,
 745             _ => Some(Component::Normal(unsafe { u8_slice_as_os_str(comp) })),
 746         }
 747     }
 748
 749     // parse a component from the left, saying how many bytes to consume to
 750     // remove the component
 751     fn parse_next_component(&self) -> (usize, Option<Component<'a>>) {
 752         debug_assert!(self.front == State::Body);
 753         let (extra, comp) = match self.path.iter().position(|b| self.is_sep_byte(*b)) {
 754             None => (0, self.path),
 755             Some(i) => (1, &self.path[..i]),
 756         };
 757         (comp.len() + extra, self.parse_single_component(comp))
 758     }
 759
 760     // parse a component from the right, saying how many bytes to consume to
 761     // remove the component
 762     fn parse_next_component_back(&self) -> (usize, Option<Component<'a>>) {
 763         debug_assert!(self.back == State::Body);
 764         let start = self.len_before_body();
 765         let (extra, comp) = match self.path[start..].iter().rposition(|b| self.is_sep_byte(*b)) {
 766             None => (0, &self.path[start..]),
 767             Some(i) => (1, &self.path[start + i + 1..]),
 768         };
 769         (comp.len() + extra, self.parse_single_component(comp))
 770     }
 771
 772     // trim away repeated separators (i.e., empty components) on the left
 773     fn trim_left(&mut self) {
 774         while !self.path.is_empty() {
 775             let (size, comp) = self.parse_next_component();
 776             if comp.is_some() {
 777                 return;
 778             } else {
 779                 self.path = &self.path[size..];
 780             }
 781         }
 782     }
 783
 784     // trim away repeated separators (i.e., empty components) on the right
 785     fn trim_right(&mut self) {
 786         while self.path.len() > self.len_before_body() {
 787             let (size, comp) = self.parse_next_component_back();
 788             if comp.is_some() {
 789                 return;
 790             } else {
 791                 self.path = &self.path[..self.path.len() - size];
 792             }
 793         }
 794     }
 795 }
 796
 797 #[stable(feature = "rust1", since = "1.0.0")]
 798 impl AsRef<Path> for Components<'_> {
 799     #[inline]
 800     fn as_ref(&self) -> &Path {
 801         self.as_path()
 802     }
 803 }
 804
 805 #[stable(feature = "rust1", since = "1.0.0")]
 806 impl AsRef<OsStr> for Components<'_> {
 807     #[inline]
 808     fn as_ref(&self) -> &OsStr {
 809         self.as_path().as_os_str()
 810     }
 811 }
 812
 813 #[stable(feature = "path_iter_debug", since = "1.13.0")]
 814 impl fmt::Debug for Iter<'_> {
 815     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 816         struct DebugHelper<'a>(&'a Path);
 817
 818         impl fmt::Debug for DebugHelper<'_> {
 819             fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 820                 f.debug_list().entries(self.0.iter()).finish()
 821             }
 822         }
 823
 824         f.debug_tuple("Iter").field(&DebugHelper(self.as_path())).finish()
 825     }
 826 }
 827
 828 impl<'a> Iter<'a> {
 829     /// Extracts a slice corresponding to the portion of the path remaining for iteration.
 830     ///
 831     /// # Examples
 832     ///
 833     /// ```
 834     /// use std::path::Path;
 835     ///
 836     /// let mut iter = Path::new("/tmp/foo/bar.txt").iter();
 837     /// iter.next();
 838     /// iter.next();
 839     ///
 840     /// assert_eq!(Path::new("foo/bar.txt"), iter.as_path());
 841     /// ```
 842     #[stable(feature = "rust1", since = "1.0.0")]
 843     #[must_use]
 844     #[inline]
 845     pub fn as_path(&self) -> &'a Path {
 846         self.inner.as_path()
 847     }
 848 }
 849
 850 #[stable(feature = "rust1", since = "1.0.0")]
 851 impl AsRef<Path> for Iter<'_> {
 852     #[inline]
 853     fn as_ref(&self) -> &Path {
 854         self.as_path()
 855     }
 856 }
 857
 858 #[stable(feature = "rust1", since = "1.0.0")]
 859 impl AsRef<OsStr> for Iter<'_> {
 860     #[inline]
 861     fn as_ref(&self) -> &OsStr {
 862         self.as_path().as_os_str()
 863     }
 864 }
 865
 866 #[stable(feature = "rust1", since = "1.0.0")]
 867 impl<'a> Iterator for Iter<'a> {
 868     type Item = &'a OsStr;
 869
 870     #[inline]
 871     fn next(&mut self) -> Option<&'a OsStr> {
 872         self.inner.next().map(Component::as_os_str)
 873     }
 874 }
 875
 876 #[stable(feature = "rust1", since = "1.0.0")]
 877 impl<'a> DoubleEndedIterator for Iter<'a> {
 878     #[inline]
 879     fn next_back(&mut self) -> Option<&'a OsStr> {
 880         self.inner.next_back().map(Component::as_os_str)
 881     }
 882 }
 883
 884 #[stable(feature = "fused", since = "1.26.0")]
 885 impl FusedIterator for Iter<'_> {}
 886
 887 #[stable(feature = "rust1", since = "1.0.0")]
 888 impl<'a> Iterator for Components<'a> {
 889     type Item = Component<'a>;
 890
 891     fn next(&mut self) -> Option<Component<'a>> {
 892         while !self.finished() {
 893             match self.front {
 894                 State::Prefix if self.prefix_len() > 0 => {
 895                     self.front = State::StartDir;
 896                     debug_assert!(self.prefix_len() <= self.path.len());
 897                     let raw = &self.path[..self.prefix_len()];
 898                     self.path = &self.path[self.prefix_len()..];
 899                     return Some(Component::Prefix(PrefixComponent {
 900                         raw: unsafe { u8_slice_as_os_str(raw) },
 901                         parsed: self.prefix.unwrap(),
 902                     }));
 903                 }
 904                 State::Prefix => {
 905                     self.front = State::StartDir;
 906                 }
 907                 State::StartDir => {
 908                     self.front = State::Body;
 909                     if self.has_physical_root {
 910                         debug_assert!(!self.path.is_empty());
 911                         self.path = &self.path[1..];
 912                         return Some(Component::RootDir);
 913                     } else if let Some(p) = self.prefix {
 914                         if p.has_implicit_root() && !p.is_verbatim() {
 915                             return Some(Component::RootDir);
 916                         }
 917                     } else if self.include_cur_dir() {
 918                         debug_assert!(!self.path.is_empty());
 919                         self.path = &self.path[1..];
 920                         return Some(Component::CurDir);
 921                     }
 922                 }
 923                 State::Body if !self.path.is_empty() => {
 924                     let (size, comp) = self.parse_next_component();
 925                     self.path = &self.path[size..];
 926                     if comp.is_some() {
 927                         return comp;
 928                     }
 929                 }
 930                 State::Body => {
 931                     self.front = State::Done;
 932                 }
 933                 State::Done => unreachable!(),
 934             }
 935         }
 936         None
 937     }
 938 }
 939
 940 #[stable(feature = "rust1", since = "1.0.0")]
 941 impl<'a> DoubleEndedIterator for Components<'a> {
 942     fn next_back(&mut self) -> Option<Component<'a>> {
 943         while !self.finished() {
 944             match self.back {
 945                 State::Body if self.path.len() > self.len_before_body() => {
 946                     let (size, comp) = self.parse_next_component_back();
 947                     self.path = &self.path[..self.path.len() - size];
 948                     if comp.is_some() {
 949                         return comp;
 950                     }
 951                 }
 952                 State::Body => {
 953                     self.back = State::StartDir;
 954                 }
 955                 State::StartDir => {
 956                     self.back = State::Prefix;
 957                     if self.has_physical_root {
 958                         self.path = &self.path[..self.path.len() - 1];
 959                         return Some(Component::RootDir);
 960                     } else if let Some(p) = self.prefix {
 961                         if p.has_implicit_root() && !p.is_verbatim() {
 962                             return Some(Component::RootDir);
 963                         }
 964                     } else if self.include_cur_dir() {
 965                         self.path = &self.path[..self.path.len() - 1];
 966                         return Some(Component::CurDir);
 967                     }
 968                 }
 969                 State::Prefix if self.prefix_len() > 0 => {
 970                     self.back = State::Done;
 971                     return Some(Component::Prefix(PrefixComponent {
 972                         raw: unsafe { u8_slice_as_os_str(self.path) },
 973                         parsed: self.prefix.unwrap(),
 974                     }));
 975                 }
 976                 State::Prefix => {
 977                     self.back = State::Done;
 978                     return None;
 979                 }
 980                 State::Done => unreachable!(),
 981             }
 982         }
 983         None
 984     }
 985 }
 986
 987 #[stable(feature = "fused", since = "1.26.0")]
 988 impl FusedIterator for Components<'_> {}
 989
 990 #[stable(feature = "rust1", since = "1.0.0")]
 991 impl<'a> cmp::PartialEq for Components<'a> {
 992     #[inline]
 993     fn eq(&self, other: &Components<'a>) -> bool {
 994         let Components { path: _, front: _, back: _, has_physical_root: _, prefix: _ } = self;
 995
 996         // Fast path for exact matches, e.g. for hashmap lookups.
 997         // Don't explicitly compare the prefix or has_physical_root fields since they'll
 998         // either be covered by the `path` buffer or are only relevant for `prefix_verbatim()`.
 999         if self.path.len() == other.path.len()
1000             && self.front == other.front
1001             && self.back == State::Body
1002             && other.back == State::Body
1003             && self.prefix_verbatim() == other.prefix_verbatim()
1004         {
1005             // possible future improvement: this could bail out earlier if there were a
1006             // reverse memcmp/bcmp comparing back to front
1007             if self.path == other.path {
1008                 return true;
1009             }
1010         }
1011
1012         // compare back to front since absolute paths often share long prefixes
1013         Iterator::eq(self.clone().rev(), other.clone().rev())
1014     }
1015 }
1016
1017 #[stable(feature = "rust1", since = "1.0.0")]
1018 impl cmp::Eq for Components<'_> {}
1019
1020 #[stable(feature = "rust1", since = "1.0.0")]
1021 impl<'a> cmp::PartialOrd for Components<'a> {
1022     #[inline]
1023     fn partial_cmp(&self, other: &Components<'a>) -> Option<cmp::Ordering> {
1024         Some(compare_components(self.clone(), other.clone()))
1025     }
1026 }
1027
1028 #[stable(feature = "rust1", since = "1.0.0")]
1029 impl cmp::Ord for Components<'_> {
1030     #[inline]
1031     fn cmp(&self, other: &Self) -> cmp::Ordering {
1032         compare_components(self.clone(), other.clone())
1033     }
1034 }
1035
1036 fn compare_components(mut left: Components<'_>, mut right: Components<'_>) -> cmp::Ordering {
1037     // Fast path for long shared prefixes
1038     //
1039     // - compare raw bytes to find first mismatch
1040     // - backtrack to find separator before mismatch to avoid ambiguous parsings of '.' or '..' characters
1041     // - if found update state to only do a component-wise comparison on the remainder,
1042     //   otherwise do it on the full path
1043     //
1044     // The fast path isn't taken for paths with a PrefixComponent to avoid backtracking into
1045     // the middle of one
1046     if left.prefix.is_none() && right.prefix.is_none() && left.front == right.front {
1047         // possible future improvement: a [u8]::first_mismatch simd implementation
1048         let first_difference = match left.path.iter().zip(right.path).position(|(&a, &b)| a != b) {
1049             None if left.path.len() == right.path.len() => return cmp::Ordering::Equal,
1050             None => left.path.len().min(right.path.len()),
1051             Some(diff) => diff,
1052         };
1053
1054         if let Some(previous_sep) =
1055             left.path[..first_difference].iter().rposition(|&b| left.is_sep_byte(b))
1056         {
1057             let mismatched_component_start = previous_sep + 1;
1058             left.path = &left.path[mismatched_component_start..];
1059             left.front = State::Body;
1060             right.path = &right.path[mismatched_component_start..];
1061             right.front = State::Body;
1062         }
1063     }
1064
1065     Iterator::cmp(left, right)
1066 }
1067
1068 /// An iterator over [`Path`] and its ancestors.
1069 ///
1070 /// This `struct` is created by the [`ancestors`] method on [`Path`].
1071 /// See its documentation for more.
1072 ///
1073 /// # Examples
1074 ///
1075 /// ```
1076 /// use std::path::Path;
1077 ///
1078 /// let path = Path::new("/foo/bar");
1079 ///
1080 /// for ancestor in path.ancestors() {
1081 ///     println!("{}", ancestor.display());
1082 /// }
1083 /// ```
1084 ///
1085 /// [`ancestors`]: Path::ancestors
1086 #[derive(Copy, Clone, Debug)]
1087 #[must_use = "iterators are lazy and do nothing unless consumed"]
1088 #[stable(feature = "path_ancestors", since = "1.28.0")]
1089 pub struct Ancestors<'a> {
1090     next: Option<&'a Path>,
1091 }
1092
1093 #[stable(feature = "path_ancestors", since = "1.28.0")]
1094 impl<'a> Iterator for Ancestors<'a> {
1095     type Item = &'a Path;
1096
1097     #[inline]
1098     fn next(&mut self) -> Option<Self::Item> {
1099         let next = self.next;
1100         self.next = next.and_then(Path::parent);
1101         next
1102     }
1103 }
1104
1105 #[stable(feature = "path_ancestors", since = "1.28.0")]
1106 impl FusedIterator for Ancestors<'_> {}
1107
1108 ////////////////////////////////////////////////////////////////////////////////
1109 // Basic types and traits
1110 ////////////////////////////////////////////////////////////////////////////////
1111
1112 /// An owned, mutable path (akin to [`String`]).
1113 ///
1114 /// This type provides methods like [`push`] and [`set_extension`] that mutate
1115 /// the path in place. It also implements [`Deref`] to [`Path`], meaning that
1116 /// all methods on [`Path`] slices are available on `PathBuf` values as well.
1117 ///
1118 /// [`push`]: PathBuf::push
1119 /// [`set_extension`]: PathBuf::set_extension
1120 ///
1121 /// More details about the overall approach can be found in
1122 /// the [module documentation](self).
1123 ///
1124 /// # Examples
1125 ///
1126 /// You can use [`push`] to build up a `PathBuf` from
1127 /// components:
1128 ///
1129 /// ```
1130 /// use std::path::PathBuf;
1131 ///
1132 /// let mut path = PathBuf::new();
1133 ///
1134 /// path.push(r"C:\");
1135 /// path.push("windows");
1136 /// path.push("system32");
1137 ///
1138 /// path.set_extension("dll");
1139 /// ```
1140 ///
1141 /// However, [`push`] is best used for dynamic situations. This is a better way
1142 /// to do this when you know all of the components ahead of time:
1143 ///
1144 /// ```
1145 /// use std::path::PathBuf;
1146 ///
1147 /// let path: PathBuf = [r"C:\", "windows", "system32.dll"].iter().collect();
1148 /// ```
1149 ///
1150 /// We can still do better than this! Since these are all strings, we can use
1151 /// `From::from`:
1152 ///
1153 /// ```
1154 /// use std::path::PathBuf;
1155 ///
1156 /// let path = PathBuf::from(r"C:\windows\system32.dll");
1157 /// ```
1158 ///
1159 /// Which method works best depends on what kind of situation you're in.
1160 #[cfg_attr(not(test), rustc_diagnostic_item = "PathBuf")]
1161 #[stable(feature = "rust1", since = "1.0.0")]
1162 // FIXME:
1163 // `PathBuf::as_mut_vec` current implementation relies
1164 // on `PathBuf` being layout-compatible with `Vec<u8>`.
1165 // When attribute privacy is implemented, `PathBuf` should be annotated as `#[repr(transparent)]`.
1166 // Anyway, `PathBuf` representation and layout are considered implementation detail, are
1167 // not documented and must not be relied upon.
1168 pub struct PathBuf {
1169     inner: OsString,
1170 }
1171
1172 impl PathBuf {
1173     #[inline]
1174     fn as_mut_vec(&mut self) -> &mut Vec<u8> {
1175         unsafe { &mut *(self as *mut PathBuf as *mut Vec<u8>) }
1176     }
1177
1178     /// Allocates an empty `PathBuf`.
1179     ///
1180     /// # Examples
1181     ///
1182     /// ```
1183     /// use std::path::PathBuf;
1184     ///
1185     /// let path = PathBuf::new();
1186     /// ```
1187     #[stable(feature = "rust1", since = "1.0.0")]
1188     #[must_use]
1189     #[inline]
1190     pub fn new() -> PathBuf {
1191         PathBuf { inner: OsString::new() }
1192     }
1193
1194     /// Creates a new `PathBuf` with a given capacity used to create the
1195     /// internal [`OsString`]. See [`with_capacity`] defined on [`OsString`].
1196     ///
1197     /// # Examples
1198     ///
1199     /// ```
1200     /// use std::path::PathBuf;
1201     ///
1202     /// let mut path = PathBuf::with_capacity(10);
1203     /// let capacity = path.capacity();
1204     ///
1205     /// // This push is done without reallocating
1206     /// path.push(r"C:\");
1207     ///
1208     /// assert_eq!(capacity, path.capacity());
1209     /// ```
1210     ///
1211     /// [`with_capacity`]: OsString::with_capacity
1212     #[stable(feature = "path_buf_capacity", since = "1.44.0")]
1213     #[must_use]
1214     #[inline]
1215     pub fn with_capacity(capacity: usize) -> PathBuf {
1216         PathBuf { inner: OsString::with_capacity(capacity) }
1217     }
1218
1219     /// Coerces to a [`Path`] slice.
1220     ///
1221     /// # Examples
1222     ///
1223     /// ```
1224     /// use std::path::{Path, PathBuf};
1225     ///
1226     /// let p = PathBuf::from("/test");
1227     /// assert_eq!(Path::new("/test"), p.as_path());
1228     /// ```
1229     #[stable(feature = "rust1", since = "1.0.0")]
1230     #[must_use]
1231     #[inline]
1232     pub fn as_path(&self) -> &Path {
1233         self
1234     }
1235
1236     /// Extends `self` with `path`.
1237     ///
1238     /// If `path` is absolute, it replaces the current path.
1239     ///
1240     /// On Windows:
1241     ///
1242     /// * if `path` has a root but no prefix (e.g., `\windows`), it
1243     ///   replaces everything except for the prefix (if any) of `self`.
1244     /// * if `path` has a prefix but no root, it replaces `self`.
1245     /// * if `self` has a verbatim prefix (e.g. `\\?\C:\windows`)
1246     ///   and `path` is not empty, the new path is normalized: all references
1247     ///   to `.` and `..` are removed.
1248     ///
1249     /// # Examples
1250     ///
1251     /// Pushing a relative path extends the existing path:
1252     ///
1253     /// ```
1254     /// use std::path::PathBuf;
1255     ///
1256     /// let mut path = PathBuf::from("/tmp");
1257     /// path.push("file.bk");
1258     /// assert_eq!(path, PathBuf::from("/tmp/file.bk"));
1259     /// ```
1260     ///
1261     /// Pushing an absolute path replaces the existing path:
1262     ///
1263     /// ```
1264     /// use std::path::PathBuf;
1265     ///
1266     /// let mut path = PathBuf::from("/tmp");
1267     /// path.push("/etc");
1268     /// assert_eq!(path, PathBuf::from("/etc"));
1269     /// ```
1270     #[stable(feature = "rust1", since = "1.0.0")]
1271     pub fn push<P: AsRef<Path>>(&mut self, path: P) {
1272         self._push(path.as_ref())
1273     }
1274
1275     fn _push(&mut self, path: &Path) {
1276         // in general, a separator is needed if the rightmost byte is not a separator
1277         let mut need_sep = self.as_mut_vec().last().map(|c| !is_sep_byte(*c)).unwrap_or(false);
1278
1279         // in the special case of `C:` on Windows, do *not* add a separator
1280         let comps = self.components();
1281
1282         if comps.prefix_len() > 0
1283             && comps.prefix_len() == comps.path.len()
1284             && comps.prefix.unwrap().is_drive()
1285         {
1286             need_sep = false
1287         }
1288
1289         // absolute `path` replaces `self`
1290         if path.is_absolute() || path.prefix().is_some() {
1291             self.as_mut_vec().truncate(0);
1292
1293         // verbatim paths need . and .. removed
1294         } else if comps.prefix_verbatim() && !path.inner.is_empty() {
1295             let mut buf: Vec<_> = comps.collect();
1296             for c in path.components() {
1297                 match c {
1298                     Component::RootDir => {
1299                         buf.truncate(1);
1300                         buf.push(c);
1301                     }
1302                     Component::CurDir => (),
1303                     Component::ParentDir => {
1304                         if let Some(Component::Normal(_)) = buf.last() {
1305                             buf.pop();
1306                         }
1307                     }
1308                     _ => buf.push(c),
1309                 }
1310             }
1311
1312             let mut res = OsString::new();
1313             let mut need_sep = false;
1314
1315             for c in buf {
1316                 if need_sep && c != Component::RootDir {
1317                     res.push(MAIN_SEP_STR);
1318                 }
1319                 res.push(c.as_os_str());
1320
1321                 need_sep = match c {
1322                     Component::RootDir => false,
1323                     Component::Prefix(prefix) => {
1324                         !prefix.parsed.is_drive() && prefix.parsed.len() > 0
1325                     }
1326                     _ => true,
1327                 }
1328             }
1329
1330             self.inner = res;
1331             return;
1332
1333         // `path` has a root but no prefix, e.g., `\windows` (Windows only)
1334         } else if path.has_root() {
1335             let prefix_len = self.components().prefix_remaining();
1336             self.as_mut_vec().truncate(prefix_len);
1337
1338         // `path` is a pure relative path
1339         } else if need_sep {
1340             self.inner.push(MAIN_SEP_STR);
1341         }
1342
1343         self.inner.push(path);
1344     }
1345
1346     /// Truncates `self` to [`self.parent`].
1347     ///
1348     /// Returns `false` and does nothing if [`self.parent`] is [`None`].
1349     /// Otherwise, returns `true`.
1350     ///
1351     /// [`self.parent`]: Path::parent
1352     ///
1353     /// # Examples
1354     ///
1355     /// ```
1356     /// use std::path::{Path, PathBuf};
1357     ///
1358     /// let mut p = PathBuf::from("/spirited/away.rs");
1359     ///
1360     /// p.pop();
1361     /// assert_eq!(Path::new("/spirited"), p);
1362     /// p.pop();
1363     /// assert_eq!(Path::new("/"), p);
1364     /// ```
1365     #[stable(feature = "rust1", since = "1.0.0")]
1366     pub fn pop(&mut self) -> bool {
1367         match self.parent().map(|p| p.as_u8_slice().len()) {
1368             Some(len) => {
1369                 self.as_mut_vec().truncate(len);
1370                 true
1371             }
1372             None => false,
1373         }
1374     }
1375
1376     /// Updates [`self.file_name`] to `file_name`.
1377     ///
1378     /// If [`self.file_name`] was [`None`], this is equivalent to pushing
1379     /// `file_name`.
1380     ///
1381     /// Otherwise it is equivalent to calling [`pop`] and then pushing
1382     /// `file_name`. The new path will be a sibling of the original path.
1383     /// (That is, it will have the same parent.)
1384     ///
1385     /// [`self.file_name`]: Path::file_name
1386     /// [`pop`]: PathBuf::pop
1387     ///
1388     /// # Examples
1389     ///
1390     /// ```
1391     /// use std::path::PathBuf;
1392     ///
1393     /// let mut buf = PathBuf::from("/");
1394     /// assert!(buf.file_name() == None);
1395     /// buf.set_file_name("bar");
1396     /// assert!(buf == PathBuf::from("/bar"));
1397     /// assert!(buf.file_name().is_some());
1398     /// buf.set_file_name("baz.txt");
1399     /// assert!(buf == PathBuf::from("/baz.txt"));
1400     /// ```
1401     #[stable(feature = "rust1", since = "1.0.0")]
1402     pub fn set_file_name<S: AsRef<OsStr>>(&mut self, file_name: S) {
1403         self._set_file_name(file_name.as_ref())
1404     }
1405
1406     fn _set_file_name(&mut self, file_name: &OsStr) {
1407         if self.file_name().is_some() {
1408             let popped = self.pop();
1409             debug_assert!(popped);
1410         }
1411         self.push(file_name);
1412     }
1413
1414     /// Updates [`self.extension`] to `extension`.
1415     ///
1416     /// Returns `false` and does nothing if [`self.file_name`] is [`None`],
1417     /// returns `true` and updates the extension otherwise.
1418     ///
1419     /// If [`self.extension`] is [`None`], the extension is added; otherwise
1420     /// it is replaced.
1421     ///
1422     /// [`self.file_name`]: Path::file_name
1423     /// [`self.extension`]: Path::extension
1424     ///
1425     /// # Examples
1426     ///
1427     /// ```
1428     /// use std::path::{Path, PathBuf};
1429     ///
1430     /// let mut p = PathBuf::from("/feel/the");
1431     ///
1432     /// p.set_extension("force");
1433     /// assert_eq!(Path::new("/feel/the.force"), p.as_path());
1434     ///
1435     /// p.set_extension("dark_side");
1436     /// assert_eq!(Path::new("/feel/the.dark_side"), p.as_path());
1437     /// ```
1438     #[stable(feature = "rust1", since = "1.0.0")]
1439     pub fn set_extension<S: AsRef<OsStr>>(&mut self, extension: S) -> bool {
1440         self._set_extension(extension.as_ref())
1441     }
1442
1443     fn _set_extension(&mut self, extension: &OsStr) -> bool {
1444         let file_stem = match self.file_stem() {
1445             None => return false,
1446             Some(f) => f.bytes(),
1447         };
1448
1449         // truncate until right after the file stem
1450         let end_file_stem = file_stem[file_stem.len()..].as_ptr().addr();
1451         let start = self.inner.bytes().as_ptr().addr();
1452         let v = self.as_mut_vec();
1453         v.truncate(end_file_stem.wrapping_sub(start));
1454
1455         // add the new extension, if any
1456         let new = extension.bytes();
1457         if !new.is_empty() {
1458             v.reserve_exact(new.len() + 1);
1459             v.push(b'.');
1460             v.extend_from_slice(new);
1461         }
1462
1463         true
1464     }
1465
1466     /// Consumes the `PathBuf`, yielding its internal [`OsString`] storage.
1467     ///
1468     /// # Examples
1469     ///
1470     /// ```
1471     /// use std::path::PathBuf;
1472     ///
1473     /// let p = PathBuf::from("/the/head");
1474     /// let os_str = p.into_os_string();
1475     /// ```
1476     #[stable(feature = "rust1", since = "1.0.0")]
1477     #[must_use = "`self` will be dropped if the result is not used"]
1478     #[inline]
1479     pub fn into_os_string(self) -> OsString {
1480         self.inner
1481     }
1482
1483     /// Converts this `PathBuf` into a [boxed](Box) [`Path`].
1484     #[stable(feature = "into_boxed_path", since = "1.20.0")]
1485     #[must_use = "`self` will be dropped if the result is not used"]
1486     #[inline]
1487     pub fn into_boxed_path(self) -> Box<Path> {
1488         let rw = Box::into_raw(self.inner.into_boxed_os_str()) as *mut Path;
1489         unsafe { Box::from_raw(rw) }
1490     }
1491
1492     /// Invokes [`capacity`] on the underlying instance of [`OsString`].
1493     ///
1494     /// [`capacity`]: OsString::capacity
1495     #[stable(feature = "path_buf_capacity", since = "1.44.0")]
1496     #[must_use]
1497     #[inline]
1498     pub fn capacity(&self) -> usize {
1499         self.inner.capacity()
1500     }
1501
1502     /// Invokes [`clear`] on the underlying instance of [`OsString`].
1503     ///
1504     /// [`clear`]: OsString::clear
1505     #[stable(feature = "path_buf_capacity", since = "1.44.0")]
1506     #[inline]
1507     pub fn clear(&mut self) {
1508         self.inner.clear()
1509     }
1510
1511     /// Invokes [`reserve`] on the underlying instance of [`OsString`].
1512     ///
1513     /// [`reserve`]: OsString::reserve
1514     #[stable(feature = "path_buf_capacity", since = "1.44.0")]
1515     #[inline]
1516     pub fn reserve(&mut self, additional: usize) {
1517         self.inner.reserve(additional)
1518     }
1519
1520     /// Invokes [`try_reserve`] on the underlying instance of [`OsString`].
1521     ///
1522     /// [`try_reserve`]: OsString::try_reserve
1523     #[stable(feature = "try_reserve_2", since = "1.63.0")]
1524     #[inline]
1525     pub fn try_reserve(&mut self, additional: usize) -> Result<(), TryReserveError> {
1526         self.inner.try_reserve(additional)
1527     }
1528
1529     /// Invokes [`reserve_exact`] on the underlying instance of [`OsString`].
1530     ///
1531     /// [`reserve_exact`]: OsString::reserve_exact
1532     #[stable(feature = "path_buf_capacity", since = "1.44.0")]
1533     #[inline]
1534     pub fn reserve_exact(&mut self, additional: usize) {
1535         self.inner.reserve_exact(additional)
1536     }
1537
1538     /// Invokes [`try_reserve_exact`] on the underlying instance of [`OsString`].
1539     ///
1540     /// [`try_reserve_exact`]: OsString::try_reserve_exact
1541     #[stable(feature = "try_reserve_2", since = "1.63.0")]
1542     #[inline]
1543     pub fn try_reserve_exact(&mut self, additional: usize) -> Result<(), TryReserveError> {
1544         self.inner.try_reserve_exact(additional)
1545     }
1546
1547     /// Invokes [`shrink_to_fit`] on the underlying instance of [`OsString`].
1548     ///
1549     /// [`shrink_to_fit`]: OsString::shrink_to_fit
1550     #[stable(feature = "path_buf_capacity", since = "1.44.0")]
1551     #[inline]
1552     pub fn shrink_to_fit(&mut self) {
1553         self.inner.shrink_to_fit()
1554     }
1555
1556     /// Invokes [`shrink_to`] on the underlying instance of [`OsString`].
1557     ///
1558     /// [`shrink_to`]: OsString::shrink_to
1559     #[stable(feature = "shrink_to", since = "1.56.0")]
1560     #[inline]
1561     pub fn shrink_to(&mut self, min_capacity: usize) {
1562         self.inner.shrink_to(min_capacity)
1563     }
1564 }
1565
1566 #[stable(feature = "rust1", since = "1.0.0")]
1567 impl Clone for PathBuf {
1568     #[inline]
1569     fn clone(&self) -> Self {
1570         PathBuf { inner: self.inner.clone() }
1571     }
1572
1573     #[inline]
1574     fn clone_from(&mut self, source: &Self) {
1575         self.inner.clone_from(&source.inner)
1576     }
1577 }
1578
1579 #[stable(feature = "box_from_path", since = "1.17.0")]
1580 impl From<&Path> for Box<Path> {
1581     /// Creates a boxed [`Path`] from a reference.
1582     ///
1583     /// This will allocate and clone `path` to it.
1584     fn from(path: &Path) -> Box<Path> {
1585         let boxed: Box<OsStr> = path.inner.into();
1586         let rw = Box::into_raw(boxed) as *mut Path;
1587         unsafe { Box::from_raw(rw) }
1588     }
1589 }
1590
1591 #[stable(feature = "box_from_cow", since = "1.45.0")]
1592 impl From<Cow<'_, Path>> for Box<Path> {
1593     /// Creates a boxed [`Path`] from a clone-on-write pointer.
1594     ///
1595     /// Converting from a `Cow::Owned` does not clone or allocate.
1596     #[inline]
1597     fn from(cow: Cow<'_, Path>) -> Box<Path> {
1598         match cow {
1599             Cow::Borrowed(path) => Box::from(path),
1600             Cow::Owned(path) => Box::from(path),
1601         }
1602     }
1603 }
1604
1605 #[stable(feature = "path_buf_from_box", since = "1.18.0")]
1606 impl From<Box<Path>> for PathBuf {
1607     /// Converts a <code>[Box]&lt;[Path]&gt;</code> into a [`PathBuf`].
1608     ///
1609     /// This conversion does not allocate or copy memory.
1610     #[inline]
1611     fn from(boxed: Box<Path>) -> PathBuf {
1612         boxed.into_path_buf()
1613     }
1614 }
1615
1616 #[stable(feature = "box_from_path_buf", since = "1.20.0")]
1617 impl From<PathBuf> for Box<Path> {
1618     /// Converts a [`PathBuf`] into a <code>[Box]&lt;[Path]&gt;</code>.
1619     ///
1620     /// This conversion currently should not allocate memory,
1621     /// but this behavior is not guaranteed on all platforms or in all future versions.
1622     #[inline]
1623     fn from(p: PathBuf) -> Box<Path> {
1624         p.into_boxed_path()
1625     }
1626 }
1627
1628 #[stable(feature = "more_box_slice_clone", since = "1.29.0")]
1629 impl Clone for Box<Path> {
1630     #[inline]
1631     fn clone(&self) -> Self {
1632         self.to_path_buf().into_boxed_path()
1633     }
1634 }
1635
1636 #[stable(feature = "rust1", since = "1.0.0")]
1637 impl<T: ?Sized + AsRef<OsStr>> From<&T> for PathBuf {
1638     /// Converts a borrowed [`OsStr`] to a [`PathBuf`].
1639     ///
1640     /// Allocates a [`PathBuf`] and copies the data into it.
1641     #[inline]
1642     fn from(s: &T) -> PathBuf {
1643         PathBuf::from(s.as_ref().to_os_string())
1644     }
1645 }
1646
1647 #[stable(feature = "rust1", since = "1.0.0")]
1648 impl From<OsString> for PathBuf {
1649     /// Converts an [`OsString`] into a [`PathBuf`]
1650     ///
1651     /// This conversion does not allocate or copy memory.
1652     #[inline]
1653     fn from(s: OsString) -> PathBuf {
1654         PathBuf { inner: s }
1655     }
1656 }
1657
1658 #[stable(feature = "from_path_buf_for_os_string", since = "1.14.0")]
1659 impl From<PathBuf> for OsString {
1660     /// Converts a [`PathBuf`] into an [`OsString`]
1661     ///
1662     /// This conversion does not allocate or copy memory.
1663     #[inline]
1664     fn from(path_buf: PathBuf) -> OsString {
1665         path_buf.inner
1666     }
1667 }
1668
1669 #[stable(feature = "rust1", since = "1.0.0")]
1670 impl From<String> for PathBuf {
1671     /// Converts a [`String`] into a [`PathBuf`]
1672     ///
1673     /// This conversion does not allocate or copy memory.
1674     #[inline]
1675     fn from(s: String) -> PathBuf {
1676         PathBuf::from(OsString::from(s))
1677     }
1678 }
1679
1680 #[stable(feature = "path_from_str", since = "1.32.0")]
1681 impl FromStr for PathBuf {
1682     type Err = core::convert::Infallible;
1683
1684     #[inline]
1685     fn from_str(s: &str) -> Result<Self, Self::Err> {
1686         Ok(PathBuf::from(s))
1687     }
1688 }
1689
1690 #[stable(feature = "rust1", since = "1.0.0")]
1691 impl<P: AsRef<Path>> iter::FromIterator<P> for PathBuf {
1692     fn from_iter<I: IntoIterator<Item = P>>(iter: I) -> PathBuf {
1693         let mut buf = PathBuf::new();
1694         buf.extend(iter);
1695         buf
1696     }
1697 }
1698
1699 #[stable(feature = "rust1", since = "1.0.0")]
1700 impl<P: AsRef<Path>> iter::Extend<P> for PathBuf {
1701     fn extend<I: IntoIterator<Item = P>>(&mut self, iter: I) {
1702         iter.into_iter().for_each(move |p| self.push(p.as_ref()));
1703     }
1704
1705     #[inline]
1706     fn extend_one(&mut self, p: P) {
1707         self.push(p.as_ref());
1708     }
1709 }
1710
1711 #[stable(feature = "rust1", since = "1.0.0")]
1712 impl fmt::Debug for PathBuf {
1713     fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
1714         fmt::Debug::fmt(&**self, formatter)
1715     }
1716 }
1717
1718 #[stable(feature = "rust1", since = "1.0.0")]
1719 impl ops::Deref for PathBuf {
1720     type Target = Path;
1721     #[inline]
1722     fn deref(&self) -> &Path {
1723         Path::new(&self.inner)
1724     }
1725 }
1726
1727 #[stable(feature = "rust1", since = "1.0.0")]
1728 impl Borrow<Path> for PathBuf {
1729     #[inline]
1730     fn borrow(&self) -> &Path {
1731         self.deref()
1732     }
1733 }
1734
1735 #[stable(feature = "default_for_pathbuf", since = "1.17.0")]
1736 impl Default for PathBuf {
1737     #[inline]
1738     fn default() -> Self {
1739         PathBuf::new()
1740     }
1741 }
1742
1743 #[stable(feature = "cow_from_path", since = "1.6.0")]
1744 impl<'a> From<&'a Path> for Cow<'a, Path> {
1745     /// Creates a clone-on-write pointer from a reference to
1746     /// [`Path`].
1747     ///
1748     /// This conversion does not clone or allocate.
1749     #[inline]
1750     fn from(s: &'a Path) -> Cow<'a, Path> {
1751         Cow::Borrowed(s)
1752     }
1753 }
1754
1755 #[stable(feature = "cow_from_path", since = "1.6.0")]
1756 impl<'a> From<PathBuf> for Cow<'a, Path> {
1757     /// Creates a clone-on-write pointer from an owned
1758     /// instance of [`PathBuf`].
1759     ///
1760     /// This conversion does not clone or allocate.
1761     #[inline]
1762     fn from(s: PathBuf) -> Cow<'a, Path> {
1763         Cow::Owned(s)
1764     }
1765 }
1766
1767 #[stable(feature = "cow_from_pathbuf_ref", since = "1.28.0")]
1768 impl<'a> From<&'a PathBuf> for Cow<'a, Path> {
1769     /// Creates a clone-on-write pointer from a reference to
1770     /// [`PathBuf`].
1771     ///
1772     /// This conversion does not clone or allocate.
1773     #[inline]
1774     fn from(p: &'a PathBuf) -> Cow<'a, Path> {
1775         Cow::Borrowed(p.as_path())
1776     }
1777 }
1778
1779 #[stable(feature = "pathbuf_from_cow_path", since = "1.28.0")]
1780 impl<'a> From<Cow<'a, Path>> for PathBuf {
1781     /// Converts a clone-on-write pointer to an owned path.
1782     ///
1783     /// Converting from a `Cow::Owned` does not clone or allocate.
1784     #[inline]
1785     fn from(p: Cow<'a, Path>) -> Self {
1786         p.into_owned()
1787     }
1788 }
1789
1790 #[stable(feature = "shared_from_slice2", since = "1.24.0")]
1791 impl From<PathBuf> for Arc<Path> {
1792     /// Converts a [`PathBuf`] into an <code>[Arc]<[Path]></code> by moving the [`PathBuf`] data
1793     /// into a new [`Arc`] buffer.
1794     #[inline]
1795     fn from(s: PathBuf) -> Arc<Path> {
1796         let arc: Arc<OsStr> = Arc::from(s.into_os_string());
1797         unsafe { Arc::from_raw(Arc::into_raw(arc) as *const Path) }
1798     }
1799 }
1800
1801 #[stable(feature = "shared_from_slice2", since = "1.24.0")]
1802 impl From<&Path> for Arc<Path> {
1803     /// Converts a [`Path`] into an [`Arc`] by copying the [`Path`] data into a new [`Arc`] buffer.
1804     #[inline]
1805     fn from(s: &Path) -> Arc<Path> {
1806         let arc: Arc<OsStr> = Arc::from(s.as_os_str());
1807         unsafe { Arc::from_raw(Arc::into_raw(arc) as *const Path) }
1808     }
1809 }
1810
1811 #[stable(feature = "shared_from_slice2", since = "1.24.0")]
1812 impl From<PathBuf> for Rc<Path> {
1813     /// Converts a [`PathBuf`] into an <code>[Rc]<[Path]></code> by moving the [`PathBuf`] data into
1814     /// a new [`Rc`] buffer.
1815     #[inline]
1816     fn from(s: PathBuf) -> Rc<Path> {
1817         let rc: Rc<OsStr> = Rc::from(s.into_os_string());
1818         unsafe { Rc::from_raw(Rc::into_raw(rc) as *const Path) }
1819     }
1820 }
1821
1822 #[stable(feature = "shared_from_slice2", since = "1.24.0")]
1823 impl From<&Path> for Rc<Path> {
1824     /// Converts a [`Path`] into an [`Rc`] by copying the [`Path`] data into a new [`Rc`] buffer.
1825     #[inline]
1826     fn from(s: &Path) -> Rc<Path> {
1827         let rc: Rc<OsStr> = Rc::from(s.as_os_str());
1828         unsafe { Rc::from_raw(Rc::into_raw(rc) as *const Path) }
1829     }
1830 }
1831
1832 #[stable(feature = "rust1", since = "1.0.0")]
1833 impl ToOwned for Path {
1834     type Owned = PathBuf;
1835     #[inline]
1836     fn to_owned(&self) -> PathBuf {
1837         self.to_path_buf()
1838     }
1839     #[inline]
1840     fn clone_into(&self, target: &mut PathBuf) {
1841         self.inner.clone_into(&mut target.inner);
1842     }
1843 }
1844
1845 #[stable(feature = "rust1", since = "1.0.0")]
1846 impl cmp::PartialEq for PathBuf {
1847     #[inline]
1848     fn eq(&self, other: &PathBuf) -> bool {
1849         self.components() == other.components()
1850     }
1851 }
1852
1853 #[stable(feature = "rust1", since = "1.0.0")]
1854 impl Hash for PathBuf {
1855     fn hash<H: Hasher>(&self, h: &mut H) {
1856         self.as_path().hash(h)
1857     }
1858 }
1859
1860 #[stable(feature = "rust1", since = "1.0.0")]
1861 impl cmp::Eq for PathBuf {}
1862
1863 #[stable(feature = "rust1", since = "1.0.0")]
1864 impl cmp::PartialOrd for PathBuf {
1865     #[inline]
1866     fn partial_cmp(&self, other: &PathBuf) -> Option<cmp::Ordering> {
1867         Some(compare_components(self.components(), other.components()))
1868     }
1869 }
1870
1871 #[stable(feature = "rust1", since = "1.0.0")]
1872 impl cmp::Ord for PathBuf {
1873     #[inline]
1874     fn cmp(&self, other: &PathBuf) -> cmp::Ordering {
1875         compare_components(self.components(), other.components())
1876     }
1877 }
1878
1879 #[stable(feature = "rust1", since = "1.0.0")]
1880 impl AsRef<OsStr> for PathBuf {
1881     #[inline]
1882     fn as_ref(&self) -> &OsStr {
1883         &self.inner[..]
1884     }
1885 }
1886
1887 /// A slice of a path (akin to [`str`]).
1888 ///
1889 /// This type supports a number of operations for inspecting a path, including
1890 /// breaking the path into its components (separated by `/` on Unix and by either
1891 /// `/` or `\` on Windows), extracting the file name, determining whether the path
1892 /// is absolute, and so on.
1893 ///
1894 /// This is an *unsized* type, meaning that it must always be used behind a
1895 /// pointer like `&` or [`Box`]. For an owned version of this type,
1896 /// see [`PathBuf`].
1897 ///
1898 /// More details about the overall approach can be found in
1899 /// the [module documentation](self).
1900 ///
1901 /// # Examples
1902 ///
1903 /// ```
1904 /// use std::path::Path;
1905 /// use std::ffi::OsStr;
1906 ///
1907 /// // Note: this example does work on Windows
1908 /// let path = Path::new("./foo/bar.txt");
1909 ///
1910 /// let parent = path.parent();
1911 /// assert_eq!(parent, Some(Path::new("./foo")));
1912 ///
1913 /// let file_stem = path.file_stem();
1914 /// assert_eq!(file_stem, Some(OsStr::new("bar")));
1915 ///
1916 /// let extension = path.extension();
1917 /// assert_eq!(extension, Some(OsStr::new("txt")));
1918 /// ```
1919 #[cfg_attr(not(test), rustc_diagnostic_item = "Path")]
1920 #[stable(feature = "rust1", since = "1.0.0")]
1921 // FIXME:
1922 // `Path::new` current implementation relies
1923 // on `Path` being layout-compatible with `OsStr`.
1924 // When attribute privacy is implemented, `Path` should be annotated as `#[repr(transparent)]`.
1925 // Anyway, `Path` representation and layout are considered implementation detail, are
1926 // not documented and must not be relied upon.
1927 pub struct Path {
1928     inner: OsStr,
1929 }
1930
1931 /// An error returned from [`Path::strip_prefix`] if the prefix was not found.
1932 ///
1933 /// This `struct` is created by the [`strip_prefix`] method on [`Path`].
1934 /// See its documentation for more.
1935 ///
1936 /// [`strip_prefix`]: Path::strip_prefix
1937 #[derive(Debug, Clone, PartialEq, Eq)]
1938 #[stable(since = "1.7.0", feature = "strip_prefix")]
1939 pub struct StripPrefixError(());
1940
1941 impl Path {
1942     // The following (private!) function allows construction of a path from a u8
1943     // slice, which is only safe when it is known to follow the OsStr encoding.
1944     unsafe fn from_u8_slice(s: &[u8]) -> &Path {
1945         unsafe { Path::new(u8_slice_as_os_str(s)) }
1946     }
1947     // The following (private!) function reveals the byte encoding used for OsStr.
1948     fn as_u8_slice(&self) -> &[u8] {
1949         self.inner.bytes()
1950     }
1951
1952     /// Directly wraps a string slice as a `Path` slice.
1953     ///
1954     /// This is a cost-free conversion.
1955     ///
1956     /// # Examples
1957     ///
1958     /// ```
1959     /// use std::path::Path;
1960     ///
1961     /// Path::new("foo.txt");
1962     /// ```
1963     ///
1964     /// You can create `Path`s from `String`s, or even other `Path`s:
1965     ///
1966     /// ```
1967     /// use std::path::Path;
1968     ///
1969     /// let string = String::from("foo.txt");
1970     /// let from_string = Path::new(&string);
1971     /// let from_path = Path::new(&from_string);
1972     /// assert_eq!(from_string, from_path);
1973     /// ```
1974     #[stable(feature = "rust1", since = "1.0.0")]
1975     pub fn new<S: AsRef<OsStr> + ?Sized>(s: &S) -> &Path {
1976         unsafe { &*(s.as_ref() as *const OsStr as *const Path) }
1977     }
1978
1979     /// Yields the underlying [`OsStr`] slice.
1980     ///
1981     /// # Examples
1982     ///
1983     /// ```
1984     /// use std::path::Path;
1985     ///
1986     /// let os_str = Path::new("foo.txt").as_os_str();
1987     /// assert_eq!(os_str, std::ffi::OsStr::new("foo.txt"));
1988     /// ```
1989     #[stable(feature = "rust1", since = "1.0.0")]
1990     #[must_use]
1991     #[inline]
1992     pub fn as_os_str(&self) -> &OsStr {
1993         &self.inner
1994     }
1995
1996     /// Yields a [`&str`] slice if the `Path` is valid unicode.
1997     ///
1998     /// This conversion may entail doing a check for UTF-8 validity.
1999     /// Note that validation is performed because non-UTF-8 strings are
2000     /// perfectly valid for some OS.
2001     ///
2002     /// [`&str`]: str
2003     ///
2004     /// # Examples
2005     ///
2006     /// ```
2007     /// use std::path::Path;
2008     ///
2009     /// let path = Path::new("foo.txt");
2010     /// assert_eq!(path.to_str(), Some("foo.txt"));
2011     /// ```
2012     #[stable(feature = "rust1", since = "1.0.0")]
2013     #[must_use = "this returns the result of the operation, \
2014                   without modifying the original"]
2015     #[inline]
2016     pub fn to_str(&self) -> Option<&str> {
2017         self.inner.to_str()
2018     }
2019
2020     /// Converts a `Path` to a [`Cow<str>`].
2021     ///
2022     /// Any non-Unicode sequences are replaced with
2023     /// [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD].
2024     ///
2025     /// [U+FFFD]: super::char::REPLACEMENT_CHARACTER
2026     ///
2027     /// # Examples
2028     ///
2029     /// Calling `to_string_lossy` on a `Path` with valid unicode:
2030     ///
2031     /// ```
2032     /// use std::path::Path;
2033     ///
2034     /// let path = Path::new("foo.txt");
2035     /// assert_eq!(path.to_string_lossy(), "foo.txt");
2036     /// ```
2037     ///
2038     /// Had `path` contained invalid unicode, the `to_string_lossy` call might
2039     /// have returned `"fo�.txt"`.
2040     #[stable(feature = "rust1", since = "1.0.0")]
2041     #[must_use = "this returns the result of the operation, \
2042                   without modifying the original"]
2043     #[inline]
2044     pub fn to_string_lossy(&self) -> Cow<'_, str> {
2045         self.inner.to_string_lossy()
2046     }
2047
2048     /// Converts a `Path` to an owned [`PathBuf`].
2049     ///
2050     /// # Examples
2051     ///
2052     /// ```
2053     /// use std::path::Path;
2054     ///
2055     /// let path_buf = Path::new("foo.txt").to_path_buf();
2056     /// assert_eq!(path_buf, std::path::PathBuf::from("foo.txt"));
2057     /// ```
2058     #[rustc_conversion_suggestion]
2059     #[must_use = "this returns the result of the operation, \
2060                   without modifying the original"]
2061     #[stable(feature = "rust1", since = "1.0.0")]
2062     pub fn to_path_buf(&self) -> PathBuf {
2063         PathBuf::from(self.inner.to_os_string())
2064     }
2065
2066     /// Returns `true` if the `Path` is absolute, i.e., if it is independent of
2067     /// the current directory.
2068     ///
2069     /// * On Unix, a path is absolute if it starts with the root, so
2070     /// `is_absolute` and [`has_root`] are equivalent.
2071     ///
2072     /// * On Windows, a path is absolute if it has a prefix and starts with the
2073     /// root: `c:\windows` is absolute, while `c:temp` and `\temp` are not.
2074     ///
2075     /// # Examples
2076     ///
2077     /// ```
2078     /// use std::path::Path;
2079     ///
2080     /// assert!(!Path::new("foo.txt").is_absolute());
2081     /// ```
2082     ///
2083     /// [`has_root`]: Path::has_root
2084     #[stable(feature = "rust1", since = "1.0.0")]
2085     #[must_use]
2086     #[allow(deprecated)]
2087     pub fn is_absolute(&self) -> bool {
2088         if cfg!(target_os = "redox") {
2089             // FIXME: Allow Redox prefixes
2090             self.has_root() || has_redox_scheme(self.as_u8_slice())
2091         } else {
2092             self.has_root() && (cfg!(any(unix, target_os = "wasi")) || self.prefix().is_some())
2093         }
2094     }
2095
2096     /// Returns `true` if the `Path` is relative, i.e., not absolute.
2097     ///
2098     /// See [`is_absolute`]'s documentation for more details.
2099     ///
2100     /// # Examples
2101     ///
2102     /// ```
2103     /// use std::path::Path;
2104     ///
2105     /// assert!(Path::new("foo.txt").is_relative());
2106     /// ```
2107     ///
2108     /// [`is_absolute`]: Path::is_absolute
2109     #[stable(feature = "rust1", since = "1.0.0")]
2110     #[must_use]
2111     #[inline]
2112     pub fn is_relative(&self) -> bool {
2113         !self.is_absolute()
2114     }
2115
2116     fn prefix(&self) -> Option<Prefix<'_>> {
2117         self.components().prefix
2118     }
2119
2120     /// Returns `true` if the `Path` has a root.
2121     ///
2122     /// * On Unix, a path has a root if it begins with `/`.
2123     ///
2124     /// * On Windows, a path has a root if it:
2125     ///     * has no prefix and begins with a separator, e.g., `\windows`
2126     ///     * has a prefix followed by a separator, e.g., `c:\windows` but not `c:windows`
2127     ///     * has any non-disk prefix, e.g., `\\server\share`
2128     ///
2129     /// # Examples
2130     ///
2131     /// ```
2132     /// use std::path::Path;
2133     ///
2134     /// assert!(Path::new("/etc/passwd").has_root());
2135     /// ```
2136     #[stable(feature = "rust1", since = "1.0.0")]
2137     #[must_use]
2138     #[inline]
2139     pub fn has_root(&self) -> bool {
2140         self.components().has_root()
2141     }
2142
2143     /// Returns the `Path` without its final component, if there is one.
2144     ///
2145     /// This means it returns `Some("")` for relative paths with one component.
2146     ///
2147     /// Returns [`None`] if the path terminates in a root or prefix, or if it's
2148     /// the empty string.
2149     ///
2150     /// # Examples
2151     ///
2152     /// ```
2153     /// use std::path::Path;
2154     ///
2155     /// let path = Path::new("/foo/bar");
2156     /// let parent = path.parent().unwrap();
2157     /// assert_eq!(parent, Path::new("/foo"));
2158     ///
2159     /// let grand_parent = parent.parent().unwrap();
2160     /// assert_eq!(grand_parent, Path::new("/"));
2161     /// assert_eq!(grand_parent.parent(), None);
2162     ///
2163     /// let relative_path = Path::new("foo/bar");
2164     /// let parent = relative_path.parent();
2165     /// assert_eq!(parent, Some(Path::new("foo")));
2166     /// let grand_parent = parent.and_then(Path::parent);
2167     /// assert_eq!(grand_parent, Some(Path::new("")));
2168     /// let great_grand_parent = grand_parent.and_then(Path::parent);
2169     /// assert_eq!(great_grand_parent, None);
2170     /// ```
2171     #[stable(feature = "rust1", since = "1.0.0")]
2172     #[doc(alias = "dirname")]
2173     #[must_use]
2174     pub fn parent(&self) -> Option<&Path> {
2175         let mut comps = self.components();
2176         let comp = comps.next_back();
2177         comp.and_then(|p| match p {
2178             Component::Normal(_) | Component::CurDir | Component::ParentDir => {
2179                 Some(comps.as_path())
2180             }
2181             _ => None,
2182         })
2183     }
2184
2185     /// Produces an iterator over `Path` and its ancestors.
2186     ///
2187     /// The iterator will yield the `Path` that is returned if the [`parent`] method is used zero
2188     /// or more times. That means, the iterator will yield `&self`, `&self.parent().unwrap()`,
2189     /// `&self.parent().unwrap().parent().unwrap()` and so on. If the [`parent`] method returns
2190     /// [`None`], the iterator will do likewise. The iterator will always yield at least one value,
2191     /// namely `&self`.
2192     ///
2193     /// # Examples
2194     ///
2195     /// ```
2196     /// use std::path::Path;
2197     ///
2198     /// let mut ancestors = Path::new("/foo/bar").ancestors();
2199     /// assert_eq!(ancestors.next(), Some(Path::new("/foo/bar")));
2200     /// assert_eq!(ancestors.next(), Some(Path::new("/foo")));
2201     /// assert_eq!(ancestors.next(), Some(Path::new("/")));
2202     /// assert_eq!(ancestors.next(), None);
2203     ///
2204     /// let mut ancestors = Path::new("../foo/bar").ancestors();
2205     /// assert_eq!(ancestors.next(), Some(Path::new("../foo/bar")));
2206     /// assert_eq!(ancestors.next(), Some(Path::new("../foo")));
2207     /// assert_eq!(ancestors.next(), Some(Path::new("..")));
2208     /// assert_eq!(ancestors.next(), Some(Path::new("")));
2209     /// assert_eq!(ancestors.next(), None);
2210     /// ```
2211     ///
2212     /// [`parent`]: Path::parent
2213     #[stable(feature = "path_ancestors", since = "1.28.0")]
2214     #[inline]
2215     pub fn ancestors(&self) -> Ancestors<'_> {
2216         Ancestors { next: Some(&self) }
2217     }
2218
2219     /// Returns the final component of the `Path`, if there is one.
2220     ///
2221     /// If the path is a normal file, this is the file name. If it's the path of a directory, this
2222     /// is the directory name.
2223     ///
2224     /// Returns [`None`] if the path terminates in `..`.
2225     ///
2226     /// # Examples
2227     ///
2228     /// ```
2229     /// use std::path::Path;
2230     /// use std::ffi::OsStr;
2231     ///
2232     /// assert_eq!(Some(OsStr::new("bin")), Path::new("/usr/bin/").file_name());
2233     /// assert_eq!(Some(OsStr::new("foo.txt")), Path::new("tmp/foo.txt").file_name());
2234     /// assert_eq!(Some(OsStr::new("foo.txt")), Path::new("foo.txt/.").file_name());
2235     /// assert_eq!(Some(OsStr::new("foo.txt")), Path::new("foo.txt/.//").file_name());
2236     /// assert_eq!(None, Path::new("foo.txt/..").file_name());
2237     /// assert_eq!(None, Path::new("/").file_name());
2238     /// ```
2239     #[stable(feature = "rust1", since = "1.0.0")]
2240     #[doc(alias = "basename")]
2241     #[must_use]
2242     pub fn file_name(&self) -> Option<&OsStr> {
2243         self.components().next_back().and_then(|p| match p {
2244             Component::Normal(p) => Some(p),
2245             _ => None,
2246         })
2247     }
2248
2249     /// Returns a path that, when joined onto `base`, yields `self`.
2250     ///
2251     /// # Errors
2252     ///
2253     /// If `base` is not a prefix of `self` (i.e., [`starts_with`]
2254     /// returns `false`), returns [`Err`].
2255     ///
2256     /// [`starts_with`]: Path::starts_with
2257     ///
2258     /// # Examples
2259     ///
2260     /// ```
2261     /// use std::path::{Path, PathBuf};
2262     ///
2263     /// let path = Path::new("/test/haha/foo.txt");
2264     ///
2265     /// assert_eq!(path.strip_prefix("/"), Ok(Path::new("test/haha/foo.txt")));
2266     /// assert_eq!(path.strip_prefix("/test"), Ok(Path::new("haha/foo.txt")));
2267     /// assert_eq!(path.strip_prefix("/test/"), Ok(Path::new("haha/foo.txt")));
2268     /// assert_eq!(path.strip_prefix("/test/haha/foo.txt"), Ok(Path::new("")));
2269     /// assert_eq!(path.strip_prefix("/test/haha/foo.txt/"), Ok(Path::new("")));
2270     ///
2271     /// assert!(path.strip_prefix("test").is_err());
2272     /// assert!(path.strip_prefix("/haha").is_err());
2273     ///
2274     /// let prefix = PathBuf::from("/test/");
2275     /// assert_eq!(path.strip_prefix(prefix), Ok(Path::new("haha/foo.txt")));
2276     /// ```
2277     #[stable(since = "1.7.0", feature = "path_strip_prefix")]
2278     pub fn strip_prefix<P>(&self, base: P) -> Result<&Path, StripPrefixError>
2279     where
2280         P: AsRef<Path>,
2281     {
2282         self._strip_prefix(base.as_ref())
2283     }
2284
2285     fn _strip_prefix(&self, base: &Path) -> Result<&Path, StripPrefixError> {
2286         iter_after(self.components(), base.components())
2287             .map(|c| c.as_path())
2288             .ok_or(StripPrefixError(()))
2289     }
2290
2291     /// Determines whether `base` is a prefix of `self`.
2292     ///
2293     /// Only considers whole path components to match.
2294     ///
2295     /// # Examples
2296     ///
2297     /// ```
2298     /// use std::path::Path;
2299     ///
2300     /// let path = Path::new("/etc/passwd");
2301     ///
2302     /// assert!(path.starts_with("/etc"));
2303     /// assert!(path.starts_with("/etc/"));
2304     /// assert!(path.starts_with("/etc/passwd"));
2305     /// assert!(path.starts_with("/etc/passwd/")); // extra slash is okay
2306     /// assert!(path.starts_with("/etc/passwd///")); // multiple extra slashes are okay
2307     ///
2308     /// assert!(!path.starts_with("/e"));
2309     /// assert!(!path.starts_with("/etc/passwd.txt"));
2310     ///
2311     /// assert!(!Path::new("/etc/foo.rs").starts_with("/etc/foo"));
2312     /// ```
2313     #[stable(feature = "rust1", since = "1.0.0")]
2314     #[must_use]
2315     pub fn starts_with<P: AsRef<Path>>(&self, base: P) -> bool {
2316         self._starts_with(base.as_ref())
2317     }
2318
2319     fn _starts_with(&self, base: &Path) -> bool {
2320         iter_after(self.components(), base.components()).is_some()
2321     }
2322
2323     /// Determines whether `child` is a suffix of `self`.
2324     ///
2325     /// Only considers whole path components to match.
2326     ///
2327     /// # Examples
2328     ///
2329     /// ```
2330     /// use std::path::Path;
2331     ///
2332     /// let path = Path::new("/etc/resolv.conf");
2333     ///
2334     /// assert!(path.ends_with("resolv.conf"));
2335     /// assert!(path.ends_with("etc/resolv.conf"));
2336     /// assert!(path.ends_with("/etc/resolv.conf"));
2337     ///
2338     /// assert!(!path.ends_with("/resolv.conf"));
2339     /// assert!(!path.ends_with("conf")); // use .extension() instead
2340     /// ```
2341     #[stable(feature = "rust1", since = "1.0.0")]
2342     #[must_use]
2343     pub fn ends_with<P: AsRef<Path>>(&self, child: P) -> bool {
2344         self._ends_with(child.as_ref())
2345     }
2346
2347     fn _ends_with(&self, child: &Path) -> bool {
2348         iter_after(self.components().rev(), child.components().rev()).is_some()
2349     }
2350
2351     /// Extracts the stem (non-extension) portion of [`self.file_name`].
2352     ///
2353     /// [`self.file_name`]: Path::file_name
2354     ///
2355     /// The stem is:
2356     ///
2357     /// * [`None`], if there is no file name;
2358     /// * The entire file name if there is no embedded `.`;
2359     /// * The entire file name if the file name begins with `.` and has no other `.`s within;
2360     /// * Otherwise, the portion of the file name before the final `.`
2361     ///
2362     /// # Examples
2363     ///
2364     /// ```
2365     /// use std::path::Path;
2366     ///
2367     /// assert_eq!("foo", Path::new("foo.rs").file_stem().unwrap());
2368     /// assert_eq!("foo.tar", Path::new("foo.tar.gz").file_stem().unwrap());
2369     /// ```
2370     ///
2371     /// # See Also
2372     /// This method is similar to [`Path::file_prefix`], which extracts the portion of the file name
2373     /// before the *first* `.`
2374     ///
2375     /// [`Path::file_prefix`]: Path::file_prefix
2376     ///
2377     #[stable(feature = "rust1", since = "1.0.0")]
2378     #[must_use]
2379     pub fn file_stem(&self) -> Option<&OsStr> {
2380         self.file_name().map(rsplit_file_at_dot).and_then(|(before, after)| before.or(after))
2381     }
2382
2383     /// Extracts the prefix of [`self.file_name`].
2384     ///
2385     /// The prefix is:
2386     ///
2387     /// * [`None`], if there is no file name;
2388     /// * The entire file name if there is no embedded `.`;
2389     /// * The portion of the file name before the first non-beginning `.`;
2390     /// * The entire file name if the file name begins with `.` and has no other `.`s within;
2391     /// * The portion of the file name before the second `.` if the file name begins with `.`
2392     ///
2393     /// [`self.file_name`]: Path::file_name
2394     ///
2395     /// # Examples
2396     ///
2397     /// ```
2398     /// # #![feature(path_file_prefix)]
2399     /// use std::path::Path;
2400     ///
2401     /// assert_eq!("foo", Path::new("foo.rs").file_prefix().unwrap());
2402     /// assert_eq!("foo", Path::new("foo.tar.gz").file_prefix().unwrap());
2403     /// ```
2404     ///
2405     /// # See Also
2406     /// This method is similar to [`Path::file_stem`], which extracts the portion of the file name
2407     /// before the *last* `.`
2408     ///
2409     /// [`Path::file_stem`]: Path::file_stem
2410     ///
2411     #[unstable(feature = "path_file_prefix", issue = "86319")]
2412     #[must_use]
2413     pub fn file_prefix(&self) -> Option<&OsStr> {
2414         self.file_name().map(split_file_at_dot).and_then(|(before, _after)| Some(before))
2415     }
2416
2417     /// Extracts the extension (without the leading dot) of [`self.file_name`], if possible.
2418     ///
2419     /// The extension is:
2420     ///
2421     /// * [`None`], if there is no file name;
2422     /// * [`None`], if there is no embedded `.`;
2423     /// * [`None`], if the file name begins with `.` and has no other `.`s within;
2424     /// * Otherwise, the portion of the file name after the final `.`
2425     ///
2426     /// [`self.file_name`]: Path::file_name
2427     ///
2428     /// # Examples
2429     ///
2430     /// ```
2431     /// use std::path::Path;
2432     ///
2433     /// assert_eq!("rs", Path::new("foo.rs").extension().unwrap());
2434     /// assert_eq!("gz", Path::new("foo.tar.gz").extension().unwrap());
2435     /// ```
2436     #[stable(feature = "rust1", since = "1.0.0")]
2437     #[must_use]
2438     pub fn extension(&self) -> Option<&OsStr> {
2439         self.file_name().map(rsplit_file_at_dot).and_then(|(before, after)| before.and(after))
2440     }
2441
2442     /// Creates an owned [`PathBuf`] with `path` adjoined to `self`.
2443     ///
2444     /// See [`PathBuf::push`] for more details on what it means to adjoin a path.
2445     ///
2446     /// # Examples
2447     ///
2448     /// ```
2449     /// use std::path::{Path, PathBuf};
2450     ///
2451     /// assert_eq!(Path::new("/etc").join("passwd"), PathBuf::from("/etc/passwd"));
2452     /// ```
2453     #[stable(feature = "rust1", since = "1.0.0")]
2454     #[must_use]
2455     pub fn join<P: AsRef<Path>>(&self, path: P) -> PathBuf {
2456         self._join(path.as_ref())
2457     }
2458
2459     fn _join(&self, path: &Path) -> PathBuf {
2460         let mut buf = self.to_path_buf();
2461         buf.push(path);
2462         buf
2463     }
2464
2465     /// Creates an owned [`PathBuf`] like `self` but with the given file name.
2466     ///
2467     /// See [`PathBuf::set_file_name`] for more details.
2468     ///
2469     /// # Examples
2470     ///
2471     /// ```
2472     /// use std::path::{Path, PathBuf};
2473     ///
2474     /// let path = Path::new("/tmp/foo.txt");
2475     /// assert_eq!(path.with_file_name("bar.txt"), PathBuf::from("/tmp/bar.txt"));
2476     ///
2477     /// let path = Path::new("/tmp");
2478     /// assert_eq!(path.with_file_name("var"), PathBuf::from("/var"));
2479     /// ```
2480     #[stable(feature = "rust1", since = "1.0.0")]
2481     #[must_use]
2482     pub fn with_file_name<S: AsRef<OsStr>>(&self, file_name: S) -> PathBuf {
2483         self._with_file_name(file_name.as_ref())
2484     }
2485
2486     fn _with_file_name(&self, file_name: &OsStr) -> PathBuf {
2487         let mut buf = self.to_path_buf();
2488         buf.set_file_name(file_name);
2489         buf
2490     }
2491
2492     /// Creates an owned [`PathBuf`] like `self` but with the given extension.
2493     ///
2494     /// See [`PathBuf::set_extension`] for more details.
2495     ///
2496     /// # Examples
2497     ///
2498     /// ```
2499     /// use std::path::{Path, PathBuf};
2500     ///
2501     /// let path = Path::new("foo.rs");
2502     /// assert_eq!(path.with_extension("txt"), PathBuf::from("foo.txt"));
2503     ///
2504     /// let path = Path::new("foo.tar.gz");
2505     /// assert_eq!(path.with_extension(""), PathBuf::from("foo.tar"));
2506     /// assert_eq!(path.with_extension("xz"), PathBuf::from("foo.tar.xz"));
2507     /// assert_eq!(path.with_extension("").with_extension("txt"), PathBuf::from("foo.txt"));
2508     /// ```
2509     #[stable(feature = "rust1", since = "1.0.0")]
2510     pub fn with_extension<S: AsRef<OsStr>>(&self, extension: S) -> PathBuf {
2511         self._with_extension(extension.as_ref())
2512     }
2513
2514     fn _with_extension(&self, extension: &OsStr) -> PathBuf {
2515         let mut buf = self.to_path_buf();
2516         buf.set_extension(extension);
2517         buf
2518     }
2519
2520     /// Produces an iterator over the [`Component`]s of the path.
2521     ///
2522     /// When parsing the path, there is a small amount of normalization:
2523     ///
2524     /// * Repeated separators are ignored, so `a/b` and `a//b` both have
2525     ///   `a` and `b` as components.
2526     ///
2527     /// * Occurrences of `.` are normalized away, except if they are at the
2528     ///   beginning of the path. For example, `a/./b`, `a/b/`, `a/b/.` and
2529     ///   `a/b` all have `a` and `b` as components, but `./a/b` starts with
2530     ///   an additional [`CurDir`] component.
2531     ///
2532     /// * A trailing slash is normalized away, `/a/b` and `/a/b/` are equivalent.
2533     ///
2534     /// Note that no other normalization takes place; in particular, `a/c`
2535     /// and `a/b/../c` are distinct, to account for the possibility that `b`
2536     /// is a symbolic link (so its parent isn't `a`).
2537     ///
2538     /// # Examples
2539     ///
2540     /// ```
2541     /// use std::path::{Path, Component};
2542     /// use std::ffi::OsStr;
2543     ///
2544     /// let mut components = Path::new("/tmp/foo.txt").components();
2545     ///
2546     /// assert_eq!(components.next(), Some(Component::RootDir));
2547     /// assert_eq!(components.next(), Some(Component::Normal(OsStr::new("tmp"))));
2548     /// assert_eq!(components.next(), Some(Component::Normal(OsStr::new("foo.txt"))));
2549     /// assert_eq!(components.next(), None)
2550     /// ```
2551     ///
2552     /// [`CurDir`]: Component::CurDir
2553     #[stable(feature = "rust1", since = "1.0.0")]
2554     pub fn components(&self) -> Components<'_> {
2555         let prefix = parse_prefix(self.as_os_str());
2556         Components {
2557             path: self.as_u8_slice(),
2558             prefix,
2559             has_physical_root: has_physical_root(self.as_u8_slice(), prefix)
2560                 || has_redox_scheme(self.as_u8_slice()),
2561             front: State::Prefix,
2562             back: State::Body,
2563         }
2564     }
2565
2566     /// Produces an iterator over the path's components viewed as [`OsStr`]
2567     /// slices.
2568     ///
2569     /// For more information about the particulars of how the path is separated
2570     /// into components, see [`components`].
2571     ///
2572     /// [`components`]: Path::components
2573     ///
2574     /// # Examples
2575     ///
2576     /// ```
2577     /// use std::path::{self, Path};
2578     /// use std::ffi::OsStr;
2579     ///
2580     /// let mut it = Path::new("/tmp/foo.txt").iter();
2581     /// assert_eq!(it.next(), Some(OsStr::new(&path::MAIN_SEPARATOR.to_string())));
2582     /// assert_eq!(it.next(), Some(OsStr::new("tmp")));
2583     /// assert_eq!(it.next(), Some(OsStr::new("foo.txt")));
2584     /// assert_eq!(it.next(), None)
2585     /// ```
2586     #[stable(feature = "rust1", since = "1.0.0")]
2587     #[inline]
2588     pub fn iter(&self) -> Iter<'_> {
2589         Iter { inner: self.components() }
2590     }
2591
2592     /// Returns an object that implements [`Display`] for safely printing paths
2593     /// that may contain non-Unicode data. This may perform lossy conversion,
2594     /// depending on the platform.  If you would like an implementation which
2595     /// escapes the path please use [`Debug`] instead.
2596     ///
2597     /// [`Display`]: fmt::Display
2598     ///
2599     /// # Examples
2600     ///
2601     /// ```
2602     /// use std::path::Path;
2603     ///
2604     /// let path = Path::new("/tmp/foo.rs");
2605     ///
2606     /// println!("{}", path.display());
2607     /// ```
2608     #[stable(feature = "rust1", since = "1.0.0")]
2609     #[must_use = "this does not display the path, \
2610                   it returns an object that can be displayed"]
2611     #[inline]
2612     pub fn display(&self) -> Display<'_> {
2613         Display { path: self }
2614     }
2615
2616     /// Queries the file system to get information about a file, directory, etc.
2617     ///
2618     /// This function will traverse symbolic links to query information about the
2619     /// destination file.
2620     ///
2621     /// This is an alias to [`fs::metadata`].
2622     ///
2623     /// # Examples
2624     ///
2625     /// ```no_run
2626     /// use std::path::Path;
2627     ///
2628     /// let path = Path::new("/Minas/tirith");
2629     /// let metadata = path.metadata().expect("metadata call failed");
2630     /// println!("{:?}", metadata.file_type());
2631     /// ```
2632     #[stable(feature = "path_ext", since = "1.5.0")]
2633     #[inline]
2634     pub fn metadata(&self) -> io::Result<fs::Metadata> {
2635         fs::metadata(self)
2636     }
2637
2638     /// Queries the metadata about a file without following symlinks.
2639     ///
2640     /// This is an alias to [`fs::symlink_metadata`].
2641     ///
2642     /// # Examples
2643     ///
2644     /// ```no_run
2645     /// use std::path::Path;
2646     ///
2647     /// let path = Path::new("/Minas/tirith");
2648     /// let metadata = path.symlink_metadata().expect("symlink_metadata call failed");
2649     /// println!("{:?}", metadata.file_type());
2650     /// ```
2651     #[stable(feature = "path_ext", since = "1.5.0")]
2652     #[inline]
2653     pub fn symlink_metadata(&self) -> io::Result<fs::Metadata> {
2654         fs::symlink_metadata(self)
2655     }
2656
2657     /// Returns the canonical, absolute form of the path with all intermediate
2658     /// components normalized and symbolic links resolved.
2659     ///
2660     /// This is an alias to [`fs::canonicalize`].
2661     ///
2662     /// # Examples
2663     ///
2664     /// ```no_run
2665     /// use std::path::{Path, PathBuf};
2666     ///
2667     /// let path = Path::new("/foo/test/../test/bar.rs");
2668     /// assert_eq!(path.canonicalize().unwrap(), PathBuf::from("/foo/test/bar.rs"));
2669     /// ```
2670     #[stable(feature = "path_ext", since = "1.5.0")]
2671     #[inline]
2672     pub fn canonicalize(&self) -> io::Result<PathBuf> {
2673         fs::canonicalize(self)
2674     }
2675
2676     /// Reads a symbolic link, returning the file that the link points to.
2677     ///
2678     /// This is an alias to [`fs::read_link`].
2679     ///
2680     /// # Examples
2681     ///
2682     /// ```no_run
2683     /// use std::path::Path;
2684     ///
2685     /// let path = Path::new("/laputa/sky_castle.rs");
2686     /// let path_link = path.read_link().expect("read_link call failed");
2687     /// ```
2688     #[stable(feature = "path_ext", since = "1.5.0")]
2689     #[inline]
2690     pub fn read_link(&self) -> io::Result<PathBuf> {
2691         fs::read_link(self)
2692     }
2693
2694     /// Returns an iterator over the entries within a directory.
2695     ///
2696     /// The iterator will yield instances of <code>[io::Result]<[fs::DirEntry]></code>. New
2697     /// errors may be encountered after an iterator is initially constructed.
2698     ///
2699     /// This is an alias to [`fs::read_dir`].
2700     ///
2701     /// # Examples
2702     ///
2703     /// ```no_run
2704     /// use std::path::Path;
2705     ///
2706     /// let path = Path::new("/laputa");
2707     /// for entry in path.read_dir().expect("read_dir call failed") {
2708     ///     if let Ok(entry) = entry {
2709     ///         println!("{:?}", entry.path());
2710     ///     }
2711     /// }
2712     /// ```
2713     #[stable(feature = "path_ext", since = "1.5.0")]
2714     #[inline]
2715     pub fn read_dir(&self) -> io::Result<fs::ReadDir> {
2716         fs::read_dir(self)
2717     }
2718
2719     /// Returns `true` if the path points at an existing entity.
2720     ///
2721     /// Warning: this method may be error-prone, consider using [`try_exists()`] instead!
2722     /// It also has a risk of introducing time-of-check to time-of-use (TOCTOU) bugs.
2723     ///
2724     /// This function will traverse symbolic links to query information about the
2725     /// destination file.
2726     ///
2727     /// If you cannot access the metadata of the file, e.g. because of a
2728     /// permission error or broken symbolic links, this will return `false`.
2729     ///
2730     /// # Examples
2731     ///
2732     /// ```no_run
2733     /// use std::path::Path;
2734     /// assert!(!Path::new("does_not_exist.txt").exists());
2735     /// ```
2736     ///
2737     /// # See Also
2738     ///
2739     /// This is a convenience function that coerces errors to false. If you want to
2740     /// check errors, call [`Path::try_exists`].
2741     ///
2742     /// [`try_exists()`]: Self::try_exists
2743     #[stable(feature = "path_ext", since = "1.5.0")]
2744     #[must_use]
2745     #[inline]
2746     pub fn exists(&self) -> bool {
2747         fs::metadata(self).is_ok()
2748     }
2749
2750     /// Returns `Ok(true)` if the path points at an existing entity.
2751     ///
2752     /// This function will traverse symbolic links to query information about the
2753     /// destination file. In case of broken symbolic links this will return `Ok(false)`.
2754     ///
2755     /// As opposed to the [`exists()`] method, this one doesn't silently ignore errors
2756     /// unrelated to the path not existing. (E.g. it will return `Err(_)` in case of permission
2757     /// denied on some of the parent directories.)
2758     ///
2759     /// Note that while this avoids some pitfalls of the `exists()` method, it still can not
2760     /// prevent time-of-check to time-of-use (TOCTOU) bugs. You should only use it in scenarios
2761     /// where those bugs are not an issue.
2762     ///
2763     /// # Examples
2764     ///
2765     /// ```no_run
2766     /// use std::path::Path;
2767     /// assert!(!Path::new("does_not_exist.txt").try_exists().expect("Can't check existence of file does_not_exist.txt"));
2768     /// assert!(Path::new("/root/secret_file.txt").try_exists().is_err());
2769     /// ```
2770     ///
2771     /// [`exists()`]: Self::exists
2772     #[stable(feature = "path_try_exists", since = "1.63.0")]
2773     #[inline]
2774     pub fn try_exists(&self) -> io::Result<bool> {
2775         fs::try_exists(self)
2776     }
2777
2778     /// Returns `true` if the path exists on disk and is pointing at a regular file.
2779     ///
2780     /// This function will traverse symbolic links to query information about the
2781     /// destination file.
2782     ///
2783     /// If you cannot access the metadata of the file, e.g. because of a
2784     /// permission error or broken symbolic links, this will return `false`.
2785     ///
2786     /// # Examples
2787     ///
2788     /// ```no_run
2789     /// use std::path::Path;
2790     /// assert_eq!(Path::new("./is_a_directory/").is_file(), false);
2791     /// assert_eq!(Path::new("a_file.txt").is_file(), true);
2792     /// ```
2793     ///
2794     /// # See Also
2795     ///
2796     /// This is a convenience function that coerces errors to false. If you want to
2797     /// check errors, call [`fs::metadata`] and handle its [`Result`]. Then call
2798     /// [`fs::Metadata::is_file`] if it was [`Ok`].
2799     ///
2800     /// When the goal is simply to read from (or write to) the source, the most
2801     /// reliable way to test the source can be read (or written to) is to open
2802     /// it. Only using `is_file` can break workflows like `diff <( prog_a )` on
2803     /// a Unix-like system for example. See [`fs::File::open`] or
2804     /// [`fs::OpenOptions::open`] for more information.
2805     #[stable(feature = "path_ext", since = "1.5.0")]
2806     #[must_use]
2807     pub fn is_file(&self) -> bool {
2808         fs::metadata(self).map(|m| m.is_file()).unwrap_or(false)
2809     }
2810
2811     /// Returns `true` if the path exists on disk and is pointing at a directory.
2812     ///
2813     /// This function will traverse symbolic links to query information about the
2814     /// destination file.
2815     ///
2816     /// If you cannot access the metadata of the file, e.g. because of a
2817     /// permission error or broken symbolic links, this will return `false`.
2818     ///
2819     /// # Examples
2820     ///
2821     /// ```no_run
2822     /// use std::path::Path;
2823     /// assert_eq!(Path::new("./is_a_directory/").is_dir(), true);
2824     /// assert_eq!(Path::new("a_file.txt").is_dir(), false);
2825     /// ```
2826     ///
2827     /// # See Also
2828     ///
2829     /// This is a convenience function that coerces errors to false. If you want to
2830     /// check errors, call [`fs::metadata`] and handle its [`Result`]. Then call
2831     /// [`fs::Metadata::is_dir`] if it was [`Ok`].
2832     #[stable(feature = "path_ext", since = "1.5.0")]
2833     #[must_use]
2834     pub fn is_dir(&self) -> bool {
2835         fs::metadata(self).map(|m| m.is_dir()).unwrap_or(false)
2836     }
2837
2838     /// Returns `true` if the path exists on disk and is pointing at a symbolic link.
2839     ///
2840     /// This function will not traverse symbolic links.
2841     /// In case of a broken symbolic link this will also return true.
2842     ///
2843     /// If you cannot access the directory containing the file, e.g., because of a
2844     /// permission error, this will return false.
2845     ///
2846     /// # Examples
2847     ///
2848     #[cfg_attr(unix, doc = "```no_run")]
2849     #[cfg_attr(not(unix), doc = "```ignore")]
2850     /// use std::path::Path;
2851     /// use std::os::unix::fs::symlink;
2852     ///
2853     /// let link_path = Path::new("link");
2854     /// symlink("/origin_does_not_exist/", link_path).unwrap();
2855     /// assert_eq!(link_path.is_symlink(), true);
2856     /// assert_eq!(link_path.exists(), false);
2857     /// ```
2858     ///
2859     /// # See Also
2860     ///
2861     /// This is a convenience function that coerces errors to false. If you want to
2862     /// check errors, call [`fs::symlink_metadata`] and handle its [`Result`]. Then call
2863     /// [`fs::Metadata::is_symlink`] if it was [`Ok`].
2864     #[must_use]
2865     #[stable(feature = "is_symlink", since = "1.58.0")]
2866     pub fn is_symlink(&self) -> bool {
2867         fs::symlink_metadata(self).map(|m| m.is_symlink()).unwrap_or(false)
2868     }
2869
2870     /// Converts a [`Box<Path>`](Box) into a [`PathBuf`] without copying or
2871     /// allocating.
2872     #[stable(feature = "into_boxed_path", since = "1.20.0")]
2873     #[must_use = "`self` will be dropped if the result is not used"]
2874     pub fn into_path_buf(self: Box<Path>) -> PathBuf {
2875         let rw = Box::into_raw(self) as *mut OsStr;
2876         let inner = unsafe { Box::from_raw(rw) };
2877         PathBuf { inner: OsString::from(inner) }
2878     }
2879 }
2880
2881 #[stable(feature = "rust1", since = "1.0.0")]
2882 impl AsRef<OsStr> for Path {
2883     #[inline]
2884     fn as_ref(&self) -> &OsStr {
2885         &self.inner
2886     }
2887 }
2888
2889 #[stable(feature = "rust1", since = "1.0.0")]
2890 impl fmt::Debug for Path {
2891     fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
2892         fmt::Debug::fmt(&self.inner, formatter)
2893     }
2894 }
2895
2896 /// Helper struct for safely printing paths with [`format!`] and `{}`.
2897 ///
2898 /// A [`Path`] might contain non-Unicode data. This `struct` implements the
2899 /// [`Display`] trait in a way that mitigates that. It is created by the
2900 /// [`display`](Path::display) method on [`Path`]. This may perform lossy
2901 /// conversion, depending on the platform. If you would like an implementation
2902 /// which escapes the path please use [`Debug`] instead.
2903 ///
2904 /// # Examples
2905 ///
2906 /// ```
2907 /// use std::path::Path;
2908 ///
2909 /// let path = Path::new("/tmp/foo.rs");
2910 ///
2911 /// println!("{}", path.display());
2912 /// ```
2913 ///
2914 /// [`Display`]: fmt::Display
2915 /// [`format!`]: crate::format
2916 #[stable(feature = "rust1", since = "1.0.0")]
2917 pub struct Display<'a> {
2918     path: &'a Path,
2919 }
2920
2921 #[stable(feature = "rust1", since = "1.0.0")]
2922 impl fmt::Debug for Display<'_> {
2923     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2924         fmt::Debug::fmt(&self.path, f)
2925     }
2926 }
2927
2928 #[stable(feature = "rust1", since = "1.0.0")]
2929 impl fmt::Display for Display<'_> {
2930     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2931         self.path.inner.display(f)
2932     }
2933 }
2934
2935 #[stable(feature = "rust1", since = "1.0.0")]
2936 impl cmp::PartialEq for Path {
2937     #[inline]
2938     fn eq(&self, other: &Path) -> bool {
2939         self.components() == other.components()
2940     }
2941 }
2942
2943 #[stable(feature = "rust1", since = "1.0.0")]
2944 impl Hash for Path {
2945     fn hash<H: Hasher>(&self, h: &mut H) {
2946         let bytes = self.as_u8_slice();
2947         let (prefix_len, verbatim) = match parse_prefix(&self.inner) {
2948             Some(prefix) => {
2949                 prefix.hash(h);
2950                 (prefix.len(), prefix.is_verbatim())
2951             }
2952             None => (0, false),
2953         };
2954         let bytes = &bytes[prefix_len..];
2955
2956         let mut component_start = 0;
2957         let mut bytes_hashed = 0;
2958
2959         for i in 0..bytes.len() {
2960             let is_sep = if verbatim { is_verbatim_sep(bytes[i]) } else { is_sep_byte(bytes[i]) };
2961             if is_sep {
2962                 if i > component_start {
2963                     let to_hash = &bytes[component_start..i];
2964                     h.write(to_hash);
2965                     bytes_hashed += to_hash.len();
2966                 }
2967
2968                 // skip over separator and optionally a following CurDir item
2969                 // since components() would normalize these away.
2970                 component_start = i + 1;
2971
2972                 let tail = &bytes[component_start..];
2973
2974                 if !verbatim {
2975                     component_start += match tail {
2976                         [b'.'] => 1,
2977                         [b'.', sep @ _, ..] if is_sep_byte(*sep) => 1,
2978                         _ => 0,
2979                     };
2980                 }
2981             }
2982         }
2983
2984         if component_start < bytes.len() {
2985             let to_hash = &bytes[component_start..];
2986             h.write(to_hash);
2987             bytes_hashed += to_hash.len();
2988         }
2989
2990         h.write_usize(bytes_hashed);
2991     }
2992 }
2993
2994 #[stable(feature = "rust1", since = "1.0.0")]
2995 impl cmp::Eq for Path {}
2996
2997 #[stable(feature = "rust1", since = "1.0.0")]
2998 impl cmp::PartialOrd for Path {
2999     #[inline]
3000     fn partial_cmp(&self, other: &Path) -> Option<cmp::Ordering> {
3001         Some(compare_components(self.components(), other.components()))
3002     }
3003 }
3004
3005 #[stable(feature = "rust1", since = "1.0.0")]
3006 impl cmp::Ord for Path {
3007     #[inline]
3008     fn cmp(&self, other: &Path) -> cmp::Ordering {
3009         compare_components(self.components(), other.components())
3010     }
3011 }
3012
3013 #[stable(feature = "rust1", since = "1.0.0")]
3014 impl AsRef<Path> for Path {
3015     #[inline]
3016     fn as_ref(&self) -> &Path {
3017         self
3018     }
3019 }
3020
3021 #[stable(feature = "rust1", since = "1.0.0")]
3022 impl AsRef<Path> for OsStr {
3023     #[inline]
3024     fn as_ref(&self) -> &Path {
3025         Path::new(self)
3026     }
3027 }
3028
3029 #[stable(feature = "cow_os_str_as_ref_path", since = "1.8.0")]
3030 impl AsRef<Path> for Cow<'_, OsStr> {
3031     #[inline]
3032     fn as_ref(&self) -> &Path {
3033         Path::new(self)
3034     }
3035 }
3036
3037 #[stable(feature = "rust1", since = "1.0.0")]
3038 impl AsRef<Path> for OsString {
3039     #[inline]
3040     fn as_ref(&self) -> &Path {
3041         Path::new(self)
3042     }
3043 }
3044
3045 #[stable(feature = "rust1", since = "1.0.0")]
3046 impl AsRef<Path> for str {
3047     #[inline]
3048     fn as_ref(&self) -> &Path {
3049         Path::new(self)
3050     }
3051 }
3052
3053 #[stable(feature = "rust1", since = "1.0.0")]
3054 impl AsRef<Path> for String {
3055     #[inline]
3056     fn as_ref(&self) -> &Path {
3057         Path::new(self)
3058     }
3059 }
3060
3061 #[stable(feature = "rust1", since = "1.0.0")]
3062 impl AsRef<Path> for PathBuf {
3063     #[inline]
3064     fn as_ref(&self) -> &Path {
3065         self
3066     }
3067 }
3068
3069 #[stable(feature = "path_into_iter", since = "1.6.0")]
3070 impl<'a> IntoIterator for &'a PathBuf {
3071     type Item = &'a OsStr;
3072     type IntoIter = Iter<'a>;
3073     #[inline]
3074     fn into_iter(self) -> Iter<'a> {
3075         self.iter()
3076     }
3077 }
3078
3079 #[stable(feature = "path_into_iter", since = "1.6.0")]
3080 impl<'a> IntoIterator for &'a Path {
3081     type Item = &'a OsStr;
3082     type IntoIter = Iter<'a>;
3083     #[inline]
3084     fn into_iter(self) -> Iter<'a> {
3085         self.iter()
3086     }
3087 }
3088
3089 macro_rules! impl_cmp {
3090     ($lhs:ty, $rhs: ty) => {
3091         #[stable(feature = "partialeq_path", since = "1.6.0")]
3092         impl<'a, 'b> PartialEq<$rhs> for $lhs {
3093             #[inline]
3094             fn eq(&self, other: &$rhs) -> bool {
3095                 <Path as PartialEq>::eq(self, other)
3096             }
3097         }
3098
3099         #[stable(feature = "partialeq_path", since = "1.6.0")]
3100         impl<'a, 'b> PartialEq<$lhs> for $rhs {
3101             #[inline]
3102             fn eq(&self, other: &$lhs) -> bool {
3103                 <Path as PartialEq>::eq(self, other)
3104             }
3105         }
3106
3107         #[stable(feature = "cmp_path", since = "1.8.0")]
3108         impl<'a, 'b> PartialOrd<$rhs> for $lhs {
3109             #[inline]
3110             fn partial_cmp(&self, other: &$rhs) -> Option<cmp::Ordering> {
3111                 <Path as PartialOrd>::partial_cmp(self, other)
3112             }
3113         }
3114
3115         #[stable(feature = "cmp_path", since = "1.8.0")]
3116         impl<'a, 'b> PartialOrd<$lhs> for $rhs {
3117             #[inline]
3118             fn partial_cmp(&self, other: &$lhs) -> Option<cmp::Ordering> {
3119                 <Path as PartialOrd>::partial_cmp(self, other)
3120             }
3121         }
3122     };
3123 }
3124
3125 impl_cmp!(PathBuf, Path);
3126 impl_cmp!(PathBuf, &'a Path);
3127 impl_cmp!(Cow<'a, Path>, Path);
3128 impl_cmp!(Cow<'a, Path>, &'b Path);
3129 impl_cmp!(Cow<'a, Path>, PathBuf);
3130
3131 macro_rules! impl_cmp_os_str {
3132     ($lhs:ty, $rhs: ty) => {
3133         #[stable(feature = "cmp_path", since = "1.8.0")]
3134         impl<'a, 'b> PartialEq<$rhs> for $lhs {
3135             #[inline]
3136             fn eq(&self, other: &$rhs) -> bool {
3137                 <Path as PartialEq>::eq(self, other.as_ref())
3138             }
3139         }
3140
3141         #[stable(feature = "cmp_path", since = "1.8.0")]
3142         impl<'a, 'b> PartialEq<$lhs> for $rhs {
3143             #[inline]
3144             fn eq(&self, other: &$lhs) -> bool {
3145                 <Path as PartialEq>::eq(self.as_ref(), other)
3146             }
3147         }
3148
3149         #[stable(feature = "cmp_path", since = "1.8.0")]
3150         impl<'a, 'b> PartialOrd<$rhs> for $lhs {
3151             #[inline]
3152             fn partial_cmp(&self, other: &$rhs) -> Option<cmp::Ordering> {
3153                 <Path as PartialOrd>::partial_cmp(self, other.as_ref())
3154             }
3155         }
3156
3157         #[stable(feature = "cmp_path", since = "1.8.0")]
3158         impl<'a, 'b> PartialOrd<$lhs> for $rhs {
3159             #[inline]
3160             fn partial_cmp(&self, other: &$lhs) -> Option<cmp::Ordering> {
3161                 <Path as PartialOrd>::partial_cmp(self.as_ref(), other)
3162             }
3163         }
3164     };
3165 }
3166
3167 impl_cmp_os_str!(PathBuf, OsStr);
3168 impl_cmp_os_str!(PathBuf, &'a OsStr);
3169 impl_cmp_os_str!(PathBuf, Cow<'a, OsStr>);
3170 impl_cmp_os_str!(PathBuf, OsString);
3171 impl_cmp_os_str!(Path, OsStr);
3172 impl_cmp_os_str!(Path, &'a OsStr);
3173 impl_cmp_os_str!(Path, Cow<'a, OsStr>);
3174 impl_cmp_os_str!(Path, OsString);
3175 impl_cmp_os_str!(&'a Path, OsStr);
3176 impl_cmp_os_str!(&'a Path, Cow<'b, OsStr>);
3177 impl_cmp_os_str!(&'a Path, OsString);
3178 impl_cmp_os_str!(Cow<'a, Path>, OsStr);
3179 impl_cmp_os_str!(Cow<'a, Path>, &'b OsStr);
3180 impl_cmp_os_str!(Cow<'a, Path>, OsString);
3181
3182 #[stable(since = "1.7.0", feature = "strip_prefix")]
3183 impl fmt::Display for StripPrefixError {
3184     #[allow(deprecated, deprecated_in_future)]
3185     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
3186         self.description().fmt(f)
3187     }
3188 }
3189
3190 #[stable(since = "1.7.0", feature = "strip_prefix")]
3191 impl Error for StripPrefixError {
3192     #[allow(deprecated)]
3193     fn description(&self) -> &str {
3194         "prefix not found"
3195     }
3196 }
3197
3198 /// Makes the path absolute without accessing the filesystem.
3199 ///
3200 /// If the path is relative, the current directory is used as the base directory.
3201 /// All intermediate components will be resolved according to platforms-specific
3202 /// rules but unlike [`canonicalize`][crate::fs::canonicalize] this does not
3203 /// resolve symlinks and may succeed even if the path does not exist.
3204 ///
3205 /// If the `path` is empty or getting the
3206 /// [current directory][crate::env::current_dir] fails then an error will be
3207 /// returned.
3208 ///
3209 /// # Examples
3210 ///
3211 /// ## Posix paths
3212 ///
3213 /// ```
3214 /// #![feature(absolute_path)]
3215 /// # #[cfg(unix)]
3216 /// fn main() -> std::io::Result<()> {
3217 ///   use std::path::{self, Path};
3218 ///
3219 ///   // Relative to absolute
3220 ///   let absolute = path::absolute("foo/./bar")?;
3221 ///   assert!(absolute.ends_with("foo/bar"));
3222 ///
3223 ///   // Absolute to absolute
3224 ///   let absolute = path::absolute("/foo//test/.././bar.rs")?;
3225 ///   assert_eq!(absolute, Path::new("/foo/test/../bar.rs"));
3226 ///   Ok(())
3227 /// }
3228 /// # #[cfg(not(unix))]
3229 /// # fn main() {}
3230 /// ```
3231 ///
3232 /// The path is resolved using [POSIX semantics][posix-semantics] except that
3233 /// it stops short of resolving symlinks. This means it will keep `..`
3234 /// components and trailing slashes.
3235 ///
3236 /// ## Windows paths
3237 ///
3238 /// ```
3239 /// #![feature(absolute_path)]
3240 /// # #[cfg(windows)]
3241 /// fn main() -> std::io::Result<()> {
3242 ///   use std::path::{self, Path};
3243 ///
3244 ///   // Relative to absolute
3245 ///   let absolute = path::absolute("foo/./bar")?;
3246 ///   assert!(absolute.ends_with(r"foo\bar"));
3247 ///
3248 ///   // Absolute to absolute
3249 ///   let absolute = path::absolute(r"C:\foo//test\..\./bar.rs")?;
3250 ///
3251 ///   assert_eq!(absolute, Path::new(r"C:\foo\bar.rs"));
3252 ///   Ok(())
3253 /// }
3254 /// # #[cfg(not(windows))]
3255 /// # fn main() {}
3256 /// ```
3257 ///
3258 /// For verbatim paths this will simply return the path as given. For other
3259 /// paths this is currently equivalent to calling [`GetFullPathNameW`][windows-path]
3260 /// This may change in the future.
3261 ///
3262 /// [posix-semantics]: https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap04.html#tag_04_13
3263 /// [windows-path]: https://docs.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-getfullpathnamew
3264 #[unstable(feature = "absolute_path", issue = "92750")]
3265 pub fn absolute<P: AsRef<Path>>(path: P) -> io::Result<PathBuf> {
3266     let path = path.as_ref();
3267     if path.as_os_str().is_empty() {
3268         Err(io::const_io_error!(io::ErrorKind::InvalidInput, "cannot make an empty path absolute",))
3269     } else {
3270         sys::path::absolute(path)
3271     }
3272 }