1 //! Cross-platform path manipulation.
3 //! This module provides two types, [`PathBuf`] and [`Path`] (akin to [`String`]
4 //! and [`str`]), for working with paths abstractly. These types are thin wrappers
5 //! around [`OsString`] and [`OsStr`] respectively, meaning that they work directly
6 //! on strings according to the local platform's path syntax.
8 //! Paths can be parsed into [`Component`]s by iterating over the structure
9 //! returned by the [`components`] method on [`Path`]. [`Component`]s roughly
10 //! correspond to the substrings between path separators (`/` or `\`). You can
11 //! reconstruct an equivalent path from components with the [`push`] method on
12 //! [`PathBuf`]; note that the paths may differ syntactically by the
13 //! normalization described in the documentation for the [`components`] method.
17 //! Path manipulation includes both parsing components from slices and building
20 //! To parse a path, you can create a [`Path`] slice from a [`str`]
21 //! slice and start asking questions:
24 //! use std::path::Path;
25 //! use std::ffi::OsStr;
27 //! let path = Path::new("/tmp/foo/bar.txt");
29 //! let parent = path.parent();
30 //! assert_eq!(parent, Some(Path::new("/tmp/foo")));
32 //! let file_stem = path.file_stem();
33 //! assert_eq!(file_stem, Some(OsStr::new("bar")));
35 //! let extension = path.extension();
36 //! assert_eq!(extension, Some(OsStr::new("txt")));
39 //! To build or modify paths, use [`PathBuf`]:
42 //! use std::path::PathBuf;
44 //! // This way works...
45 //! let mut path = PathBuf::from("c:\\");
47 //! path.push("windows");
48 //! path.push("system32");
50 //! path.set_extension("dll");
52 //! // ... but push is best used if you don't know everything up
53 //! // front. If you do, this way is better:
54 //! let path: PathBuf = ["c:\\", "windows", "system32.dll"].iter().collect();
57 //! [`components`]: Path::components
58 //! [`push`]: PathBuf::push
60 #![stable(feature = "rust1", since = "1.0.0")]
61 #![deny(unsafe_op_in_unsafe_fn)]
66 use crate::borrow::{Borrow, Cow};
68 use crate::error::Error;
71 use crate::hash::{Hash, Hasher};
73 use crate::iter::{self, FusedIterator};
74 use crate::ops::{self, Deref};
76 use crate::str::FromStr;
79 use crate::ffi::{OsStr, OsString};
81 use crate::sys::path::{is_sep_byte, is_verbatim_sep, parse_prefix, MAIN_SEP_STR};
83 ////////////////////////////////////////////////////////////////////////////////
85 ////////////////////////////////////////////////////////////////////////////////
87 // Parsing in this module is done by directly transmuting OsStr to [u8] slices,
88 // taking advantage of the fact that OsStr always encodes ASCII characters
89 // as-is. Eventually, this transmutation should be replaced by direct uses of
90 // OsStr APIs for parsing, but it will take a while for those to become
93 ////////////////////////////////////////////////////////////////////////////////
95 ////////////////////////////////////////////////////////////////////////////////
97 /// Windows path prefixes, e.g., `C:` or `\\server\share`.
99 /// Windows uses a variety of path prefix styles, including references to drive
100 /// volumes (like `C:`), network shared folders (like `\\server\share`), and
101 /// others. In addition, some path prefixes are "verbatim" (i.e., prefixed with
102 /// `\\?\`), in which case `/` is *not* treated as a separator and essentially
103 /// no normalization is performed.
108 /// use std::path::{Component, Path, Prefix};
109 /// use std::path::Prefix::*;
110 /// use std::ffi::OsStr;
112 /// fn get_path_prefix(s: &str) -> Prefix {
113 /// let path = Path::new(s);
114 /// match path.components().next().unwrap() {
115 /// Component::Prefix(prefix_component) => prefix_component.kind(),
120 /// # if cfg!(windows) {
121 /// assert_eq!(Verbatim(OsStr::new("pictures")),
122 /// get_path_prefix(r"\\?\pictures\kittens"));
123 /// assert_eq!(VerbatimUNC(OsStr::new("server"), OsStr::new("share")),
124 /// get_path_prefix(r"\\?\UNC\server\share"));
125 /// assert_eq!(VerbatimDisk(b'C'), get_path_prefix(r"\\?\c:\"));
126 /// assert_eq!(DeviceNS(OsStr::new("BrainInterface")),
127 /// get_path_prefix(r"\\.\BrainInterface"));
128 /// assert_eq!(UNC(OsStr::new("server"), OsStr::new("share")),
129 /// get_path_prefix(r"\\server\share"));
130 /// assert_eq!(Disk(b'C'), get_path_prefix(r"C:\Users\Rust\Pictures\Ferris"));
133 #[derive(Copy, Clone, Debug, Hash, PartialOrd, Ord, PartialEq, Eq)]
134 #[stable(feature = "rust1", since = "1.0.0")]
135 pub enum Prefix<'a> {
136 /// Verbatim prefix, e.g., `\\?\cat_pics`.
138 /// Verbatim prefixes consist of `\\?\` immediately followed by the given
140 #[stable(feature = "rust1", since = "1.0.0")]
141 Verbatim(#[stable(feature = "rust1", since = "1.0.0")] &'a OsStr),
143 /// Verbatim prefix using Windows' _**U**niform **N**aming **C**onvention_,
144 /// e.g., `\\?\UNC\server\share`.
146 /// Verbatim UNC prefixes consist of `\\?\UNC\` immediately followed by the
147 /// server's hostname and a share name.
148 #[stable(feature = "rust1", since = "1.0.0")]
150 #[stable(feature = "rust1", since = "1.0.0")] &'a OsStr,
151 #[stable(feature = "rust1", since = "1.0.0")] &'a OsStr,
154 /// Verbatim disk prefix, e.g., `\\?\C:`.
156 /// Verbatim disk prefixes consist of `\\?\` immediately followed by the
157 /// drive letter and `:`.
158 #[stable(feature = "rust1", since = "1.0.0")]
159 VerbatimDisk(#[stable(feature = "rust1", since = "1.0.0")] u8),
161 /// Device namespace prefix, e.g., `\\.\COM42`.
163 /// Device namespace prefixes consist of `\\.\` immediately followed by the
165 #[stable(feature = "rust1", since = "1.0.0")]
166 DeviceNS(#[stable(feature = "rust1", since = "1.0.0")] &'a OsStr),
168 /// Prefix using Windows' _**U**niform **N**aming **C**onvention_, e.g.
169 /// `\\server\share`.
171 /// UNC prefixes consist of the server's hostname and a share name.
172 #[stable(feature = "rust1", since = "1.0.0")]
174 #[stable(feature = "rust1", since = "1.0.0")] &'a OsStr,
175 #[stable(feature = "rust1", since = "1.0.0")] &'a OsStr,
178 /// Prefix `C:` for the given disk drive.
179 #[stable(feature = "rust1", since = "1.0.0")]
180 Disk(#[stable(feature = "rust1", since = "1.0.0")] u8),
183 impl<'a> Prefix<'a> {
185 fn len(&self) -> usize {
187 fn os_str_len(s: &OsStr) -> usize {
188 os_str_as_u8_slice(s).len()
191 Verbatim(x) => 4 + os_str_len(x),
192 VerbatimUNC(x, y) => {
193 8 + os_str_len(x) + if os_str_len(y) > 0 { 1 + os_str_len(y) } else { 0 }
195 VerbatimDisk(_) => 6,
196 UNC(x, y) => 2 + os_str_len(x) + if os_str_len(y) > 0 { 1 + os_str_len(y) } else { 0 },
197 DeviceNS(x) => 4 + os_str_len(x),
202 /// Determines if the prefix is verbatim, i.e., begins with `\\?\`.
207 /// use std::path::Prefix::*;
208 /// use std::ffi::OsStr;
210 /// assert!(Verbatim(OsStr::new("pictures")).is_verbatim());
211 /// assert!(VerbatimUNC(OsStr::new("server"), OsStr::new("share")).is_verbatim());
212 /// assert!(VerbatimDisk(b'C').is_verbatim());
213 /// assert!(!DeviceNS(OsStr::new("BrainInterface")).is_verbatim());
214 /// assert!(!UNC(OsStr::new("server"), OsStr::new("share")).is_verbatim());
215 /// assert!(!Disk(b'C').is_verbatim());
219 #[stable(feature = "rust1", since = "1.0.0")]
220 pub fn is_verbatim(&self) -> bool {
222 matches!(*self, Verbatim(_) | VerbatimDisk(_) | VerbatimUNC(..))
226 fn is_drive(&self) -> bool {
227 matches!(*self, Prefix::Disk(_))
231 fn has_implicit_root(&self) -> bool {
236 ////////////////////////////////////////////////////////////////////////////////
237 // Exposed parsing helpers
238 ////////////////////////////////////////////////////////////////////////////////
240 /// Determines whether the character is one of the permitted path
241 /// separators for the current platform.
248 /// assert!(path::is_separator('/')); // '/' works for both Unix and Windows
249 /// assert!(!path::is_separator('❤'));
252 #[stable(feature = "rust1", since = "1.0.0")]
253 pub fn is_separator(c: char) -> bool {
254 c.is_ascii() && is_sep_byte(c as u8)
257 /// The primary separator of path components for the current platform.
259 /// For example, `/` on Unix and `\` on Windows.
260 #[stable(feature = "rust1", since = "1.0.0")]
261 pub const MAIN_SEPARATOR: char = crate::sys::path::MAIN_SEP;
263 ////////////////////////////////////////////////////////////////////////////////
265 ////////////////////////////////////////////////////////////////////////////////
267 // Iterate through `iter` while it matches `prefix`; return `None` if `prefix`
268 // is not a prefix of `iter`, otherwise return `Some(iter_after_prefix)` giving
269 // `iter` after having exhausted `prefix`.
270 fn iter_after<'a, 'b, I, J>(mut iter: I, mut prefix: J) -> Option<I>
272 I: Iterator<Item = Component<'a>> + Clone,
273 J: Iterator<Item = Component<'b>>,
276 let mut iter_next = iter.clone();
277 match (iter_next.next(), prefix.next()) {
278 (Some(ref x), Some(ref y)) if x == y => (),
279 (Some(_), Some(_)) => return None,
280 (Some(_), None) => return Some(iter),
281 (None, None) => return Some(iter),
282 (None, Some(_)) => return None,
288 // See note at the top of this module to understand why these are used:
290 // These casts are safe as OsStr is internally a wrapper around [u8] on all
293 // Note that currently this relies on the special knowledge that libstd has;
294 // these types are single-element structs but are not marked repr(transparent)
295 // or repr(C) which would make these casts allowable outside std.
296 fn os_str_as_u8_slice(s: &OsStr) -> &[u8] {
297 unsafe { &*(s as *const OsStr as *const [u8]) }
299 unsafe fn u8_slice_as_os_str(s: &[u8]) -> &OsStr {
300 // SAFETY: see the comment of `os_str_as_u8_slice`
301 unsafe { &*(s as *const [u8] as *const OsStr) }
304 // Detect scheme on Redox
305 fn has_redox_scheme(s: &[u8]) -> bool {
306 cfg!(target_os = "redox") && s.contains(&b':')
309 ////////////////////////////////////////////////////////////////////////////////
310 // Cross-platform, iterator-independent parsing
311 ////////////////////////////////////////////////////////////////////////////////
313 /// Says whether the first byte after the prefix is a separator.
314 fn has_physical_root(s: &[u8], prefix: Option<Prefix<'_>>) -> bool {
315 let path = if let Some(p) = prefix { &s[p.len()..] } else { s };
316 !path.is_empty() && is_sep_byte(path[0])
319 // basic workhorse for splitting stem and extension
320 fn rsplit_file_at_dot(file: &OsStr) -> (Option<&OsStr>, Option<&OsStr>) {
321 if os_str_as_u8_slice(file) == b".." {
322 return (Some(file), None);
325 // The unsafety here stems from converting between &OsStr and &[u8]
326 // and back. This is safe to do because (1) we only look at ASCII
327 // contents of the encoding and (2) new &OsStr values are produced
328 // only from ASCII-bounded slices of existing &OsStr values.
329 let mut iter = os_str_as_u8_slice(file).rsplitn(2, |b| *b == b'.');
330 let after = iter.next();
331 let before = iter.next();
332 if before == Some(b"") {
335 unsafe { (before.map(|s| u8_slice_as_os_str(s)), after.map(|s| u8_slice_as_os_str(s))) }
339 fn split_file_at_dot(file: &OsStr) -> (&OsStr, Option<&OsStr>) {
340 let slice = os_str_as_u8_slice(file);
345 // The unsafety here stems from converting between &OsStr and &[u8]
346 // and back. This is safe to do because (1) we only look at ASCII
347 // contents of the encoding and (2) new &OsStr values are produced
348 // only from ASCII-bounded slices of existing &OsStr values.
349 let i = match slice[1..].iter().position(|b| *b == b'.') {
351 None => return (file, None),
353 let before = &slice[..i];
354 let after = &slice[i + 1..];
355 unsafe { (u8_slice_as_os_str(before), Some(u8_slice_as_os_str(after))) }
358 ////////////////////////////////////////////////////////////////////////////////
359 // The core iterators
360 ////////////////////////////////////////////////////////////////////////////////
362 /// Component parsing works by a double-ended state machine; the cursors at the
363 /// front and back of the path each keep track of what parts of the path have
364 /// been consumed so far.
366 /// Going front to back, a path is made up of a prefix, a starting
367 /// directory component, and a body (of normal components)
368 #[derive(Copy, Clone, PartialEq, PartialOrd, Debug)]
371 StartDir = 1, // / or . or nothing
372 Body = 2, // foo/bar/baz
376 /// A structure wrapping a Windows path prefix as well as its unparsed string
379 /// In addition to the parsed [`Prefix`] information returned by [`kind`],
380 /// `PrefixComponent` also holds the raw and unparsed [`OsStr`] slice,
381 /// returned by [`as_os_str`].
383 /// Instances of this `struct` can be obtained by matching against the
384 /// [`Prefix` variant] on [`Component`].
386 /// Does not occur on Unix.
391 /// # if cfg!(windows) {
392 /// use std::path::{Component, Path, Prefix};
393 /// use std::ffi::OsStr;
395 /// let path = Path::new(r"c:\you\later\");
396 /// match path.components().next().unwrap() {
397 /// Component::Prefix(prefix_component) => {
398 /// assert_eq!(Prefix::Disk(b'C'), prefix_component.kind());
399 /// assert_eq!(OsStr::new("c:"), prefix_component.as_os_str());
401 /// _ => unreachable!(),
406 /// [`as_os_str`]: PrefixComponent::as_os_str
407 /// [`kind`]: PrefixComponent::kind
408 /// [`Prefix` variant]: Component::Prefix
409 #[stable(feature = "rust1", since = "1.0.0")]
410 #[derive(Copy, Clone, Eq, Debug)]
411 pub struct PrefixComponent<'a> {
412 /// The prefix as an unparsed `OsStr` slice.
415 /// The parsed prefix data.
419 impl<'a> PrefixComponent<'a> {
420 /// Returns the parsed prefix data.
422 /// See [`Prefix`]'s documentation for more information on the different
423 /// kinds of prefixes.
424 #[stable(feature = "rust1", since = "1.0.0")]
427 pub fn kind(&self) -> Prefix<'a> {
431 /// Returns the raw [`OsStr`] slice for this prefix.
432 #[stable(feature = "rust1", since = "1.0.0")]
435 pub fn as_os_str(&self) -> &'a OsStr {
440 #[stable(feature = "rust1", since = "1.0.0")]
441 impl<'a> cmp::PartialEq for PrefixComponent<'a> {
443 fn eq(&self, other: &PrefixComponent<'a>) -> bool {
444 cmp::PartialEq::eq(&self.parsed, &other.parsed)
448 #[stable(feature = "rust1", since = "1.0.0")]
449 impl<'a> cmp::PartialOrd for PrefixComponent<'a> {
451 fn partial_cmp(&self, other: &PrefixComponent<'a>) -> Option<cmp::Ordering> {
452 cmp::PartialOrd::partial_cmp(&self.parsed, &other.parsed)
456 #[stable(feature = "rust1", since = "1.0.0")]
457 impl cmp::Ord for PrefixComponent<'_> {
459 fn cmp(&self, other: &Self) -> cmp::Ordering {
460 cmp::Ord::cmp(&self.parsed, &other.parsed)
464 #[stable(feature = "rust1", since = "1.0.0")]
465 impl Hash for PrefixComponent<'_> {
466 fn hash<H: Hasher>(&self, h: &mut H) {
471 /// A single component of a path.
473 /// A `Component` roughly corresponds to a substring between path separators
476 /// This `enum` is created by iterating over [`Components`], which in turn is
477 /// created by the [`components`](Path::components) method on [`Path`].
482 /// use std::path::{Component, Path};
484 /// let path = Path::new("/tmp/foo/bar.txt");
485 /// let components = path.components().collect::<Vec<_>>();
486 /// assert_eq!(&components, &[
487 /// Component::RootDir,
488 /// Component::Normal("tmp".as_ref()),
489 /// Component::Normal("foo".as_ref()),
490 /// Component::Normal("bar.txt".as_ref()),
493 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
494 #[stable(feature = "rust1", since = "1.0.0")]
495 pub enum Component<'a> {
496 /// A Windows path prefix, e.g., `C:` or `\\server\share`.
498 /// There is a large variety of prefix types, see [`Prefix`]'s documentation
501 /// Does not occur on Unix.
502 #[stable(feature = "rust1", since = "1.0.0")]
503 Prefix(#[stable(feature = "rust1", since = "1.0.0")] PrefixComponent<'a>),
505 /// The root directory component, appears after any prefix and before anything else.
507 /// It represents a separator that designates that a path starts from root.
508 #[stable(feature = "rust1", since = "1.0.0")]
511 /// A reference to the current directory, i.e., `.`.
512 #[stable(feature = "rust1", since = "1.0.0")]
515 /// A reference to the parent directory, i.e., `..`.
516 #[stable(feature = "rust1", since = "1.0.0")]
519 /// A normal component, e.g., `a` and `b` in `a/b`.
521 /// This variant is the most common one, it represents references to files
523 #[stable(feature = "rust1", since = "1.0.0")]
524 Normal(#[stable(feature = "rust1", since = "1.0.0")] &'a OsStr),
527 impl<'a> Component<'a> {
528 /// Extracts the underlying [`OsStr`] slice.
533 /// use std::path::Path;
535 /// let path = Path::new("./tmp/foo/bar.txt");
536 /// let components: Vec<_> = path.components().map(|comp| comp.as_os_str()).collect();
537 /// assert_eq!(&components, &[".", "tmp", "foo", "bar.txt"]);
539 #[must_use = "`self` will be dropped if the result is not used"]
540 #[stable(feature = "rust1", since = "1.0.0")]
541 pub fn as_os_str(self) -> &'a OsStr {
543 Component::Prefix(p) => p.as_os_str(),
544 Component::RootDir => OsStr::new(MAIN_SEP_STR),
545 Component::CurDir => OsStr::new("."),
546 Component::ParentDir => OsStr::new(".."),
547 Component::Normal(path) => path,
552 #[stable(feature = "rust1", since = "1.0.0")]
553 impl AsRef<OsStr> for Component<'_> {
555 fn as_ref(&self) -> &OsStr {
560 #[stable(feature = "path_component_asref", since = "1.25.0")]
561 impl AsRef<Path> for Component<'_> {
563 fn as_ref(&self) -> &Path {
564 self.as_os_str().as_ref()
568 /// An iterator over the [`Component`]s of a [`Path`].
570 /// This `struct` is created by the [`components`] method on [`Path`].
571 /// See its documentation for more.
576 /// use std::path::Path;
578 /// let path = Path::new("/tmp/foo/bar.txt");
580 /// for component in path.components() {
581 /// println!("{:?}", component);
585 /// [`components`]: Path::components
587 #[must_use = "iterators are lazy and do nothing unless consumed"]
588 #[stable(feature = "rust1", since = "1.0.0")]
589 pub struct Components<'a> {
590 // The path left to parse components from
593 // The prefix as it was originally parsed, if any
594 prefix: Option<Prefix<'a>>,
596 // true if path *physically* has a root separator; for most Windows
597 // prefixes, it may have a "logical" root separator for the purposes of
598 // normalization, e.g., \\server\share == \\server\share\.
599 has_physical_root: bool,
601 // The iterator is double-ended, and these two states keep track of what has
602 // been produced from either end
607 /// An iterator over the [`Component`]s of a [`Path`], as [`OsStr`] slices.
609 /// This `struct` is created by the [`iter`] method on [`Path`].
610 /// See its documentation for more.
612 /// [`iter`]: Path::iter
614 #[must_use = "iterators are lazy and do nothing unless consumed"]
615 #[stable(feature = "rust1", since = "1.0.0")]
616 pub struct Iter<'a> {
617 inner: Components<'a>,
620 #[stable(feature = "path_components_debug", since = "1.13.0")]
621 impl fmt::Debug for Components<'_> {
622 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
623 struct DebugHelper<'a>(&'a Path);
625 impl fmt::Debug for DebugHelper<'_> {
626 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
627 f.debug_list().entries(self.0.components()).finish()
631 f.debug_tuple("Components").field(&DebugHelper(self.as_path())).finish()
635 impl<'a> Components<'a> {
636 // how long is the prefix, if any?
638 fn prefix_len(&self) -> usize {
639 self.prefix.as_ref().map(Prefix::len).unwrap_or(0)
643 fn prefix_verbatim(&self) -> bool {
644 self.prefix.as_ref().map(Prefix::is_verbatim).unwrap_or(false)
647 /// how much of the prefix is left from the point of view of iteration?
649 fn prefix_remaining(&self) -> usize {
650 if self.front == State::Prefix { self.prefix_len() } else { 0 }
653 // Given the iteration so far, how much of the pre-State::Body path is left?
655 fn len_before_body(&self) -> usize {
656 let root = if self.front <= State::StartDir && self.has_physical_root { 1 } else { 0 };
657 let cur_dir = if self.front <= State::StartDir && self.include_cur_dir() { 1 } else { 0 };
658 self.prefix_remaining() + root + cur_dir
661 // is the iteration complete?
663 fn finished(&self) -> bool {
664 self.front == State::Done || self.back == State::Done || self.front > self.back
668 fn is_sep_byte(&self, b: u8) -> bool {
669 if self.prefix_verbatim() { is_verbatim_sep(b) } else { is_sep_byte(b) }
672 /// Extracts a slice corresponding to the portion of the path remaining for iteration.
677 /// use std::path::Path;
679 /// let mut components = Path::new("/tmp/foo/bar.txt").components();
680 /// components.next();
681 /// components.next();
683 /// assert_eq!(Path::new("foo/bar.txt"), components.as_path());
686 #[stable(feature = "rust1", since = "1.0.0")]
687 pub fn as_path(&self) -> &'a Path {
688 let mut comps = self.clone();
689 if comps.front == State::Body {
692 if comps.back == State::Body {
695 unsafe { Path::from_u8_slice(comps.path) }
698 /// Is the *original* path rooted?
699 fn has_root(&self) -> bool {
700 if self.has_physical_root {
703 if let Some(p) = self.prefix {
704 if p.has_implicit_root() {
711 /// Should the normalized path include a leading . ?
712 fn include_cur_dir(&self) -> bool {
716 let mut iter = self.path[self.prefix_len()..].iter();
717 match (iter.next(), iter.next()) {
718 (Some(&b'.'), None) => true,
719 (Some(&b'.'), Some(&b)) => self.is_sep_byte(b),
724 // parse a given byte sequence into the corresponding path component
725 fn parse_single_component<'b>(&self, comp: &'b [u8]) -> Option<Component<'b>> {
727 b"." if self.prefix_verbatim() => Some(Component::CurDir),
728 b"." => None, // . components are normalized away, except at
729 // the beginning of a path, which is treated
730 // separately via `include_cur_dir`
731 b".." => Some(Component::ParentDir),
733 _ => Some(Component::Normal(unsafe { u8_slice_as_os_str(comp) })),
737 // parse a component from the left, saying how many bytes to consume to
738 // remove the component
739 fn parse_next_component(&self) -> (usize, Option<Component<'a>>) {
740 debug_assert!(self.front == State::Body);
741 let (extra, comp) = match self.path.iter().position(|b| self.is_sep_byte(*b)) {
742 None => (0, self.path),
743 Some(i) => (1, &self.path[..i]),
745 (comp.len() + extra, self.parse_single_component(comp))
748 // parse a component from the right, saying how many bytes to consume to
749 // remove the component
750 fn parse_next_component_back(&self) -> (usize, Option<Component<'a>>) {
751 debug_assert!(self.back == State::Body);
752 let start = self.len_before_body();
753 let (extra, comp) = match self.path[start..].iter().rposition(|b| self.is_sep_byte(*b)) {
754 None => (0, &self.path[start..]),
755 Some(i) => (1, &self.path[start + i + 1..]),
757 (comp.len() + extra, self.parse_single_component(comp))
760 // trim away repeated separators (i.e., empty components) on the left
761 fn trim_left(&mut self) {
762 while !self.path.is_empty() {
763 let (size, comp) = self.parse_next_component();
767 self.path = &self.path[size..];
772 // trim away repeated separators (i.e., empty components) on the right
773 fn trim_right(&mut self) {
774 while self.path.len() > self.len_before_body() {
775 let (size, comp) = self.parse_next_component_back();
779 self.path = &self.path[..self.path.len() - size];
785 #[stable(feature = "rust1", since = "1.0.0")]
786 impl AsRef<Path> for Components<'_> {
788 fn as_ref(&self) -> &Path {
793 #[stable(feature = "rust1", since = "1.0.0")]
794 impl AsRef<OsStr> for Components<'_> {
796 fn as_ref(&self) -> &OsStr {
797 self.as_path().as_os_str()
801 #[stable(feature = "path_iter_debug", since = "1.13.0")]
802 impl fmt::Debug for Iter<'_> {
803 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
804 struct DebugHelper<'a>(&'a Path);
806 impl fmt::Debug for DebugHelper<'_> {
807 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
808 f.debug_list().entries(self.0.iter()).finish()
812 f.debug_tuple("Iter").field(&DebugHelper(self.as_path())).finish()
817 /// Extracts a slice corresponding to the portion of the path remaining for iteration.
822 /// use std::path::Path;
824 /// let mut iter = Path::new("/tmp/foo/bar.txt").iter();
828 /// assert_eq!(Path::new("foo/bar.txt"), iter.as_path());
830 #[stable(feature = "rust1", since = "1.0.0")]
833 pub fn as_path(&self) -> &'a Path {
838 #[stable(feature = "rust1", since = "1.0.0")]
839 impl AsRef<Path> for Iter<'_> {
841 fn as_ref(&self) -> &Path {
846 #[stable(feature = "rust1", since = "1.0.0")]
847 impl AsRef<OsStr> for Iter<'_> {
849 fn as_ref(&self) -> &OsStr {
850 self.as_path().as_os_str()
854 #[stable(feature = "rust1", since = "1.0.0")]
855 impl<'a> Iterator for Iter<'a> {
856 type Item = &'a OsStr;
859 fn next(&mut self) -> Option<&'a OsStr> {
860 self.inner.next().map(Component::as_os_str)
864 #[stable(feature = "rust1", since = "1.0.0")]
865 impl<'a> DoubleEndedIterator for Iter<'a> {
867 fn next_back(&mut self) -> Option<&'a OsStr> {
868 self.inner.next_back().map(Component::as_os_str)
872 #[stable(feature = "fused", since = "1.26.0")]
873 impl FusedIterator for Iter<'_> {}
875 #[stable(feature = "rust1", since = "1.0.0")]
876 impl<'a> Iterator for Components<'a> {
877 type Item = Component<'a>;
879 fn next(&mut self) -> Option<Component<'a>> {
880 while !self.finished() {
882 State::Prefix if self.prefix_len() > 0 => {
883 self.front = State::StartDir;
884 debug_assert!(self.prefix_len() <= self.path.len());
885 let raw = &self.path[..self.prefix_len()];
886 self.path = &self.path[self.prefix_len()..];
887 return Some(Component::Prefix(PrefixComponent {
888 raw: unsafe { u8_slice_as_os_str(raw) },
889 parsed: self.prefix.unwrap(),
893 self.front = State::StartDir;
896 self.front = State::Body;
897 if self.has_physical_root {
898 debug_assert!(!self.path.is_empty());
899 self.path = &self.path[1..];
900 return Some(Component::RootDir);
901 } else if let Some(p) = self.prefix {
902 if p.has_implicit_root() && !p.is_verbatim() {
903 return Some(Component::RootDir);
905 } else if self.include_cur_dir() {
906 debug_assert!(!self.path.is_empty());
907 self.path = &self.path[1..];
908 return Some(Component::CurDir);
911 State::Body if !self.path.is_empty() => {
912 let (size, comp) = self.parse_next_component();
913 self.path = &self.path[size..];
919 self.front = State::Done;
921 State::Done => unreachable!(),
928 #[stable(feature = "rust1", since = "1.0.0")]
929 impl<'a> DoubleEndedIterator for Components<'a> {
930 fn next_back(&mut self) -> Option<Component<'a>> {
931 while !self.finished() {
933 State::Body if self.path.len() > self.len_before_body() => {
934 let (size, comp) = self.parse_next_component_back();
935 self.path = &self.path[..self.path.len() - size];
941 self.back = State::StartDir;
944 self.back = State::Prefix;
945 if self.has_physical_root {
946 self.path = &self.path[..self.path.len() - 1];
947 return Some(Component::RootDir);
948 } else if let Some(p) = self.prefix {
949 if p.has_implicit_root() && !p.is_verbatim() {
950 return Some(Component::RootDir);
952 } else if self.include_cur_dir() {
953 self.path = &self.path[..self.path.len() - 1];
954 return Some(Component::CurDir);
957 State::Prefix if self.prefix_len() > 0 => {
958 self.back = State::Done;
959 return Some(Component::Prefix(PrefixComponent {
960 raw: unsafe { u8_slice_as_os_str(self.path) },
961 parsed: self.prefix.unwrap(),
965 self.back = State::Done;
968 State::Done => unreachable!(),
975 #[stable(feature = "fused", since = "1.26.0")]
976 impl FusedIterator for Components<'_> {}
978 #[stable(feature = "rust1", since = "1.0.0")]
979 impl<'a> cmp::PartialEq for Components<'a> {
981 fn eq(&self, other: &Components<'a>) -> bool {
982 Iterator::eq(self.clone().rev(), other.clone().rev())
986 #[stable(feature = "rust1", since = "1.0.0")]
987 impl cmp::Eq for Components<'_> {}
989 #[stable(feature = "rust1", since = "1.0.0")]
990 impl<'a> cmp::PartialOrd for Components<'a> {
992 fn partial_cmp(&self, other: &Components<'a>) -> Option<cmp::Ordering> {
993 Some(compare_components(self.clone(), other.clone()))
997 #[stable(feature = "rust1", since = "1.0.0")]
998 impl cmp::Ord for Components<'_> {
1000 fn cmp(&self, other: &Self) -> cmp::Ordering {
1001 compare_components(self.clone(), other.clone())
1005 fn compare_components(mut left: Components<'_>, mut right: Components<'_>) -> cmp::Ordering {
1006 // Fast path for long shared prefixes
1008 // - compare raw bytes to find first mismatch
1009 // - backtrack to find separator before mismatch to avoid ambiguous parsings of '.' or '..' characters
1010 // - if found update state to only do a component-wise comparison on the remainder,
1011 // otherwise do it on the full path
1013 // The fast path isn't taken for paths with a PrefixComponent to avoid backtracking into
1014 // the middle of one
1015 if left.prefix.is_none() && right.prefix.is_none() && left.front == right.front {
1016 // this might benefit from a [u8]::first_mismatch simd implementation, if it existed
1017 let first_difference =
1018 match left.path.iter().zip(right.path.iter()).position(|(&a, &b)| a != b) {
1019 None if left.path.len() == right.path.len() => return cmp::Ordering::Equal,
1020 None => left.path.len().min(right.path.len()),
1024 if let Some(previous_sep) =
1025 left.path[..first_difference].iter().rposition(|&b| left.is_sep_byte(b))
1027 let mismatched_component_start = previous_sep + 1;
1028 left.path = &left.path[mismatched_component_start..];
1029 left.front = State::Body;
1030 right.path = &right.path[mismatched_component_start..];
1031 right.front = State::Body;
1035 Iterator::cmp(left, right)
1038 /// An iterator over [`Path`] and its ancestors.
1040 /// This `struct` is created by the [`ancestors`] method on [`Path`].
1041 /// See its documentation for more.
1046 /// use std::path::Path;
1048 /// let path = Path::new("/foo/bar");
1050 /// for ancestor in path.ancestors() {
1051 /// println!("{}", ancestor.display());
1055 /// [`ancestors`]: Path::ancestors
1056 #[derive(Copy, Clone, Debug)]
1057 #[must_use = "iterators are lazy and do nothing unless consumed"]
1058 #[stable(feature = "path_ancestors", since = "1.28.0")]
1059 pub struct Ancestors<'a> {
1060 next: Option<&'a Path>,
1063 #[stable(feature = "path_ancestors", since = "1.28.0")]
1064 impl<'a> Iterator for Ancestors<'a> {
1065 type Item = &'a Path;
1068 fn next(&mut self) -> Option<Self::Item> {
1069 let next = self.next;
1070 self.next = next.and_then(Path::parent);
1075 #[stable(feature = "path_ancestors", since = "1.28.0")]
1076 impl FusedIterator for Ancestors<'_> {}
1078 ////////////////////////////////////////////////////////////////////////////////
1079 // Basic types and traits
1080 ////////////////////////////////////////////////////////////////////////////////
1082 /// An owned, mutable path (akin to [`String`]).
1084 /// This type provides methods like [`push`] and [`set_extension`] that mutate
1085 /// the path in place. It also implements [`Deref`] to [`Path`], meaning that
1086 /// all methods on [`Path`] slices are available on `PathBuf` values as well.
1088 /// [`push`]: PathBuf::push
1089 /// [`set_extension`]: PathBuf::set_extension
1091 /// More details about the overall approach can be found in
1092 /// the [module documentation](self).
1096 /// You can use [`push`] to build up a `PathBuf` from
1100 /// use std::path::PathBuf;
1102 /// let mut path = PathBuf::new();
1104 /// path.push(r"C:\");
1105 /// path.push("windows");
1106 /// path.push("system32");
1108 /// path.set_extension("dll");
1111 /// However, [`push`] is best used for dynamic situations. This is a better way
1112 /// to do this when you know all of the components ahead of time:
1115 /// use std::path::PathBuf;
1117 /// let path: PathBuf = [r"C:\", "windows", "system32.dll"].iter().collect();
1120 /// We can still do better than this! Since these are all strings, we can use
1124 /// use std::path::PathBuf;
1126 /// let path = PathBuf::from(r"C:\windows\system32.dll");
1129 /// Which method works best depends on what kind of situation you're in.
1130 #[cfg_attr(not(test), rustc_diagnostic_item = "PathBuf")]
1131 #[stable(feature = "rust1", since = "1.0.0")]
1133 // `PathBuf::as_mut_vec` current implementation relies
1134 // on `PathBuf` being layout-compatible with `Vec<u8>`.
1135 // When attribute privacy is implemented, `PathBuf` should be annotated as `#[repr(transparent)]`.
1136 // Anyway, `PathBuf` representation and layout are considered implementation detail, are
1137 // not documented and must not be relied upon.
1138 pub struct PathBuf {
1144 fn as_mut_vec(&mut self) -> &mut Vec<u8> {
1145 unsafe { &mut *(self as *mut PathBuf as *mut Vec<u8>) }
1148 /// Allocates an empty `PathBuf`.
1153 /// use std::path::PathBuf;
1155 /// let path = PathBuf::new();
1157 #[stable(feature = "rust1", since = "1.0.0")]
1160 pub fn new() -> PathBuf {
1161 PathBuf { inner: OsString::new() }
1164 /// Creates a new `PathBuf` with a given capacity used to create the
1165 /// internal [`OsString`]. See [`with_capacity`] defined on [`OsString`].
1170 /// use std::path::PathBuf;
1172 /// let mut path = PathBuf::with_capacity(10);
1173 /// let capacity = path.capacity();
1175 /// // This push is done without reallocating
1176 /// path.push(r"C:\");
1178 /// assert_eq!(capacity, path.capacity());
1181 /// [`with_capacity`]: OsString::with_capacity
1182 #[stable(feature = "path_buf_capacity", since = "1.44.0")]
1185 pub fn with_capacity(capacity: usize) -> PathBuf {
1186 PathBuf { inner: OsString::with_capacity(capacity) }
1189 /// Coerces to a [`Path`] slice.
1194 /// use std::path::{Path, PathBuf};
1196 /// let p = PathBuf::from("/test");
1197 /// assert_eq!(Path::new("/test"), p.as_path());
1199 #[stable(feature = "rust1", since = "1.0.0")]
1202 pub fn as_path(&self) -> &Path {
1206 /// Extends `self` with `path`.
1208 /// If `path` is absolute, it replaces the current path.
1212 /// * if `path` has a root but no prefix (e.g., `\windows`), it
1213 /// replaces everything except for the prefix (if any) of `self`.
1214 /// * if `path` has a prefix but no root, it replaces `self`.
1215 /// * if `self` has a verbatim prefix (e.g. `\\?\C:\windows`)
1216 /// and `path` is not empty, the new path is normalized: all references
1217 /// to `.` and `..` are removed.
1221 /// Pushing a relative path extends the existing path:
1224 /// use std::path::PathBuf;
1226 /// let mut path = PathBuf::from("/tmp");
1227 /// path.push("file.bk");
1228 /// assert_eq!(path, PathBuf::from("/tmp/file.bk"));
1231 /// Pushing an absolute path replaces the existing path:
1234 /// use std::path::PathBuf;
1236 /// let mut path = PathBuf::from("/tmp");
1237 /// path.push("/etc");
1238 /// assert_eq!(path, PathBuf::from("/etc"));
1240 #[stable(feature = "rust1", since = "1.0.0")]
1241 pub fn push<P: AsRef<Path>>(&mut self, path: P) {
1242 self._push(path.as_ref())
1245 fn _push(&mut self, path: &Path) {
1246 // in general, a separator is needed if the rightmost byte is not a separator
1247 let mut need_sep = self.as_mut_vec().last().map(|c| !is_sep_byte(*c)).unwrap_or(false);
1249 // in the special case of `C:` on Windows, do *not* add a separator
1250 let comps = self.components();
1252 if comps.prefix_len() > 0
1253 && comps.prefix_len() == comps.path.len()
1254 && comps.prefix.unwrap().is_drive()
1259 // absolute `path` replaces `self`
1260 if path.is_absolute() || path.prefix().is_some() {
1261 self.as_mut_vec().truncate(0);
1263 // verbatim paths need . and .. removed
1264 } else if comps.prefix_verbatim() && !path.inner.is_empty() {
1265 let mut buf: Vec<_> = comps.collect();
1266 for c in path.components() {
1268 Component::RootDir => {
1272 Component::CurDir => (),
1273 Component::ParentDir => {
1274 if let Some(Component::Normal(_)) = buf.last() {
1282 let mut res = OsString::new();
1283 let mut need_sep = false;
1286 if need_sep && c != Component::RootDir {
1287 res.push(MAIN_SEP_STR);
1289 res.push(c.as_os_str());
1291 need_sep = match c {
1292 Component::RootDir => false,
1293 Component::Prefix(prefix) => {
1294 !prefix.parsed.is_drive() && prefix.parsed.len() > 0
1303 // `path` has a root but no prefix, e.g., `\windows` (Windows only)
1304 } else if path.has_root() {
1305 let prefix_len = self.components().prefix_remaining();
1306 self.as_mut_vec().truncate(prefix_len);
1308 // `path` is a pure relative path
1309 } else if need_sep {
1310 self.inner.push(MAIN_SEP_STR);
1313 self.inner.push(path);
1316 /// Truncates `self` to [`self.parent`].
1318 /// Returns `false` and does nothing if [`self.parent`] is [`None`].
1319 /// Otherwise, returns `true`.
1321 /// [`self.parent`]: Path::parent
1326 /// use std::path::{Path, PathBuf};
1328 /// let mut p = PathBuf::from("/spirited/away.rs");
1331 /// assert_eq!(Path::new("/spirited"), p);
1333 /// assert_eq!(Path::new("/"), p);
1335 #[stable(feature = "rust1", since = "1.0.0")]
1336 pub fn pop(&mut self) -> bool {
1337 match self.parent().map(|p| p.as_u8_slice().len()) {
1339 self.as_mut_vec().truncate(len);
1346 /// Updates [`self.file_name`] to `file_name`.
1348 /// If [`self.file_name`] was [`None`], this is equivalent to pushing
1351 /// Otherwise it is equivalent to calling [`pop`] and then pushing
1352 /// `file_name`. The new path will be a sibling of the original path.
1353 /// (That is, it will have the same parent.)
1355 /// [`self.file_name`]: Path::file_name
1356 /// [`pop`]: PathBuf::pop
1361 /// use std::path::PathBuf;
1363 /// let mut buf = PathBuf::from("/");
1364 /// assert!(buf.file_name() == None);
1365 /// buf.set_file_name("bar");
1366 /// assert!(buf == PathBuf::from("/bar"));
1367 /// assert!(buf.file_name().is_some());
1368 /// buf.set_file_name("baz.txt");
1369 /// assert!(buf == PathBuf::from("/baz.txt"));
1371 #[stable(feature = "rust1", since = "1.0.0")]
1372 pub fn set_file_name<S: AsRef<OsStr>>(&mut self, file_name: S) {
1373 self._set_file_name(file_name.as_ref())
1376 fn _set_file_name(&mut self, file_name: &OsStr) {
1377 if self.file_name().is_some() {
1378 let popped = self.pop();
1379 debug_assert!(popped);
1381 self.push(file_name);
1384 /// Updates [`self.extension`] to `extension`.
1386 /// Returns `false` and does nothing if [`self.file_name`] is [`None`],
1387 /// returns `true` and updates the extension otherwise.
1389 /// If [`self.extension`] is [`None`], the extension is added; otherwise
1392 /// [`self.file_name`]: Path::file_name
1393 /// [`self.extension`]: Path::extension
1398 /// use std::path::{Path, PathBuf};
1400 /// let mut p = PathBuf::from("/feel/the");
1402 /// p.set_extension("force");
1403 /// assert_eq!(Path::new("/feel/the.force"), p.as_path());
1405 /// p.set_extension("dark_side");
1406 /// assert_eq!(Path::new("/feel/the.dark_side"), p.as_path());
1408 #[stable(feature = "rust1", since = "1.0.0")]
1409 pub fn set_extension<S: AsRef<OsStr>>(&mut self, extension: S) -> bool {
1410 self._set_extension(extension.as_ref())
1413 fn _set_extension(&mut self, extension: &OsStr) -> bool {
1414 let file_stem = match self.file_stem() {
1415 None => return false,
1416 Some(f) => os_str_as_u8_slice(f),
1419 // truncate until right after the file stem
1420 let end_file_stem = file_stem[file_stem.len()..].as_ptr() as usize;
1421 let start = os_str_as_u8_slice(&self.inner).as_ptr() as usize;
1422 let v = self.as_mut_vec();
1423 v.truncate(end_file_stem.wrapping_sub(start));
1425 // add the new extension, if any
1426 let new = os_str_as_u8_slice(extension);
1427 if !new.is_empty() {
1428 v.reserve_exact(new.len() + 1);
1430 v.extend_from_slice(new);
1436 /// Consumes the `PathBuf`, yielding its internal [`OsString`] storage.
1441 /// use std::path::PathBuf;
1443 /// let p = PathBuf::from("/the/head");
1444 /// let os_str = p.into_os_string();
1446 #[stable(feature = "rust1", since = "1.0.0")]
1447 #[must_use = "`self` will be dropped if the result is not used"]
1449 pub fn into_os_string(self) -> OsString {
1453 /// Converts this `PathBuf` into a [boxed](Box) [`Path`].
1454 #[stable(feature = "into_boxed_path", since = "1.20.0")]
1455 #[must_use = "`self` will be dropped if the result is not used"]
1457 pub fn into_boxed_path(self) -> Box<Path> {
1458 let rw = Box::into_raw(self.inner.into_boxed_os_str()) as *mut Path;
1459 unsafe { Box::from_raw(rw) }
1462 /// Invokes [`capacity`] on the underlying instance of [`OsString`].
1464 /// [`capacity`]: OsString::capacity
1465 #[stable(feature = "path_buf_capacity", since = "1.44.0")]
1468 pub fn capacity(&self) -> usize {
1469 self.inner.capacity()
1472 /// Invokes [`clear`] on the underlying instance of [`OsString`].
1474 /// [`clear`]: OsString::clear
1475 #[stable(feature = "path_buf_capacity", since = "1.44.0")]
1477 pub fn clear(&mut self) {
1481 /// Invokes [`reserve`] on the underlying instance of [`OsString`].
1483 /// [`reserve`]: OsString::reserve
1484 #[stable(feature = "path_buf_capacity", since = "1.44.0")]
1486 pub fn reserve(&mut self, additional: usize) {
1487 self.inner.reserve(additional)
1490 /// Invokes [`reserve_exact`] on the underlying instance of [`OsString`].
1492 /// [`reserve_exact`]: OsString::reserve_exact
1493 #[stable(feature = "path_buf_capacity", since = "1.44.0")]
1495 pub fn reserve_exact(&mut self, additional: usize) {
1496 self.inner.reserve_exact(additional)
1499 /// Invokes [`shrink_to_fit`] on the underlying instance of [`OsString`].
1501 /// [`shrink_to_fit`]: OsString::shrink_to_fit
1502 #[stable(feature = "path_buf_capacity", since = "1.44.0")]
1504 pub fn shrink_to_fit(&mut self) {
1505 self.inner.shrink_to_fit()
1508 /// Invokes [`shrink_to`] on the underlying instance of [`OsString`].
1510 /// [`shrink_to`]: OsString::shrink_to
1511 #[stable(feature = "shrink_to", since = "1.56.0")]
1513 pub fn shrink_to(&mut self, min_capacity: usize) {
1514 self.inner.shrink_to(min_capacity)
1518 #[stable(feature = "rust1", since = "1.0.0")]
1519 impl Clone for PathBuf {
1521 fn clone(&self) -> Self {
1522 PathBuf { inner: self.inner.clone() }
1526 fn clone_from(&mut self, source: &Self) {
1527 self.inner.clone_from(&source.inner)
1531 #[stable(feature = "box_from_path", since = "1.17.0")]
1532 impl From<&Path> for Box<Path> {
1533 /// Creates a boxed [`Path`] from a reference.
1535 /// This will allocate and clone `path` to it.
1536 fn from(path: &Path) -> Box<Path> {
1537 let boxed: Box<OsStr> = path.inner.into();
1538 let rw = Box::into_raw(boxed) as *mut Path;
1539 unsafe { Box::from_raw(rw) }
1543 #[stable(feature = "box_from_cow", since = "1.45.0")]
1544 impl From<Cow<'_, Path>> for Box<Path> {
1545 /// Creates a boxed [`Path`] from a clone-on-write pointer.
1547 /// Converting from a `Cow::Owned` does not clone or allocate.
1549 fn from(cow: Cow<'_, Path>) -> Box<Path> {
1551 Cow::Borrowed(path) => Box::from(path),
1552 Cow::Owned(path) => Box::from(path),
1557 #[stable(feature = "path_buf_from_box", since = "1.18.0")]
1558 impl From<Box<Path>> for PathBuf {
1559 /// Converts a `Box<Path>` into a `PathBuf`
1561 /// This conversion does not allocate or copy memory.
1563 fn from(boxed: Box<Path>) -> PathBuf {
1564 boxed.into_path_buf()
1568 #[stable(feature = "box_from_path_buf", since = "1.20.0")]
1569 impl From<PathBuf> for Box<Path> {
1570 /// Converts a `PathBuf` into a `Box<Path>`
1572 /// This conversion currently should not allocate memory,
1573 /// but this behavior is not guaranteed on all platforms or in all future versions.
1575 fn from(p: PathBuf) -> Box<Path> {
1580 #[stable(feature = "more_box_slice_clone", since = "1.29.0")]
1581 impl Clone for Box<Path> {
1583 fn clone(&self) -> Self {
1584 self.to_path_buf().into_boxed_path()
1588 #[stable(feature = "rust1", since = "1.0.0")]
1589 impl<T: ?Sized + AsRef<OsStr>> From<&T> for PathBuf {
1590 /// Converts a borrowed `OsStr` to a `PathBuf`.
1592 /// Allocates a [`PathBuf`] and copies the data into it.
1594 fn from(s: &T) -> PathBuf {
1595 PathBuf::from(s.as_ref().to_os_string())
1599 #[stable(feature = "rust1", since = "1.0.0")]
1600 impl From<OsString> for PathBuf {
1601 /// Converts an [`OsString`] into a [`PathBuf`]
1603 /// This conversion does not allocate or copy memory.
1605 fn from(s: OsString) -> PathBuf {
1606 PathBuf { inner: s }
1610 #[stable(feature = "from_path_buf_for_os_string", since = "1.14.0")]
1611 impl From<PathBuf> for OsString {
1612 /// Converts a [`PathBuf`] into an [`OsString`]
1614 /// This conversion does not allocate or copy memory.
1616 fn from(path_buf: PathBuf) -> OsString {
1621 #[stable(feature = "rust1", since = "1.0.0")]
1622 impl From<String> for PathBuf {
1623 /// Converts a [`String`] into a [`PathBuf`]
1625 /// This conversion does not allocate or copy memory.
1627 fn from(s: String) -> PathBuf {
1628 PathBuf::from(OsString::from(s))
1632 #[stable(feature = "path_from_str", since = "1.32.0")]
1633 impl FromStr for PathBuf {
1634 type Err = core::convert::Infallible;
1637 fn from_str(s: &str) -> Result<Self, Self::Err> {
1638 Ok(PathBuf::from(s))
1642 #[stable(feature = "rust1", since = "1.0.0")]
1643 impl<P: AsRef<Path>> iter::FromIterator<P> for PathBuf {
1644 fn from_iter<I: IntoIterator<Item = P>>(iter: I) -> PathBuf {
1645 let mut buf = PathBuf::new();
1651 #[stable(feature = "rust1", since = "1.0.0")]
1652 impl<P: AsRef<Path>> iter::Extend<P> for PathBuf {
1653 fn extend<I: IntoIterator<Item = P>>(&mut self, iter: I) {
1654 iter.into_iter().for_each(move |p| self.push(p.as_ref()));
1658 fn extend_one(&mut self, p: P) {
1659 self.push(p.as_ref());
1663 #[stable(feature = "rust1", since = "1.0.0")]
1664 impl fmt::Debug for PathBuf {
1665 fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
1666 fmt::Debug::fmt(&**self, formatter)
1670 #[stable(feature = "rust1", since = "1.0.0")]
1671 impl ops::Deref for PathBuf {
1674 fn deref(&self) -> &Path {
1675 Path::new(&self.inner)
1679 #[stable(feature = "rust1", since = "1.0.0")]
1680 impl Borrow<Path> for PathBuf {
1682 fn borrow(&self) -> &Path {
1687 #[stable(feature = "default_for_pathbuf", since = "1.17.0")]
1688 impl Default for PathBuf {
1690 fn default() -> Self {
1695 #[stable(feature = "cow_from_path", since = "1.6.0")]
1696 impl<'a> From<&'a Path> for Cow<'a, Path> {
1697 /// Creates a clone-on-write pointer from a reference to
1700 /// This conversion does not clone or allocate.
1702 fn from(s: &'a Path) -> Cow<'a, Path> {
1707 #[stable(feature = "cow_from_path", since = "1.6.0")]
1708 impl<'a> From<PathBuf> for Cow<'a, Path> {
1709 /// Creates a clone-on-write pointer from an owned
1710 /// instance of [`PathBuf`].
1712 /// This conversion does not clone or allocate.
1714 fn from(s: PathBuf) -> Cow<'a, Path> {
1719 #[stable(feature = "cow_from_pathbuf_ref", since = "1.28.0")]
1720 impl<'a> From<&'a PathBuf> for Cow<'a, Path> {
1721 /// Creates a clone-on-write pointer from a reference to
1724 /// This conversion does not clone or allocate.
1726 fn from(p: &'a PathBuf) -> Cow<'a, Path> {
1727 Cow::Borrowed(p.as_path())
1731 #[stable(feature = "pathbuf_from_cow_path", since = "1.28.0")]
1732 impl<'a> From<Cow<'a, Path>> for PathBuf {
1733 /// Converts a clone-on-write pointer to an owned path.
1735 /// Converting from a `Cow::Owned` does not clone or allocate.
1737 fn from(p: Cow<'a, Path>) -> Self {
1742 #[stable(feature = "shared_from_slice2", since = "1.24.0")]
1743 impl From<PathBuf> for Arc<Path> {
1744 /// Converts a [`PathBuf`] into an [`Arc`] by moving the [`PathBuf`] data into a new [`Arc`] buffer.
1746 fn from(s: PathBuf) -> Arc<Path> {
1747 let arc: Arc<OsStr> = Arc::from(s.into_os_string());
1748 unsafe { Arc::from_raw(Arc::into_raw(arc) as *const Path) }
1752 #[stable(feature = "shared_from_slice2", since = "1.24.0")]
1753 impl From<&Path> for Arc<Path> {
1754 /// Converts a [`Path`] into an [`Arc`] by copying the [`Path`] data into a new [`Arc`] buffer.
1756 fn from(s: &Path) -> Arc<Path> {
1757 let arc: Arc<OsStr> = Arc::from(s.as_os_str());
1758 unsafe { Arc::from_raw(Arc::into_raw(arc) as *const Path) }
1762 #[stable(feature = "shared_from_slice2", since = "1.24.0")]
1763 impl From<PathBuf> for Rc<Path> {
1764 /// Converts a [`PathBuf`] into an [`Rc`] by moving the [`PathBuf`] data into a new `Rc` buffer.
1766 fn from(s: PathBuf) -> Rc<Path> {
1767 let rc: Rc<OsStr> = Rc::from(s.into_os_string());
1768 unsafe { Rc::from_raw(Rc::into_raw(rc) as *const Path) }
1772 #[stable(feature = "shared_from_slice2", since = "1.24.0")]
1773 impl From<&Path> for Rc<Path> {
1774 /// Converts a [`Path`] into an [`Rc`] by copying the [`Path`] data into a new `Rc` buffer.
1776 fn from(s: &Path) -> Rc<Path> {
1777 let rc: Rc<OsStr> = Rc::from(s.as_os_str());
1778 unsafe { Rc::from_raw(Rc::into_raw(rc) as *const Path) }
1782 #[stable(feature = "rust1", since = "1.0.0")]
1783 impl ToOwned for Path {
1784 type Owned = PathBuf;
1786 fn to_owned(&self) -> PathBuf {
1790 fn clone_into(&self, target: &mut PathBuf) {
1791 self.inner.clone_into(&mut target.inner);
1795 #[stable(feature = "rust1", since = "1.0.0")]
1796 impl cmp::PartialEq for PathBuf {
1798 fn eq(&self, other: &PathBuf) -> bool {
1799 self.components() == other.components()
1803 #[stable(feature = "rust1", since = "1.0.0")]
1804 impl Hash for PathBuf {
1805 fn hash<H: Hasher>(&self, h: &mut H) {
1806 self.as_path().hash(h)
1810 #[stable(feature = "rust1", since = "1.0.0")]
1811 impl cmp::Eq for PathBuf {}
1813 #[stable(feature = "rust1", since = "1.0.0")]
1814 impl cmp::PartialOrd for PathBuf {
1816 fn partial_cmp(&self, other: &PathBuf) -> Option<cmp::Ordering> {
1817 Some(compare_components(self.components(), other.components()))
1821 #[stable(feature = "rust1", since = "1.0.0")]
1822 impl cmp::Ord for PathBuf {
1824 fn cmp(&self, other: &PathBuf) -> cmp::Ordering {
1825 compare_components(self.components(), other.components())
1829 #[stable(feature = "rust1", since = "1.0.0")]
1830 impl AsRef<OsStr> for PathBuf {
1832 fn as_ref(&self) -> &OsStr {
1837 /// A slice of a path (akin to [`str`]).
1839 /// This type supports a number of operations for inspecting a path, including
1840 /// breaking the path into its components (separated by `/` on Unix and by either
1841 /// `/` or `\` on Windows), extracting the file name, determining whether the path
1842 /// is absolute, and so on.
1844 /// This is an *unsized* type, meaning that it must always be used behind a
1845 /// pointer like `&` or [`Box`]. For an owned version of this type,
1846 /// see [`PathBuf`].
1848 /// More details about the overall approach can be found in
1849 /// the [module documentation](self).
1854 /// use std::path::Path;
1855 /// use std::ffi::OsStr;
1857 /// // Note: this example does work on Windows
1858 /// let path = Path::new("./foo/bar.txt");
1860 /// let parent = path.parent();
1861 /// assert_eq!(parent, Some(Path::new("./foo")));
1863 /// let file_stem = path.file_stem();
1864 /// assert_eq!(file_stem, Some(OsStr::new("bar")));
1866 /// let extension = path.extension();
1867 /// assert_eq!(extension, Some(OsStr::new("txt")));
1869 #[cfg_attr(not(test), rustc_diagnostic_item = "Path")]
1870 #[stable(feature = "rust1", since = "1.0.0")]
1872 // `Path::new` current implementation relies
1873 // on `Path` being layout-compatible with `OsStr`.
1874 // When attribute privacy is implemented, `Path` should be annotated as `#[repr(transparent)]`.
1875 // Anyway, `Path` representation and layout are considered implementation detail, are
1876 // not documented and must not be relied upon.
1881 /// An error returned from [`Path::strip_prefix`] if the prefix was not found.
1883 /// This `struct` is created by the [`strip_prefix`] method on [`Path`].
1884 /// See its documentation for more.
1886 /// [`strip_prefix`]: Path::strip_prefix
1887 #[derive(Debug, Clone, PartialEq, Eq)]
1888 #[stable(since = "1.7.0", feature = "strip_prefix")]
1889 pub struct StripPrefixError(());
1892 // The following (private!) function allows construction of a path from a u8
1893 // slice, which is only safe when it is known to follow the OsStr encoding.
1894 unsafe fn from_u8_slice(s: &[u8]) -> &Path {
1895 unsafe { Path::new(u8_slice_as_os_str(s)) }
1897 // The following (private!) function reveals the byte encoding used for OsStr.
1898 fn as_u8_slice(&self) -> &[u8] {
1899 os_str_as_u8_slice(&self.inner)
1902 /// Directly wraps a string slice as a `Path` slice.
1904 /// This is a cost-free conversion.
1909 /// use std::path::Path;
1911 /// Path::new("foo.txt");
1914 /// You can create `Path`s from `String`s, or even other `Path`s:
1917 /// use std::path::Path;
1919 /// let string = String::from("foo.txt");
1920 /// let from_string = Path::new(&string);
1921 /// let from_path = Path::new(&from_string);
1922 /// assert_eq!(from_string, from_path);
1924 #[stable(feature = "rust1", since = "1.0.0")]
1925 pub fn new<S: AsRef<OsStr> + ?Sized>(s: &S) -> &Path {
1926 unsafe { &*(s.as_ref() as *const OsStr as *const Path) }
1929 /// Yields the underlying [`OsStr`] slice.
1934 /// use std::path::Path;
1936 /// let os_str = Path::new("foo.txt").as_os_str();
1937 /// assert_eq!(os_str, std::ffi::OsStr::new("foo.txt"));
1939 #[stable(feature = "rust1", since = "1.0.0")]
1942 pub fn as_os_str(&self) -> &OsStr {
1946 /// Yields a [`&str`] slice if the `Path` is valid unicode.
1948 /// This conversion may entail doing a check for UTF-8 validity.
1949 /// Note that validation is performed because non-UTF-8 strings are
1950 /// perfectly valid for some OS.
1957 /// use std::path::Path;
1959 /// let path = Path::new("foo.txt");
1960 /// assert_eq!(path.to_str(), Some("foo.txt"));
1962 #[stable(feature = "rust1", since = "1.0.0")]
1963 #[must_use = "this returns the result of the operation, \
1964 without modifying the original"]
1966 pub fn to_str(&self) -> Option<&str> {
1970 /// Converts a `Path` to a [`Cow<str>`].
1972 /// Any non-Unicode sequences are replaced with
1973 /// [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD].
1975 /// [U+FFFD]: super::char::REPLACEMENT_CHARACTER
1979 /// Calling `to_string_lossy` on a `Path` with valid unicode:
1982 /// use std::path::Path;
1984 /// let path = Path::new("foo.txt");
1985 /// assert_eq!(path.to_string_lossy(), "foo.txt");
1988 /// Had `path` contained invalid unicode, the `to_string_lossy` call might
1989 /// have returned `"fo�.txt"`.
1990 #[stable(feature = "rust1", since = "1.0.0")]
1991 #[must_use = "this returns the result of the operation, \
1992 without modifying the original"]
1994 pub fn to_string_lossy(&self) -> Cow<'_, str> {
1995 self.inner.to_string_lossy()
1998 /// Converts a `Path` to an owned [`PathBuf`].
2003 /// use std::path::Path;
2005 /// let path_buf = Path::new("foo.txt").to_path_buf();
2006 /// assert_eq!(path_buf, std::path::PathBuf::from("foo.txt"));
2008 #[rustc_conversion_suggestion]
2009 #[must_use = "this returns the result of the operation, \
2010 without modifying the original"]
2011 #[stable(feature = "rust1", since = "1.0.0")]
2012 pub fn to_path_buf(&self) -> PathBuf {
2013 PathBuf::from(self.inner.to_os_string())
2016 /// Returns `true` if the `Path` is absolute, i.e., if it is independent of
2017 /// the current directory.
2019 /// * On Unix, a path is absolute if it starts with the root, so
2020 /// `is_absolute` and [`has_root`] are equivalent.
2022 /// * On Windows, a path is absolute if it has a prefix and starts with the
2023 /// root: `c:\windows` is absolute, while `c:temp` and `\temp` are not.
2028 /// use std::path::Path;
2030 /// assert!(!Path::new("foo.txt").is_absolute());
2033 /// [`has_root`]: Path::has_root
2034 #[stable(feature = "rust1", since = "1.0.0")]
2036 #[allow(deprecated)]
2037 pub fn is_absolute(&self) -> bool {
2038 if cfg!(target_os = "redox") {
2039 // FIXME: Allow Redox prefixes
2040 self.has_root() || has_redox_scheme(self.as_u8_slice())
2042 self.has_root() && (cfg!(any(unix, target_os = "wasi")) || self.prefix().is_some())
2046 /// Returns `true` if the `Path` is relative, i.e., not absolute.
2048 /// See [`is_absolute`]'s documentation for more details.
2053 /// use std::path::Path;
2055 /// assert!(Path::new("foo.txt").is_relative());
2058 /// [`is_absolute`]: Path::is_absolute
2059 #[stable(feature = "rust1", since = "1.0.0")]
2062 pub fn is_relative(&self) -> bool {
2066 fn prefix(&self) -> Option<Prefix<'_>> {
2067 self.components().prefix
2070 /// Returns `true` if the `Path` has a root.
2072 /// * On Unix, a path has a root if it begins with `/`.
2074 /// * On Windows, a path has a root if it:
2075 /// * has no prefix and begins with a separator, e.g., `\windows`
2076 /// * has a prefix followed by a separator, e.g., `c:\windows` but not `c:windows`
2077 /// * has any non-disk prefix, e.g., `\\server\share`
2082 /// use std::path::Path;
2084 /// assert!(Path::new("/etc/passwd").has_root());
2086 #[stable(feature = "rust1", since = "1.0.0")]
2089 pub fn has_root(&self) -> bool {
2090 self.components().has_root()
2093 /// Returns the `Path` without its final component, if there is one.
2095 /// Returns [`None`] if the path terminates in a root or prefix.
2100 /// use std::path::Path;
2102 /// let path = Path::new("/foo/bar");
2103 /// let parent = path.parent().unwrap();
2104 /// assert_eq!(parent, Path::new("/foo"));
2106 /// let grand_parent = parent.parent().unwrap();
2107 /// assert_eq!(grand_parent, Path::new("/"));
2108 /// assert_eq!(grand_parent.parent(), None);
2110 #[stable(feature = "rust1", since = "1.0.0")]
2112 pub fn parent(&self) -> Option<&Path> {
2113 let mut comps = self.components();
2114 let comp = comps.next_back();
2115 comp.and_then(|p| match p {
2116 Component::Normal(_) | Component::CurDir | Component::ParentDir => {
2117 Some(comps.as_path())
2123 /// Produces an iterator over `Path` and its ancestors.
2125 /// The iterator will yield the `Path` that is returned if the [`parent`] method is used zero
2126 /// or more times. That means, the iterator will yield `&self`, `&self.parent().unwrap()`,
2127 /// `&self.parent().unwrap().parent().unwrap()` and so on. If the [`parent`] method returns
2128 /// [`None`], the iterator will do likewise. The iterator will always yield at least one value,
2134 /// use std::path::Path;
2136 /// let mut ancestors = Path::new("/foo/bar").ancestors();
2137 /// assert_eq!(ancestors.next(), Some(Path::new("/foo/bar")));
2138 /// assert_eq!(ancestors.next(), Some(Path::new("/foo")));
2139 /// assert_eq!(ancestors.next(), Some(Path::new("/")));
2140 /// assert_eq!(ancestors.next(), None);
2142 /// let mut ancestors = Path::new("../foo/bar").ancestors();
2143 /// assert_eq!(ancestors.next(), Some(Path::new("../foo/bar")));
2144 /// assert_eq!(ancestors.next(), Some(Path::new("../foo")));
2145 /// assert_eq!(ancestors.next(), Some(Path::new("..")));
2146 /// assert_eq!(ancestors.next(), Some(Path::new("")));
2147 /// assert_eq!(ancestors.next(), None);
2150 /// [`parent`]: Path::parent
2151 #[stable(feature = "path_ancestors", since = "1.28.0")]
2153 pub fn ancestors(&self) -> Ancestors<'_> {
2154 Ancestors { next: Some(&self) }
2157 /// Returns the final component of the `Path`, if there is one.
2159 /// If the path is a normal file, this is the file name. If it's the path of a directory, this
2160 /// is the directory name.
2162 /// Returns [`None`] if the path terminates in `..`.
2167 /// use std::path::Path;
2168 /// use std::ffi::OsStr;
2170 /// assert_eq!(Some(OsStr::new("bin")), Path::new("/usr/bin/").file_name());
2171 /// assert_eq!(Some(OsStr::new("foo.txt")), Path::new("tmp/foo.txt").file_name());
2172 /// assert_eq!(Some(OsStr::new("foo.txt")), Path::new("foo.txt/.").file_name());
2173 /// assert_eq!(Some(OsStr::new("foo.txt")), Path::new("foo.txt/.//").file_name());
2174 /// assert_eq!(None, Path::new("foo.txt/..").file_name());
2175 /// assert_eq!(None, Path::new("/").file_name());
2177 #[stable(feature = "rust1", since = "1.0.0")]
2179 pub fn file_name(&self) -> Option<&OsStr> {
2180 self.components().next_back().and_then(|p| match p {
2181 Component::Normal(p) => Some(p),
2186 /// Returns a path that, when joined onto `base`, yields `self`.
2190 /// If `base` is not a prefix of `self` (i.e., [`starts_with`]
2191 /// returns `false`), returns [`Err`].
2193 /// [`starts_with`]: Path::starts_with
2198 /// use std::path::{Path, PathBuf};
2200 /// let path = Path::new("/test/haha/foo.txt");
2202 /// assert_eq!(path.strip_prefix("/"), Ok(Path::new("test/haha/foo.txt")));
2203 /// assert_eq!(path.strip_prefix("/test"), Ok(Path::new("haha/foo.txt")));
2204 /// assert_eq!(path.strip_prefix("/test/"), Ok(Path::new("haha/foo.txt")));
2205 /// assert_eq!(path.strip_prefix("/test/haha/foo.txt"), Ok(Path::new("")));
2206 /// assert_eq!(path.strip_prefix("/test/haha/foo.txt/"), Ok(Path::new("")));
2208 /// assert!(path.strip_prefix("test").is_err());
2209 /// assert!(path.strip_prefix("/haha").is_err());
2211 /// let prefix = PathBuf::from("/test/");
2212 /// assert_eq!(path.strip_prefix(prefix), Ok(Path::new("haha/foo.txt")));
2214 #[stable(since = "1.7.0", feature = "path_strip_prefix")]
2215 pub fn strip_prefix<P>(&self, base: P) -> Result<&Path, StripPrefixError>
2219 self._strip_prefix(base.as_ref())
2222 fn _strip_prefix(&self, base: &Path) -> Result<&Path, StripPrefixError> {
2223 iter_after(self.components(), base.components())
2224 .map(|c| c.as_path())
2225 .ok_or(StripPrefixError(()))
2228 /// Determines whether `base` is a prefix of `self`.
2230 /// Only considers whole path components to match.
2235 /// use std::path::Path;
2237 /// let path = Path::new("/etc/passwd");
2239 /// assert!(path.starts_with("/etc"));
2240 /// assert!(path.starts_with("/etc/"));
2241 /// assert!(path.starts_with("/etc/passwd"));
2242 /// assert!(path.starts_with("/etc/passwd/")); // extra slash is okay
2243 /// assert!(path.starts_with("/etc/passwd///")); // multiple extra slashes are okay
2245 /// assert!(!path.starts_with("/e"));
2246 /// assert!(!path.starts_with("/etc/passwd.txt"));
2248 /// assert!(!Path::new("/etc/foo.rs").starts_with("/etc/foo"));
2250 #[stable(feature = "rust1", since = "1.0.0")]
2252 pub fn starts_with<P: AsRef<Path>>(&self, base: P) -> bool {
2253 self._starts_with(base.as_ref())
2256 fn _starts_with(&self, base: &Path) -> bool {
2257 iter_after(self.components(), base.components()).is_some()
2260 /// Determines whether `child` is a suffix of `self`.
2262 /// Only considers whole path components to match.
2267 /// use std::path::Path;
2269 /// let path = Path::new("/etc/resolv.conf");
2271 /// assert!(path.ends_with("resolv.conf"));
2272 /// assert!(path.ends_with("etc/resolv.conf"));
2273 /// assert!(path.ends_with("/etc/resolv.conf"));
2275 /// assert!(!path.ends_with("/resolv.conf"));
2276 /// assert!(!path.ends_with("conf")); // use .extension() instead
2278 #[stable(feature = "rust1", since = "1.0.0")]
2280 pub fn ends_with<P: AsRef<Path>>(&self, child: P) -> bool {
2281 self._ends_with(child.as_ref())
2284 fn _ends_with(&self, child: &Path) -> bool {
2285 iter_after(self.components().rev(), child.components().rev()).is_some()
2288 /// Extracts the stem (non-extension) portion of [`self.file_name`].
2290 /// [`self.file_name`]: Path::file_name
2294 /// * [`None`], if there is no file name;
2295 /// * The entire file name if there is no embedded `.`;
2296 /// * The entire file name if the file name begins with `.` and has no other `.`s within;
2297 /// * Otherwise, the portion of the file name before the final `.`
2302 /// use std::path::Path;
2304 /// assert_eq!("foo", Path::new("foo.rs").file_stem().unwrap());
2305 /// assert_eq!("foo.tar", Path::new("foo.tar.gz").file_stem().unwrap());
2309 /// This method is similar to [`Path::file_prefix`], which extracts the portion of the file name
2310 /// before the *first* `.`
2312 /// [`Path::file_prefix`]: Path::file_prefix
2314 #[stable(feature = "rust1", since = "1.0.0")]
2316 pub fn file_stem(&self) -> Option<&OsStr> {
2317 self.file_name().map(rsplit_file_at_dot).and_then(|(before, after)| before.or(after))
2320 /// Extracts the prefix of [`self.file_name`].
2324 /// * [`None`], if there is no file name;
2325 /// * The entire file name if there is no embedded `.`;
2326 /// * The portion of the file name before the first non-beginning `.`;
2327 /// * The entire file name if the file name begins with `.` and has no other `.`s within;
2328 /// * The portion of the file name before the second `.` if the file name begins with `.`
2330 /// [`self.file_name`]: Path::file_name
2335 /// # #![feature(path_file_prefix)]
2336 /// use std::path::Path;
2338 /// assert_eq!("foo", Path::new("foo.rs").file_prefix().unwrap());
2339 /// assert_eq!("foo", Path::new("foo.tar.gz").file_prefix().unwrap());
2343 /// This method is similar to [`Path::file_stem`], which extracts the portion of the file name
2344 /// before the *last* `.`
2346 /// [`Path::file_stem`]: Path::file_stem
2348 #[unstable(feature = "path_file_prefix", issue = "86319")]
2350 pub fn file_prefix(&self) -> Option<&OsStr> {
2351 self.file_name().map(split_file_at_dot).and_then(|(before, _after)| Some(before))
2354 /// Extracts the extension of [`self.file_name`], if possible.
2356 /// The extension is:
2358 /// * [`None`], if there is no file name;
2359 /// * [`None`], if there is no embedded `.`;
2360 /// * [`None`], if the file name begins with `.` and has no other `.`s within;
2361 /// * Otherwise, the portion of the file name after the final `.`
2363 /// [`self.file_name`]: Path::file_name
2368 /// use std::path::Path;
2370 /// assert_eq!("rs", Path::new("foo.rs").extension().unwrap());
2371 /// assert_eq!("gz", Path::new("foo.tar.gz").extension().unwrap());
2373 #[stable(feature = "rust1", since = "1.0.0")]
2375 pub fn extension(&self) -> Option<&OsStr> {
2376 self.file_name().map(rsplit_file_at_dot).and_then(|(before, after)| before.and(after))
2379 /// Creates an owned [`PathBuf`] with `path` adjoined to `self`.
2381 /// See [`PathBuf::push`] for more details on what it means to adjoin a path.
2386 /// use std::path::{Path, PathBuf};
2388 /// assert_eq!(Path::new("/etc").join("passwd"), PathBuf::from("/etc/passwd"));
2390 #[stable(feature = "rust1", since = "1.0.0")]
2392 pub fn join<P: AsRef<Path>>(&self, path: P) -> PathBuf {
2393 self._join(path.as_ref())
2396 fn _join(&self, path: &Path) -> PathBuf {
2397 let mut buf = self.to_path_buf();
2402 /// Creates an owned [`PathBuf`] like `self` but with the given file name.
2404 /// See [`PathBuf::set_file_name`] for more details.
2409 /// use std::path::{Path, PathBuf};
2411 /// let path = Path::new("/tmp/foo.txt");
2412 /// assert_eq!(path.with_file_name("bar.txt"), PathBuf::from("/tmp/bar.txt"));
2414 /// let path = Path::new("/tmp");
2415 /// assert_eq!(path.with_file_name("var"), PathBuf::from("/var"));
2417 #[stable(feature = "rust1", since = "1.0.0")]
2419 pub fn with_file_name<S: AsRef<OsStr>>(&self, file_name: S) -> PathBuf {
2420 self._with_file_name(file_name.as_ref())
2423 fn _with_file_name(&self, file_name: &OsStr) -> PathBuf {
2424 let mut buf = self.to_path_buf();
2425 buf.set_file_name(file_name);
2429 /// Creates an owned [`PathBuf`] like `self` but with the given extension.
2431 /// See [`PathBuf::set_extension`] for more details.
2436 /// use std::path::{Path, PathBuf};
2438 /// let path = Path::new("foo.rs");
2439 /// assert_eq!(path.with_extension("txt"), PathBuf::from("foo.txt"));
2441 /// let path = Path::new("foo.tar.gz");
2442 /// assert_eq!(path.with_extension(""), PathBuf::from("foo.tar"));
2443 /// assert_eq!(path.with_extension("xz"), PathBuf::from("foo.tar.xz"));
2444 /// assert_eq!(path.with_extension("").with_extension("txt"), PathBuf::from("foo.txt"));
2446 #[stable(feature = "rust1", since = "1.0.0")]
2447 pub fn with_extension<S: AsRef<OsStr>>(&self, extension: S) -> PathBuf {
2448 self._with_extension(extension.as_ref())
2451 fn _with_extension(&self, extension: &OsStr) -> PathBuf {
2452 let mut buf = self.to_path_buf();
2453 buf.set_extension(extension);
2457 /// Produces an iterator over the [`Component`]s of the path.
2459 /// When parsing the path, there is a small amount of normalization:
2461 /// * Repeated separators are ignored, so `a/b` and `a//b` both have
2462 /// `a` and `b` as components.
2464 /// * Occurrences of `.` are normalized away, except if they are at the
2465 /// beginning of the path. For example, `a/./b`, `a/b/`, `a/b/.` and
2466 /// `a/b` all have `a` and `b` as components, but `./a/b` starts with
2467 /// an additional [`CurDir`] component.
2469 /// * A trailing slash is normalized away, `/a/b` and `/a/b/` are equivalent.
2471 /// Note that no other normalization takes place; in particular, `a/c`
2472 /// and `a/b/../c` are distinct, to account for the possibility that `b`
2473 /// is a symbolic link (so its parent isn't `a`).
2478 /// use std::path::{Path, Component};
2479 /// use std::ffi::OsStr;
2481 /// let mut components = Path::new("/tmp/foo.txt").components();
2483 /// assert_eq!(components.next(), Some(Component::RootDir));
2484 /// assert_eq!(components.next(), Some(Component::Normal(OsStr::new("tmp"))));
2485 /// assert_eq!(components.next(), Some(Component::Normal(OsStr::new("foo.txt"))));
2486 /// assert_eq!(components.next(), None)
2489 /// [`CurDir`]: Component::CurDir
2490 #[stable(feature = "rust1", since = "1.0.0")]
2491 pub fn components(&self) -> Components<'_> {
2492 let prefix = parse_prefix(self.as_os_str());
2494 path: self.as_u8_slice(),
2496 has_physical_root: has_physical_root(self.as_u8_slice(), prefix)
2497 || has_redox_scheme(self.as_u8_slice()),
2498 front: State::Prefix,
2503 /// Produces an iterator over the path's components viewed as [`OsStr`]
2506 /// For more information about the particulars of how the path is separated
2507 /// into components, see [`components`].
2509 /// [`components`]: Path::components
2514 /// use std::path::{self, Path};
2515 /// use std::ffi::OsStr;
2517 /// let mut it = Path::new("/tmp/foo.txt").iter();
2518 /// assert_eq!(it.next(), Some(OsStr::new(&path::MAIN_SEPARATOR.to_string())));
2519 /// assert_eq!(it.next(), Some(OsStr::new("tmp")));
2520 /// assert_eq!(it.next(), Some(OsStr::new("foo.txt")));
2521 /// assert_eq!(it.next(), None)
2523 #[stable(feature = "rust1", since = "1.0.0")]
2525 pub fn iter(&self) -> Iter<'_> {
2526 Iter { inner: self.components() }
2529 /// Returns an object that implements [`Display`] for safely printing paths
2530 /// that may contain non-Unicode data. This may perform lossy conversion,
2531 /// depending on the platform. If you would like an implementation which
2532 /// escapes the path please use [`Debug`] instead.
2534 /// [`Display`]: fmt::Display
2539 /// use std::path::Path;
2541 /// let path = Path::new("/tmp/foo.rs");
2543 /// println!("{}", path.display());
2545 #[stable(feature = "rust1", since = "1.0.0")]
2546 #[must_use = "this does not display the path, \
2547 it returns an object that can be displayed"]
2549 pub fn display(&self) -> Display<'_> {
2550 Display { path: self }
2553 /// Queries the file system to get information about a file, directory, etc.
2555 /// This function will traverse symbolic links to query information about the
2556 /// destination file.
2558 /// This is an alias to [`fs::metadata`].
2563 /// use std::path::Path;
2565 /// let path = Path::new("/Minas/tirith");
2566 /// let metadata = path.metadata().expect("metadata call failed");
2567 /// println!("{:?}", metadata.file_type());
2569 #[stable(feature = "path_ext", since = "1.5.0")]
2571 pub fn metadata(&self) -> io::Result<fs::Metadata> {
2575 /// Queries the metadata about a file without following symlinks.
2577 /// This is an alias to [`fs::symlink_metadata`].
2582 /// use std::path::Path;
2584 /// let path = Path::new("/Minas/tirith");
2585 /// let metadata = path.symlink_metadata().expect("symlink_metadata call failed");
2586 /// println!("{:?}", metadata.file_type());
2588 #[stable(feature = "path_ext", since = "1.5.0")]
2590 pub fn symlink_metadata(&self) -> io::Result<fs::Metadata> {
2591 fs::symlink_metadata(self)
2594 /// Returns the canonical, absolute form of the path with all intermediate
2595 /// components normalized and symbolic links resolved.
2597 /// This is an alias to [`fs::canonicalize`].
2602 /// use std::path::{Path, PathBuf};
2604 /// let path = Path::new("/foo/test/../test/bar.rs");
2605 /// assert_eq!(path.canonicalize().unwrap(), PathBuf::from("/foo/test/bar.rs"));
2607 #[stable(feature = "path_ext", since = "1.5.0")]
2609 pub fn canonicalize(&self) -> io::Result<PathBuf> {
2610 fs::canonicalize(self)
2613 /// Reads a symbolic link, returning the file that the link points to.
2615 /// This is an alias to [`fs::read_link`].
2620 /// use std::path::Path;
2622 /// let path = Path::new("/laputa/sky_castle.rs");
2623 /// let path_link = path.read_link().expect("read_link call failed");
2625 #[stable(feature = "path_ext", since = "1.5.0")]
2627 pub fn read_link(&self) -> io::Result<PathBuf> {
2631 /// Returns an iterator over the entries within a directory.
2633 /// The iterator will yield instances of <code>[io::Result]<[fs::DirEntry]></code>. New
2634 /// errors may be encountered after an iterator is initially constructed.
2636 /// This is an alias to [`fs::read_dir`].
2641 /// use std::path::Path;
2643 /// let path = Path::new("/laputa");
2644 /// for entry in path.read_dir().expect("read_dir call failed") {
2645 /// if let Ok(entry) = entry {
2646 /// println!("{:?}", entry.path());
2650 #[stable(feature = "path_ext", since = "1.5.0")]
2652 pub fn read_dir(&self) -> io::Result<fs::ReadDir> {
2656 /// Returns `true` if the path points at an existing entity.
2658 /// This function will traverse symbolic links to query information about the
2659 /// destination file.
2661 /// If you cannot access the metadata of the file, e.g. because of a
2662 /// permission error or broken symbolic links, this will return `false`.
2667 /// use std::path::Path;
2668 /// assert!(!Path::new("does_not_exist.txt").exists());
2673 /// This is a convenience function that coerces errors to false. If you want to
2674 /// check errors, call [`fs::metadata`].
2675 #[stable(feature = "path_ext", since = "1.5.0")]
2678 pub fn exists(&self) -> bool {
2679 fs::metadata(self).is_ok()
2682 /// Returns `Ok(true)` if the path points at an existing entity.
2684 /// This function will traverse symbolic links to query information about the
2685 /// destination file. In case of broken symbolic links this will return `Ok(false)`.
2687 /// As opposed to the `exists()` method, this one doesn't silently ignore errors
2688 /// unrelated to the path not existing. (E.g. it will return `Err(_)` in case of permission
2689 /// denied on some of the parent directories.)
2694 /// #![feature(path_try_exists)]
2696 /// use std::path::Path;
2697 /// assert!(!Path::new("does_not_exist.txt").try_exists().expect("Can't check existence of file does_not_exist.txt"));
2698 /// assert!(Path::new("/root/secret_file.txt").try_exists().is_err());
2700 // FIXME: stabilization should modify documentation of `exists()` to recommend this method
2702 #[unstable(feature = "path_try_exists", issue = "83186")]
2704 pub fn try_exists(&self) -> io::Result<bool> {
2705 fs::try_exists(self)
2708 /// Returns `true` if the path exists on disk and is pointing at a regular file.
2710 /// This function will traverse symbolic links to query information about the
2711 /// destination file.
2713 /// If you cannot access the metadata of the file, e.g. because of a
2714 /// permission error or broken symbolic links, this will return `false`.
2719 /// use std::path::Path;
2720 /// assert_eq!(Path::new("./is_a_directory/").is_file(), false);
2721 /// assert_eq!(Path::new("a_file.txt").is_file(), true);
2726 /// This is a convenience function that coerces errors to false. If you want to
2727 /// check errors, call [`fs::metadata`] and handle its [`Result`]. Then call
2728 /// [`fs::Metadata::is_file`] if it was [`Ok`].
2730 /// When the goal is simply to read from (or write to) the source, the most
2731 /// reliable way to test the source can be read (or written to) is to open
2732 /// it. Only using `is_file` can break workflows like `diff <( prog_a )` on
2733 /// a Unix-like system for example. See [`fs::File::open`] or
2734 /// [`fs::OpenOptions::open`] for more information.
2735 #[stable(feature = "path_ext", since = "1.5.0")]
2737 pub fn is_file(&self) -> bool {
2738 fs::metadata(self).map(|m| m.is_file()).unwrap_or(false)
2741 /// Returns `true` if the path exists on disk and is pointing at a directory.
2743 /// This function will traverse symbolic links to query information about the
2744 /// destination file.
2746 /// If you cannot access the metadata of the file, e.g. because of a
2747 /// permission error or broken symbolic links, this will return `false`.
2752 /// use std::path::Path;
2753 /// assert_eq!(Path::new("./is_a_directory/").is_dir(), true);
2754 /// assert_eq!(Path::new("a_file.txt").is_dir(), false);
2759 /// This is a convenience function that coerces errors to false. If you want to
2760 /// check errors, call [`fs::metadata`] and handle its [`Result`]. Then call
2761 /// [`fs::Metadata::is_dir`] if it was [`Ok`].
2762 #[stable(feature = "path_ext", since = "1.5.0")]
2764 pub fn is_dir(&self) -> bool {
2765 fs::metadata(self).map(|m| m.is_dir()).unwrap_or(false)
2768 /// Returns `true` if the path exists on disk and is pointing at a symbolic link.
2770 /// This function will not traverse symbolic links.
2771 /// In case of a broken symbolic link this will also return true.
2773 /// If you cannot access the directory containing the file, e.g., because of a
2774 /// permission error, this will return false.
2778 #[cfg_attr(unix, doc = "```no_run")]
2779 #[cfg_attr(not(unix), doc = "```ignore")]
2780 /// use std::path::Path;
2781 /// use std::os::unix::fs::symlink;
2783 /// let link_path = Path::new("link");
2784 /// symlink("/origin_does_not_exists/", link_path).unwrap();
2785 /// assert_eq!(link_path.is_symlink(), true);
2786 /// assert_eq!(link_path.exists(), false);
2791 /// This is a convenience function that coerces errors to false. If you want to
2792 /// check errors, call [`fs::symlink_metadata`] and handle its [`Result`]. Then call
2793 /// [`fs::Metadata::is_symlink`] if it was [`Ok`].
2795 #[stable(feature = "is_symlink", since = "1.57.0")]
2796 pub fn is_symlink(&self) -> bool {
2797 fs::symlink_metadata(self).map(|m| m.is_symlink()).unwrap_or(false)
2800 /// Converts a [`Box<Path>`](Box) into a [`PathBuf`] without copying or
2802 #[stable(feature = "into_boxed_path", since = "1.20.0")]
2803 #[must_use = "`self` will be dropped if the result is not used"]
2804 pub fn into_path_buf(self: Box<Path>) -> PathBuf {
2805 let rw = Box::into_raw(self) as *mut OsStr;
2806 let inner = unsafe { Box::from_raw(rw) };
2807 PathBuf { inner: OsString::from(inner) }
2811 #[stable(feature = "rust1", since = "1.0.0")]
2812 impl AsRef<OsStr> for Path {
2814 fn as_ref(&self) -> &OsStr {
2819 #[stable(feature = "rust1", since = "1.0.0")]
2820 impl fmt::Debug for Path {
2821 fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
2822 fmt::Debug::fmt(&self.inner, formatter)
2826 /// Helper struct for safely printing paths with [`format!`] and `{}`.
2828 /// A [`Path`] might contain non-Unicode data. This `struct` implements the
2829 /// [`Display`] trait in a way that mitigates that. It is created by the
2830 /// [`display`](Path::display) method on [`Path`]. This may perform lossy
2831 /// conversion, depending on the platform. If you would like an implementation
2832 /// which escapes the path please use [`Debug`] instead.
2837 /// use std::path::Path;
2839 /// let path = Path::new("/tmp/foo.rs");
2841 /// println!("{}", path.display());
2844 /// [`Display`]: fmt::Display
2845 /// [`format!`]: crate::format
2846 #[stable(feature = "rust1", since = "1.0.0")]
2847 pub struct Display<'a> {
2851 #[stable(feature = "rust1", since = "1.0.0")]
2852 impl fmt::Debug for Display<'_> {
2853 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2854 fmt::Debug::fmt(&self.path, f)
2858 #[stable(feature = "rust1", since = "1.0.0")]
2859 impl fmt::Display for Display<'_> {
2860 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2861 self.path.inner.display(f)
2865 #[stable(feature = "rust1", since = "1.0.0")]
2866 impl cmp::PartialEq for Path {
2868 fn eq(&self, other: &Path) -> bool {
2869 self.components() == other.components()
2873 #[stable(feature = "rust1", since = "1.0.0")]
2874 impl Hash for Path {
2875 fn hash<H: Hasher>(&self, h: &mut H) {
2876 for component in self.components() {
2882 #[stable(feature = "rust1", since = "1.0.0")]
2883 impl cmp::Eq for Path {}
2885 #[stable(feature = "rust1", since = "1.0.0")]
2886 impl cmp::PartialOrd for Path {
2888 fn partial_cmp(&self, other: &Path) -> Option<cmp::Ordering> {
2889 Some(compare_components(self.components(), other.components()))
2893 #[stable(feature = "rust1", since = "1.0.0")]
2894 impl cmp::Ord for Path {
2896 fn cmp(&self, other: &Path) -> cmp::Ordering {
2897 compare_components(self.components(), other.components())
2901 #[stable(feature = "rust1", since = "1.0.0")]
2902 impl AsRef<Path> for Path {
2904 fn as_ref(&self) -> &Path {
2909 #[stable(feature = "rust1", since = "1.0.0")]
2910 impl AsRef<Path> for OsStr {
2912 fn as_ref(&self) -> &Path {
2917 #[stable(feature = "cow_os_str_as_ref_path", since = "1.8.0")]
2918 impl AsRef<Path> for Cow<'_, OsStr> {
2920 fn as_ref(&self) -> &Path {
2925 #[stable(feature = "rust1", since = "1.0.0")]
2926 impl AsRef<Path> for OsString {
2928 fn as_ref(&self) -> &Path {
2933 #[stable(feature = "rust1", since = "1.0.0")]
2934 impl AsRef<Path> for str {
2936 fn as_ref(&self) -> &Path {
2941 #[stable(feature = "rust1", since = "1.0.0")]
2942 impl AsRef<Path> for String {
2944 fn as_ref(&self) -> &Path {
2949 #[stable(feature = "rust1", since = "1.0.0")]
2950 impl AsRef<Path> for PathBuf {
2952 fn as_ref(&self) -> &Path {
2957 #[stable(feature = "path_into_iter", since = "1.6.0")]
2958 impl<'a> IntoIterator for &'a PathBuf {
2959 type Item = &'a OsStr;
2960 type IntoIter = Iter<'a>;
2962 fn into_iter(self) -> Iter<'a> {
2967 #[stable(feature = "path_into_iter", since = "1.6.0")]
2968 impl<'a> IntoIterator for &'a Path {
2969 type Item = &'a OsStr;
2970 type IntoIter = Iter<'a>;
2972 fn into_iter(self) -> Iter<'a> {
2977 macro_rules! impl_cmp {
2978 ($lhs:ty, $rhs: ty) => {
2979 #[stable(feature = "partialeq_path", since = "1.6.0")]
2980 impl<'a, 'b> PartialEq<$rhs> for $lhs {
2982 fn eq(&self, other: &$rhs) -> bool {
2983 <Path as PartialEq>::eq(self, other)
2987 #[stable(feature = "partialeq_path", since = "1.6.0")]
2988 impl<'a, 'b> PartialEq<$lhs> for $rhs {
2990 fn eq(&self, other: &$lhs) -> bool {
2991 <Path as PartialEq>::eq(self, other)
2995 #[stable(feature = "cmp_path", since = "1.8.0")]
2996 impl<'a, 'b> PartialOrd<$rhs> for $lhs {
2998 fn partial_cmp(&self, other: &$rhs) -> Option<cmp::Ordering> {
2999 <Path as PartialOrd>::partial_cmp(self, other)
3003 #[stable(feature = "cmp_path", since = "1.8.0")]
3004 impl<'a, 'b> PartialOrd<$lhs> for $rhs {
3006 fn partial_cmp(&self, other: &$lhs) -> Option<cmp::Ordering> {
3007 <Path as PartialOrd>::partial_cmp(self, other)
3013 impl_cmp!(PathBuf, Path);
3014 impl_cmp!(PathBuf, &'a Path);
3015 impl_cmp!(Cow<'a, Path>, Path);
3016 impl_cmp!(Cow<'a, Path>, &'b Path);
3017 impl_cmp!(Cow<'a, Path>, PathBuf);
3019 macro_rules! impl_cmp_os_str {
3020 ($lhs:ty, $rhs: ty) => {
3021 #[stable(feature = "cmp_path", since = "1.8.0")]
3022 impl<'a, 'b> PartialEq<$rhs> for $lhs {
3024 fn eq(&self, other: &$rhs) -> bool {
3025 <Path as PartialEq>::eq(self, other.as_ref())
3029 #[stable(feature = "cmp_path", since = "1.8.0")]
3030 impl<'a, 'b> PartialEq<$lhs> for $rhs {
3032 fn eq(&self, other: &$lhs) -> bool {
3033 <Path as PartialEq>::eq(self.as_ref(), other)
3037 #[stable(feature = "cmp_path", since = "1.8.0")]
3038 impl<'a, 'b> PartialOrd<$rhs> for $lhs {
3040 fn partial_cmp(&self, other: &$rhs) -> Option<cmp::Ordering> {
3041 <Path as PartialOrd>::partial_cmp(self, other.as_ref())
3045 #[stable(feature = "cmp_path", since = "1.8.0")]
3046 impl<'a, 'b> PartialOrd<$lhs> for $rhs {
3048 fn partial_cmp(&self, other: &$lhs) -> Option<cmp::Ordering> {
3049 <Path as PartialOrd>::partial_cmp(self.as_ref(), other)
3055 impl_cmp_os_str!(PathBuf, OsStr);
3056 impl_cmp_os_str!(PathBuf, &'a OsStr);
3057 impl_cmp_os_str!(PathBuf, Cow<'a, OsStr>);
3058 impl_cmp_os_str!(PathBuf, OsString);
3059 impl_cmp_os_str!(Path, OsStr);
3060 impl_cmp_os_str!(Path, &'a OsStr);
3061 impl_cmp_os_str!(Path, Cow<'a, OsStr>);
3062 impl_cmp_os_str!(Path, OsString);
3063 impl_cmp_os_str!(&'a Path, OsStr);
3064 impl_cmp_os_str!(&'a Path, Cow<'b, OsStr>);
3065 impl_cmp_os_str!(&'a Path, OsString);
3066 impl_cmp_os_str!(Cow<'a, Path>, OsStr);
3067 impl_cmp_os_str!(Cow<'a, Path>, &'b OsStr);
3068 impl_cmp_os_str!(Cow<'a, Path>, OsString);
3070 #[stable(since = "1.7.0", feature = "strip_prefix")]
3071 impl fmt::Display for StripPrefixError {
3072 #[allow(deprecated, deprecated_in_future)]
3073 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
3074 self.description().fmt(f)
3078 #[stable(since = "1.7.0", feature = "strip_prefix")]
3079 impl Error for StripPrefixError {
3080 #[allow(deprecated)]
3081 fn description(&self) -> &str {