1 // ignore-tidy-filelength
3 //! Cross-platform path manipulation.
5 //! This module provides two types, [`PathBuf`] and [`Path`] (akin to [`String`]
6 //! and [`str`]), for working with paths abstractly. These types are thin wrappers
7 //! around [`OsString`] and [`OsStr`] respectively, meaning that they work directly
8 //! on strings according to the local platform's path syntax.
10 //! Paths can be parsed into [`Component`]s by iterating over the structure
11 //! returned by the [`components`] method on [`Path`]. [`Component`]s roughly
12 //! correspond to the substrings between path separators (`/` or `\`). You can
13 //! reconstruct an equivalent path from components with the [`push`] method on
14 //! [`PathBuf`]; note that the paths may differ syntactically by the
15 //! normalization described in the documentation for the [`components`] method.
19 //! Path manipulation includes both parsing components from slices and building
22 //! To parse a path, you can create a [`Path`] slice from a [`str`]
23 //! slice and start asking questions:
26 //! use std::path::Path;
27 //! use std::ffi::OsStr;
29 //! let path = Path::new("/tmp/foo/bar.txt");
31 //! let parent = path.parent();
32 //! assert_eq!(parent, Some(Path::new("/tmp/foo")));
34 //! let file_stem = path.file_stem();
35 //! assert_eq!(file_stem, Some(OsStr::new("bar")));
37 //! let extension = path.extension();
38 //! assert_eq!(extension, Some(OsStr::new("txt")));
41 //! To build or modify paths, use [`PathBuf`]:
44 //! use std::path::PathBuf;
46 //! // This way works...
47 //! let mut path = PathBuf::from("c:\\");
49 //! path.push("windows");
50 //! path.push("system32");
52 //! path.set_extension("dll");
54 //! // ... but push is best used if you don't know everything up
55 //! // front. If you do, this way is better:
56 //! let path: PathBuf = ["c:\\", "windows", "system32.dll"].iter().collect();
59 //! [`Component`]: ../../std/path/enum.Component.html
60 //! [`components`]: ../../std/path/struct.Path.html#method.components
61 //! [`PathBuf`]: ../../std/path/struct.PathBuf.html
62 //! [`Path`]: ../../std/path/struct.Path.html
63 //! [`push`]: ../../std/path/struct.PathBuf.html#method.push
64 //! [`String`]: ../../std/string/struct.String.html
66 //! [`str`]: ../../std/primitive.str.html
67 //! [`OsString`]: ../../std/ffi/struct.OsString.html
68 //! [`OsStr`]: ../../std/ffi/struct.OsStr.html
70 #![stable(feature = "rust1", since = "1.0.0")]
72 use crate::borrow::{Borrow, Cow};
74 use crate::error::Error;
77 use crate::hash::{Hash, Hasher};
79 use crate::iter::{self, FusedIterator};
80 use crate::ops::{self, Deref};
82 use crate::str::FromStr;
85 use crate::ffi::{OsStr, OsString};
87 use crate::sys::path::{is_sep_byte, is_verbatim_sep, parse_prefix, MAIN_SEP_STR};
89 ////////////////////////////////////////////////////////////////////////////////
91 ////////////////////////////////////////////////////////////////////////////////
93 // Parsing in this module is done by directly transmuting OsStr to [u8] slices,
94 // taking advantage of the fact that OsStr always encodes ASCII characters
95 // as-is. Eventually, this transmutation should be replaced by direct uses of
96 // OsStr APIs for parsing, but it will take a while for those to become
99 ////////////////////////////////////////////////////////////////////////////////
101 ////////////////////////////////////////////////////////////////////////////////
103 /// Windows path prefixes, e.g., `C:` or `\\server\share`.
105 /// Windows uses a variety of path prefix styles, including references to drive
106 /// volumes (like `C:`), network shared folders (like `\\server\share`), and
107 /// others. In addition, some path prefixes are "verbatim" (i.e., prefixed with
108 /// `\\?\`), in which case `/` is *not* treated as a separator and essentially
109 /// no normalization is performed.
114 /// use std::path::{Component, Path, Prefix};
115 /// use std::path::Prefix::*;
116 /// use std::ffi::OsStr;
118 /// fn get_path_prefix(s: &str) -> Prefix {
119 /// let path = Path::new(s);
120 /// match path.components().next().unwrap() {
121 /// Component::Prefix(prefix_component) => prefix_component.kind(),
126 /// # if cfg!(windows) {
127 /// assert_eq!(Verbatim(OsStr::new("pictures")),
128 /// get_path_prefix(r"\\?\pictures\kittens"));
129 /// assert_eq!(VerbatimUNC(OsStr::new("server"), OsStr::new("share")),
130 /// get_path_prefix(r"\\?\UNC\server\share"));
131 /// assert_eq!(VerbatimDisk(b'C'), get_path_prefix(r"\\?\c:\"));
132 /// assert_eq!(DeviceNS(OsStr::new("BrainInterface")),
133 /// get_path_prefix(r"\\.\BrainInterface"));
134 /// assert_eq!(UNC(OsStr::new("server"), OsStr::new("share")),
135 /// get_path_prefix(r"\\server\share"));
136 /// assert_eq!(Disk(b'C'), get_path_prefix(r"C:\Users\Rust\Pictures\Ferris"));
139 #[derive(Copy, Clone, Debug, Hash, PartialOrd, Ord, PartialEq, Eq)]
140 #[stable(feature = "rust1", since = "1.0.0")]
141 pub enum Prefix<'a> {
142 /// Verbatim prefix, e.g., `\\?\cat_pics`.
144 /// Verbatim prefixes consist of `\\?\` immediately followed by the given
146 #[stable(feature = "rust1", since = "1.0.0")]
147 Verbatim(#[stable(feature = "rust1", since = "1.0.0")] &'a OsStr),
149 /// Verbatim prefix using Windows' _**U**niform **N**aming **C**onvention_,
150 /// e.g., `\\?\UNC\server\share`.
152 /// Verbatim UNC prefixes consist of `\\?\UNC\` immediately followed by the
153 /// server's hostname and a share name.
154 #[stable(feature = "rust1", since = "1.0.0")]
156 #[stable(feature = "rust1", since = "1.0.0")] &'a OsStr,
157 #[stable(feature = "rust1", since = "1.0.0")] &'a OsStr,
160 /// Verbatim disk prefix, e.g., `\\?\C:\`.
162 /// Verbatim disk prefixes consist of `\\?\` immediately followed by the
163 /// drive letter and `:\`.
164 #[stable(feature = "rust1", since = "1.0.0")]
165 VerbatimDisk(#[stable(feature = "rust1", since = "1.0.0")] u8),
167 /// Device namespace prefix, e.g., `\\.\COM42`.
169 /// Device namespace prefixes consist of `\\.\` immediately followed by the
171 #[stable(feature = "rust1", since = "1.0.0")]
172 DeviceNS(#[stable(feature = "rust1", since = "1.0.0")] &'a OsStr),
174 /// Prefix using Windows' _**U**niform **N**aming **C**onvention_, e.g.
175 /// `\\server\share`.
177 /// UNC prefixes consist of the server's hostname and a share name.
178 #[stable(feature = "rust1", since = "1.0.0")]
180 #[stable(feature = "rust1", since = "1.0.0")] &'a OsStr,
181 #[stable(feature = "rust1", since = "1.0.0")] &'a OsStr,
184 /// Prefix `C:` for the given disk drive.
185 #[stable(feature = "rust1", since = "1.0.0")]
186 Disk(#[stable(feature = "rust1", since = "1.0.0")] u8),
189 impl<'a> Prefix<'a> {
191 fn len(&self) -> usize {
193 fn os_str_len(s: &OsStr) -> usize {
194 os_str_as_u8_slice(s).len()
197 Verbatim(x) => 4 + os_str_len(x),
198 VerbatimUNC(x, y) => {
199 8 + os_str_len(x) + if os_str_len(y) > 0 { 1 + os_str_len(y) } else { 0 }
201 VerbatimDisk(_) => 6,
202 UNC(x, y) => 2 + os_str_len(x) + if os_str_len(y) > 0 { 1 + os_str_len(y) } else { 0 },
203 DeviceNS(x) => 4 + os_str_len(x),
208 /// Determines if the prefix is verbatim, i.e., begins with `\\?\`.
213 /// use std::path::Prefix::*;
214 /// use std::ffi::OsStr;
216 /// assert!(Verbatim(OsStr::new("pictures")).is_verbatim());
217 /// assert!(VerbatimUNC(OsStr::new("server"), OsStr::new("share")).is_verbatim());
218 /// assert!(VerbatimDisk(b'C').is_verbatim());
219 /// assert!(!DeviceNS(OsStr::new("BrainInterface")).is_verbatim());
220 /// assert!(!UNC(OsStr::new("server"), OsStr::new("share")).is_verbatim());
221 /// assert!(!Disk(b'C').is_verbatim());
224 #[stable(feature = "rust1", since = "1.0.0")]
225 pub fn is_verbatim(&self) -> bool {
227 matches!(*self, Verbatim(_) | VerbatimDisk(_) | VerbatimUNC(..))
231 fn is_drive(&self) -> bool {
232 matches!(*self, Prefix::Disk(_))
236 fn has_implicit_root(&self) -> bool {
241 ////////////////////////////////////////////////////////////////////////////////
242 // Exposed parsing helpers
243 ////////////////////////////////////////////////////////////////////////////////
245 /// Determines whether the character is one of the permitted path
246 /// separators for the current platform.
253 /// assert!(path::is_separator('/')); // '/' works for both Unix and Windows
254 /// assert!(!path::is_separator('❤'));
256 #[stable(feature = "rust1", since = "1.0.0")]
257 pub fn is_separator(c: char) -> bool {
258 c.is_ascii() && is_sep_byte(c as u8)
261 /// The primary separator of path components for the current platform.
263 /// For example, `/` on Unix and `\` on Windows.
264 #[stable(feature = "rust1", since = "1.0.0")]
265 pub const MAIN_SEPARATOR: char = crate::sys::path::MAIN_SEP;
267 ////////////////////////////////////////////////////////////////////////////////
269 ////////////////////////////////////////////////////////////////////////////////
271 // Iterate through `iter` while it matches `prefix`; return `None` if `prefix`
272 // is not a prefix of `iter`, otherwise return `Some(iter_after_prefix)` giving
273 // `iter` after having exhausted `prefix`.
274 fn iter_after<'a, 'b, I, J>(mut iter: I, mut prefix: J) -> Option<I>
276 I: Iterator<Item = Component<'a>> + Clone,
277 J: Iterator<Item = Component<'b>>,
280 let mut iter_next = iter.clone();
281 match (iter_next.next(), prefix.next()) {
282 (Some(ref x), Some(ref y)) if x == y => (),
283 (Some(_), Some(_)) => return None,
284 (Some(_), None) => return Some(iter),
285 (None, None) => return Some(iter),
286 (None, Some(_)) => return None,
292 // See note at the top of this module to understand why these are used:
294 // These casts are safe as OsStr is internally a wrapper around [u8] on all
297 // Note that currently this relies on the special knowledge that libstd has;
298 // these types are single-element structs but are not marked repr(transparent)
299 // or repr(C) which would make these casts allowable outside std.
300 fn os_str_as_u8_slice(s: &OsStr) -> &[u8] {
301 unsafe { &*(s as *const OsStr as *const [u8]) }
303 unsafe fn u8_slice_as_os_str(s: &[u8]) -> &OsStr {
304 &*(s as *const [u8] as *const OsStr)
307 // Detect scheme on Redox
308 fn has_redox_scheme(s: &[u8]) -> bool {
309 cfg!(target_os = "redox") && s.contains(&b':')
312 ////////////////////////////////////////////////////////////////////////////////
313 // Cross-platform, iterator-independent parsing
314 ////////////////////////////////////////////////////////////////////////////////
316 /// Says whether the first byte after the prefix is a separator.
317 fn has_physical_root(s: &[u8], prefix: Option<Prefix<'_>>) -> bool {
318 let path = if let Some(p) = prefix { &s[p.len()..] } else { s };
319 !path.is_empty() && is_sep_byte(path[0])
322 // basic workhorse for splitting stem and extension
323 fn split_file_at_dot(file: &OsStr) -> (Option<&OsStr>, Option<&OsStr>) {
325 if os_str_as_u8_slice(file) == b".." {
326 return (Some(file), None);
329 // The unsafety here stems from converting between &OsStr and &[u8]
330 // and back. This is safe to do because (1) we only look at ASCII
331 // contents of the encoding and (2) new &OsStr values are produced
332 // only from ASCII-bounded slices of existing &OsStr values.
334 let mut iter = os_str_as_u8_slice(file).rsplitn(2, |b| *b == b'.');
335 let after = iter.next();
336 let before = iter.next();
337 if before == Some(b"") {
340 (before.map(|s| u8_slice_as_os_str(s)), after.map(|s| u8_slice_as_os_str(s)))
345 ////////////////////////////////////////////////////////////////////////////////
346 // The core iterators
347 ////////////////////////////////////////////////////////////////////////////////
349 /// Component parsing works by a double-ended state machine; the cursors at the
350 /// front and back of the path each keep track of what parts of the path have
351 /// been consumed so far.
353 /// Going front to back, a path is made up of a prefix, a starting
354 /// directory component, and a body (of normal components)
355 #[derive(Copy, Clone, PartialEq, PartialOrd, Debug)]
358 StartDir = 1, // / or . or nothing
359 Body = 2, // foo/bar/baz
363 /// A structure wrapping a Windows path prefix as well as its unparsed string
366 /// In addition to the parsed [`Prefix`] information returned by [`kind`],
367 /// `PrefixComponent` also holds the raw and unparsed [`OsStr`] slice,
368 /// returned by [`as_os_str`].
370 /// Instances of this `struct` can be obtained by matching against the
371 /// [`Prefix` variant] on [`Component`].
373 /// Does not occur on Unix.
378 /// # if cfg!(windows) {
379 /// use std::path::{Component, Path, Prefix};
380 /// use std::ffi::OsStr;
382 /// let path = Path::new(r"c:\you\later\");
383 /// match path.components().next().unwrap() {
384 /// Component::Prefix(prefix_component) => {
385 /// assert_eq!(Prefix::Disk(b'C'), prefix_component.kind());
386 /// assert_eq!(OsStr::new("c:"), prefix_component.as_os_str());
388 /// _ => unreachable!(),
393 /// [`as_os_str`]: #method.as_os_str
394 /// [`Component`]: enum.Component.html
395 /// [`kind`]: #method.kind
396 /// [`OsStr`]: ../../std/ffi/struct.OsStr.html
397 /// [`Prefix` variant]: enum.Component.html#variant.Prefix
398 /// [`Prefix`]: enum.Prefix.html
399 #[stable(feature = "rust1", since = "1.0.0")]
400 #[derive(Copy, Clone, Eq, Debug)]
401 pub struct PrefixComponent<'a> {
402 /// The prefix as an unparsed `OsStr` slice.
405 /// The parsed prefix data.
409 impl<'a> PrefixComponent<'a> {
410 /// Returns the parsed prefix data.
412 /// See [`Prefix`]'s documentation for more information on the different
413 /// kinds of prefixes.
415 /// [`Prefix`]: enum.Prefix.html
416 #[stable(feature = "rust1", since = "1.0.0")]
417 pub fn kind(&self) -> Prefix<'a> {
421 /// Returns the raw [`OsStr`] slice for this prefix.
423 /// [`OsStr`]: ../../std/ffi/struct.OsStr.html
424 #[stable(feature = "rust1", since = "1.0.0")]
425 pub fn as_os_str(&self) -> &'a OsStr {
430 #[stable(feature = "rust1", since = "1.0.0")]
431 impl<'a> cmp::PartialEq for PrefixComponent<'a> {
432 fn eq(&self, other: &PrefixComponent<'a>) -> bool {
433 cmp::PartialEq::eq(&self.parsed, &other.parsed)
437 #[stable(feature = "rust1", since = "1.0.0")]
438 impl<'a> cmp::PartialOrd for PrefixComponent<'a> {
439 fn partial_cmp(&self, other: &PrefixComponent<'a>) -> Option<cmp::Ordering> {
440 cmp::PartialOrd::partial_cmp(&self.parsed, &other.parsed)
444 #[stable(feature = "rust1", since = "1.0.0")]
445 impl cmp::Ord for PrefixComponent<'_> {
446 fn cmp(&self, other: &Self) -> cmp::Ordering {
447 cmp::Ord::cmp(&self.parsed, &other.parsed)
451 #[stable(feature = "rust1", since = "1.0.0")]
452 impl Hash for PrefixComponent<'_> {
453 fn hash<H: Hasher>(&self, h: &mut H) {
458 /// A single component of a path.
460 /// A `Component` roughly corresponds to a substring between path separators
463 /// This `enum` is created by iterating over [`Components`], which in turn is
464 /// created by the [`components`][`Path::components`] method on [`Path`].
469 /// use std::path::{Component, Path};
471 /// let path = Path::new("/tmp/foo/bar.txt");
472 /// let components = path.components().collect::<Vec<_>>();
473 /// assert_eq!(&components, &[
474 /// Component::RootDir,
475 /// Component::Normal("tmp".as_ref()),
476 /// Component::Normal("foo".as_ref()),
477 /// Component::Normal("bar.txt".as_ref()),
481 /// [`Components`]: struct.Components.html
482 /// [`Path`]: struct.Path.html
483 /// [`Path::components`]: struct.Path.html#method.components
484 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
485 #[stable(feature = "rust1", since = "1.0.0")]
486 pub enum Component<'a> {
487 /// A Windows path prefix, e.g., `C:` or `\\server\share`.
489 /// There is a large variety of prefix types, see [`Prefix`]'s documentation
492 /// Does not occur on Unix.
494 /// [`Prefix`]: enum.Prefix.html
495 #[stable(feature = "rust1", since = "1.0.0")]
496 Prefix(#[stable(feature = "rust1", since = "1.0.0")] PrefixComponent<'a>),
498 /// The root directory component, appears after any prefix and before anything else.
500 /// It represents a separator that designates that a path starts from root.
501 #[stable(feature = "rust1", since = "1.0.0")]
504 /// A reference to the current directory, i.e., `.`.
505 #[stable(feature = "rust1", since = "1.0.0")]
508 /// A reference to the parent directory, i.e., `..`.
509 #[stable(feature = "rust1", since = "1.0.0")]
512 /// A normal component, e.g., `a` and `b` in `a/b`.
514 /// This variant is the most common one, it represents references to files
516 #[stable(feature = "rust1", since = "1.0.0")]
517 Normal(#[stable(feature = "rust1", since = "1.0.0")] &'a OsStr),
520 impl<'a> Component<'a> {
521 /// Extracts the underlying [`OsStr`] slice.
526 /// use std::path::Path;
528 /// let path = Path::new("./tmp/foo/bar.txt");
529 /// let components: Vec<_> = path.components().map(|comp| comp.as_os_str()).collect();
530 /// assert_eq!(&components, &[".", "tmp", "foo", "bar.txt"]);
533 /// [`OsStr`]: ../../std/ffi/struct.OsStr.html
534 #[stable(feature = "rust1", since = "1.0.0")]
535 pub fn as_os_str(self) -> &'a OsStr {
537 Component::Prefix(p) => p.as_os_str(),
538 Component::RootDir => OsStr::new(MAIN_SEP_STR),
539 Component::CurDir => OsStr::new("."),
540 Component::ParentDir => OsStr::new(".."),
541 Component::Normal(path) => path,
546 #[stable(feature = "rust1", since = "1.0.0")]
547 impl AsRef<OsStr> for Component<'_> {
548 fn as_ref(&self) -> &OsStr {
553 #[stable(feature = "path_component_asref", since = "1.25.0")]
554 impl AsRef<Path> for Component<'_> {
555 fn as_ref(&self) -> &Path {
556 self.as_os_str().as_ref()
560 /// An iterator over the [`Component`]s of a [`Path`].
562 /// This `struct` is created by the [`components`] method on [`Path`].
563 /// See its documentation for more.
568 /// use std::path::Path;
570 /// let path = Path::new("/tmp/foo/bar.txt");
572 /// for component in path.components() {
573 /// println!("{:?}", component);
577 /// [`Component`]: enum.Component.html
578 /// [`components`]: struct.Path.html#method.components
579 /// [`Path`]: struct.Path.html
581 #[stable(feature = "rust1", since = "1.0.0")]
582 pub struct Components<'a> {
583 // The path left to parse components from
586 // The prefix as it was originally parsed, if any
587 prefix: Option<Prefix<'a>>,
589 // true if path *physically* has a root separator; for most Windows
590 // prefixes, it may have a "logical" rootseparator for the purposes of
591 // normalization, e.g., \\server\share == \\server\share\.
592 has_physical_root: bool,
594 // The iterator is double-ended, and these two states keep track of what has
595 // been produced from either end
600 /// An iterator over the [`Component`]s of a [`Path`], as [`OsStr`] slices.
602 /// This `struct` is created by the [`iter`] method on [`Path`].
603 /// See its documentation for more.
605 /// [`Component`]: enum.Component.html
606 /// [`iter`]: struct.Path.html#method.iter
607 /// [`OsStr`]: ../../std/ffi/struct.OsStr.html
608 /// [`Path`]: struct.Path.html
610 #[stable(feature = "rust1", since = "1.0.0")]
611 pub struct Iter<'a> {
612 inner: Components<'a>,
615 #[stable(feature = "path_components_debug", since = "1.13.0")]
616 impl fmt::Debug for Components<'_> {
617 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
618 struct DebugHelper<'a>(&'a Path);
620 impl fmt::Debug for DebugHelper<'_> {
621 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
622 f.debug_list().entries(self.0.components()).finish()
626 f.debug_tuple("Components").field(&DebugHelper(self.as_path())).finish()
630 impl<'a> Components<'a> {
631 // how long is the prefix, if any?
633 fn prefix_len(&self) -> usize {
634 self.prefix.as_ref().map(Prefix::len).unwrap_or(0)
638 fn prefix_verbatim(&self) -> bool {
639 self.prefix.as_ref().map(Prefix::is_verbatim).unwrap_or(false)
642 /// how much of the prefix is left from the point of view of iteration?
644 fn prefix_remaining(&self) -> usize {
645 if self.front == State::Prefix { self.prefix_len() } else { 0 }
648 // Given the iteration so far, how much of the pre-State::Body path is left?
650 fn len_before_body(&self) -> usize {
651 let root = if self.front <= State::StartDir && self.has_physical_root { 1 } else { 0 };
652 let cur_dir = if self.front <= State::StartDir && self.include_cur_dir() { 1 } else { 0 };
653 self.prefix_remaining() + root + cur_dir
656 // is the iteration complete?
658 fn finished(&self) -> bool {
659 self.front == State::Done || self.back == State::Done || self.front > self.back
663 fn is_sep_byte(&self, b: u8) -> bool {
664 if self.prefix_verbatim() { is_verbatim_sep(b) } else { is_sep_byte(b) }
667 /// Extracts a slice corresponding to the portion of the path remaining for iteration.
672 /// use std::path::Path;
674 /// let mut components = Path::new("/tmp/foo/bar.txt").components();
675 /// components.next();
676 /// components.next();
678 /// assert_eq!(Path::new("foo/bar.txt"), components.as_path());
680 #[stable(feature = "rust1", since = "1.0.0")]
681 pub fn as_path(&self) -> &'a Path {
682 let mut comps = self.clone();
683 if comps.front == State::Body {
686 if comps.back == State::Body {
689 unsafe { Path::from_u8_slice(comps.path) }
692 /// Is the *original* path rooted?
693 fn has_root(&self) -> bool {
694 if self.has_physical_root {
697 if let Some(p) = self.prefix {
698 if p.has_implicit_root() {
705 /// Should the normalized path include a leading . ?
706 fn include_cur_dir(&self) -> bool {
710 let mut iter = self.path[self.prefix_len()..].iter();
711 match (iter.next(), iter.next()) {
712 (Some(&b'.'), None) => true,
713 (Some(&b'.'), Some(&b)) => self.is_sep_byte(b),
718 // parse a given byte sequence into the corresponding path component
719 fn parse_single_component<'b>(&self, comp: &'b [u8]) -> Option<Component<'b>> {
721 b"." if self.prefix_verbatim() => Some(Component::CurDir),
722 b"." => None, // . components are normalized away, except at
723 // the beginning of a path, which is treated
724 // separately via `include_cur_dir`
725 b".." => Some(Component::ParentDir),
727 _ => Some(Component::Normal(unsafe { u8_slice_as_os_str(comp) })),
731 // parse a component from the left, saying how many bytes to consume to
732 // remove the component
733 fn parse_next_component(&self) -> (usize, Option<Component<'a>>) {
734 debug_assert!(self.front == State::Body);
735 let (extra, comp) = match self.path.iter().position(|b| self.is_sep_byte(*b)) {
736 None => (0, self.path),
737 Some(i) => (1, &self.path[..i]),
739 (comp.len() + extra, self.parse_single_component(comp))
742 // parse a component from the right, saying how many bytes to consume to
743 // remove the component
744 fn parse_next_component_back(&self) -> (usize, Option<Component<'a>>) {
745 debug_assert!(self.back == State::Body);
746 let start = self.len_before_body();
747 let (extra, comp) = match self.path[start..].iter().rposition(|b| self.is_sep_byte(*b)) {
748 None => (0, &self.path[start..]),
749 Some(i) => (1, &self.path[start + i + 1..]),
751 (comp.len() + extra, self.parse_single_component(comp))
754 // trim away repeated separators (i.e., empty components) on the left
755 fn trim_left(&mut self) {
756 while !self.path.is_empty() {
757 let (size, comp) = self.parse_next_component();
761 self.path = &self.path[size..];
766 // trim away repeated separators (i.e., empty components) on the right
767 fn trim_right(&mut self) {
768 while self.path.len() > self.len_before_body() {
769 let (size, comp) = self.parse_next_component_back();
773 self.path = &self.path[..self.path.len() - size];
779 #[stable(feature = "rust1", since = "1.0.0")]
780 impl AsRef<Path> for Components<'_> {
781 fn as_ref(&self) -> &Path {
786 #[stable(feature = "rust1", since = "1.0.0")]
787 impl AsRef<OsStr> for Components<'_> {
788 fn as_ref(&self) -> &OsStr {
789 self.as_path().as_os_str()
793 #[stable(feature = "path_iter_debug", since = "1.13.0")]
794 impl fmt::Debug for Iter<'_> {
795 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
796 struct DebugHelper<'a>(&'a Path);
798 impl fmt::Debug for DebugHelper<'_> {
799 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
800 f.debug_list().entries(self.0.iter()).finish()
804 f.debug_tuple("Iter").field(&DebugHelper(self.as_path())).finish()
809 /// Extracts a slice corresponding to the portion of the path remaining for iteration.
814 /// use std::path::Path;
816 /// let mut iter = Path::new("/tmp/foo/bar.txt").iter();
820 /// assert_eq!(Path::new("foo/bar.txt"), iter.as_path());
822 #[stable(feature = "rust1", since = "1.0.0")]
823 pub fn as_path(&self) -> &'a Path {
828 #[stable(feature = "rust1", since = "1.0.0")]
829 impl AsRef<Path> for Iter<'_> {
830 fn as_ref(&self) -> &Path {
835 #[stable(feature = "rust1", since = "1.0.0")]
836 impl AsRef<OsStr> for Iter<'_> {
837 fn as_ref(&self) -> &OsStr {
838 self.as_path().as_os_str()
842 #[stable(feature = "rust1", since = "1.0.0")]
843 impl<'a> Iterator for Iter<'a> {
844 type Item = &'a OsStr;
846 fn next(&mut self) -> Option<&'a OsStr> {
847 self.inner.next().map(Component::as_os_str)
851 #[stable(feature = "rust1", since = "1.0.0")]
852 impl<'a> DoubleEndedIterator for Iter<'a> {
853 fn next_back(&mut self) -> Option<&'a OsStr> {
854 self.inner.next_back().map(Component::as_os_str)
858 #[stable(feature = "fused", since = "1.26.0")]
859 impl FusedIterator for Iter<'_> {}
861 #[stable(feature = "rust1", since = "1.0.0")]
862 impl<'a> Iterator for Components<'a> {
863 type Item = Component<'a>;
865 fn next(&mut self) -> Option<Component<'a>> {
866 while !self.finished() {
868 State::Prefix if self.prefix_len() > 0 => {
869 self.front = State::StartDir;
870 debug_assert!(self.prefix_len() <= self.path.len());
871 let raw = &self.path[..self.prefix_len()];
872 self.path = &self.path[self.prefix_len()..];
873 return Some(Component::Prefix(PrefixComponent {
874 raw: unsafe { u8_slice_as_os_str(raw) },
875 parsed: self.prefix.unwrap(),
879 self.front = State::StartDir;
882 self.front = State::Body;
883 if self.has_physical_root {
884 debug_assert!(!self.path.is_empty());
885 self.path = &self.path[1..];
886 return Some(Component::RootDir);
887 } else if let Some(p) = self.prefix {
888 if p.has_implicit_root() && !p.is_verbatim() {
889 return Some(Component::RootDir);
891 } else if self.include_cur_dir() {
892 debug_assert!(!self.path.is_empty());
893 self.path = &self.path[1..];
894 return Some(Component::CurDir);
897 State::Body if !self.path.is_empty() => {
898 let (size, comp) = self.parse_next_component();
899 self.path = &self.path[size..];
905 self.front = State::Done;
907 State::Done => unreachable!(),
914 #[stable(feature = "rust1", since = "1.0.0")]
915 impl<'a> DoubleEndedIterator for Components<'a> {
916 fn next_back(&mut self) -> Option<Component<'a>> {
917 while !self.finished() {
919 State::Body if self.path.len() > self.len_before_body() => {
920 let (size, comp) = self.parse_next_component_back();
921 self.path = &self.path[..self.path.len() - size];
927 self.back = State::StartDir;
930 self.back = State::Prefix;
931 if self.has_physical_root {
932 self.path = &self.path[..self.path.len() - 1];
933 return Some(Component::RootDir);
934 } else if let Some(p) = self.prefix {
935 if p.has_implicit_root() && !p.is_verbatim() {
936 return Some(Component::RootDir);
938 } else if self.include_cur_dir() {
939 self.path = &self.path[..self.path.len() - 1];
940 return Some(Component::CurDir);
943 State::Prefix if self.prefix_len() > 0 => {
944 self.back = State::Done;
945 return Some(Component::Prefix(PrefixComponent {
946 raw: unsafe { u8_slice_as_os_str(self.path) },
947 parsed: self.prefix.unwrap(),
951 self.back = State::Done;
954 State::Done => unreachable!(),
961 #[stable(feature = "fused", since = "1.26.0")]
962 impl FusedIterator for Components<'_> {}
964 #[stable(feature = "rust1", since = "1.0.0")]
965 impl<'a> cmp::PartialEq for Components<'a> {
966 fn eq(&self, other: &Components<'a>) -> bool {
967 Iterator::eq(self.clone(), other.clone())
971 #[stable(feature = "rust1", since = "1.0.0")]
972 impl cmp::Eq for Components<'_> {}
974 #[stable(feature = "rust1", since = "1.0.0")]
975 impl<'a> cmp::PartialOrd for Components<'a> {
976 fn partial_cmp(&self, other: &Components<'a>) -> Option<cmp::Ordering> {
977 Iterator::partial_cmp(self.clone(), other.clone())
981 #[stable(feature = "rust1", since = "1.0.0")]
982 impl cmp::Ord for Components<'_> {
983 fn cmp(&self, other: &Self) -> cmp::Ordering {
984 Iterator::cmp(self.clone(), other.clone())
988 /// An iterator over [`Path`] and its ancestors.
990 /// This `struct` is created by the [`ancestors`] method on [`Path`].
991 /// See its documentation for more.
996 /// use std::path::Path;
998 /// let path = Path::new("/foo/bar");
1000 /// for ancestor in path.ancestors() {
1001 /// println!("{}", ancestor.display());
1005 /// [`ancestors`]: struct.Path.html#method.ancestors
1006 /// [`Path`]: struct.Path.html
1007 #[derive(Copy, Clone, Debug)]
1008 #[stable(feature = "path_ancestors", since = "1.28.0")]
1009 pub struct Ancestors<'a> {
1010 next: Option<&'a Path>,
1013 #[stable(feature = "path_ancestors", since = "1.28.0")]
1014 impl<'a> Iterator for Ancestors<'a> {
1015 type Item = &'a Path;
1017 fn next(&mut self) -> Option<Self::Item> {
1018 let next = self.next;
1019 self.next = next.and_then(Path::parent);
1024 #[stable(feature = "path_ancestors", since = "1.28.0")]
1025 impl FusedIterator for Ancestors<'_> {}
1027 ////////////////////////////////////////////////////////////////////////////////
1028 // Basic types and traits
1029 ////////////////////////////////////////////////////////////////////////////////
1031 /// An owned, mutable path (akin to [`String`]).
1033 /// This type provides methods like [`push`] and [`set_extension`] that mutate
1034 /// the path in place. It also implements [`Deref`] to [`Path`], meaning that
1035 /// all methods on [`Path`] slices are available on `PathBuf` values as well.
1037 /// [`String`]: ../string/struct.String.html
1038 /// [`Path`]: struct.Path.html
1039 /// [`push`]: struct.PathBuf.html#method.push
1040 /// [`set_extension`]: struct.PathBuf.html#method.set_extension
1041 /// [`Deref`]: ../ops/trait.Deref.html
1043 /// More details about the overall approach can be found in
1044 /// the [module documentation](index.html).
1048 /// You can use [`push`] to build up a `PathBuf` from
1052 /// use std::path::PathBuf;
1054 /// let mut path = PathBuf::new();
1056 /// path.push(r"C:\");
1057 /// path.push("windows");
1058 /// path.push("system32");
1060 /// path.set_extension("dll");
1063 /// However, [`push`] is best used for dynamic situations. This is a better way
1064 /// to do this when you know all of the components ahead of time:
1067 /// use std::path::PathBuf;
1069 /// let path: PathBuf = [r"C:\", "windows", "system32.dll"].iter().collect();
1072 /// We can still do better than this! Since these are all strings, we can use
1076 /// use std::path::PathBuf;
1078 /// let path = PathBuf::from(r"C:\windows\system32.dll");
1081 /// Which method works best depends on what kind of situation you're in.
1083 #[stable(feature = "rust1", since = "1.0.0")]
1085 // `PathBuf::as_mut_vec` current implementation relies
1086 // on `PathBuf` being layout-compatible with `Vec<u8>`.
1087 // When attribute privacy is implemented, `PathBuf` should be annotated as `#[repr(transparent)]`.
1088 // Anyway, `PathBuf` representation and layout are considered implementation detail, are
1089 // not documented and must not be relied upon.
1090 pub struct PathBuf {
1095 fn as_mut_vec(&mut self) -> &mut Vec<u8> {
1096 unsafe { &mut *(self as *mut PathBuf as *mut Vec<u8>) }
1099 /// Allocates an empty `PathBuf`.
1104 /// use std::path::PathBuf;
1106 /// let path = PathBuf::new();
1108 #[stable(feature = "rust1", since = "1.0.0")]
1109 pub fn new() -> PathBuf {
1110 PathBuf { inner: OsString::new() }
1113 /// Creates a new `PathBuf` with a given capacity used to create the
1114 /// internal [`OsString`]. See [`with_capacity`] defined on [`OsString`].
1119 /// #![feature(path_buf_capacity)]
1120 /// use std::path::PathBuf;
1122 /// let mut path = PathBuf::with_capacity(10);
1123 /// let capacity = path.capacity();
1125 /// // This push is done without reallocating
1126 /// path.push(r"C:\");
1128 /// assert_eq!(capacity, path.capacity());
1131 /// [`with_capacity`]: ../ffi/struct.OsString.html#method.with_capacity
1132 /// [`OsString`]: ../ffi/struct.OsString.html
1133 #[unstable(feature = "path_buf_capacity", issue = "58234")]
1134 pub fn with_capacity(capacity: usize) -> PathBuf {
1135 PathBuf { inner: OsString::with_capacity(capacity) }
1138 /// Coerces to a [`Path`] slice.
1140 /// [`Path`]: struct.Path.html
1145 /// use std::path::{Path, PathBuf};
1147 /// let p = PathBuf::from("/test");
1148 /// assert_eq!(Path::new("/test"), p.as_path());
1150 #[stable(feature = "rust1", since = "1.0.0")]
1151 pub fn as_path(&self) -> &Path {
1155 /// Extends `self` with `path`.
1157 /// If `path` is absolute, it replaces the current path.
1161 /// * if `path` has a root but no prefix (e.g., `\windows`), it
1162 /// replaces everything except for the prefix (if any) of `self`.
1163 /// * if `path` has a prefix but no root, it replaces `self`.
1167 /// Pushing a relative path extends the existing path:
1170 /// use std::path::PathBuf;
1172 /// let mut path = PathBuf::from("/tmp");
1173 /// path.push("file.bk");
1174 /// assert_eq!(path, PathBuf::from("/tmp/file.bk"));
1177 /// Pushing an absolute path replaces the existing path:
1180 /// use std::path::PathBuf;
1182 /// let mut path = PathBuf::from("/tmp");
1183 /// path.push("/etc");
1184 /// assert_eq!(path, PathBuf::from("/etc"));
1186 #[stable(feature = "rust1", since = "1.0.0")]
1187 pub fn push<P: AsRef<Path>>(&mut self, path: P) {
1188 self._push(path.as_ref())
1191 fn _push(&mut self, path: &Path) {
1192 // in general, a separator is needed if the rightmost byte is not a separator
1193 let mut need_sep = self.as_mut_vec().last().map(|c| !is_sep_byte(*c)).unwrap_or(false);
1195 // in the special case of `C:` on Windows, do *not* add a separator
1197 let comps = self.components();
1198 if comps.prefix_len() > 0
1199 && comps.prefix_len() == comps.path.len()
1200 && comps.prefix.unwrap().is_drive()
1206 // absolute `path` replaces `self`
1207 if path.is_absolute() || path.prefix().is_some() {
1208 self.as_mut_vec().truncate(0);
1210 // `path` has a root but no prefix, e.g., `\windows` (Windows only)
1211 } else if path.has_root() {
1212 let prefix_len = self.components().prefix_remaining();
1213 self.as_mut_vec().truncate(prefix_len);
1215 // `path` is a pure relative path
1216 } else if need_sep {
1217 self.inner.push(MAIN_SEP_STR);
1220 self.inner.push(path);
1223 /// Truncates `self` to [`self.parent`].
1225 /// Returns `false` and does nothing if [`self.parent`] is [`None`].
1226 /// Otherwise, returns `true`.
1228 /// [`None`]: ../../std/option/enum.Option.html#variant.None
1229 /// [`self.parent`]: struct.PathBuf.html#method.parent
1234 /// use std::path::{Path, PathBuf};
1236 /// let mut p = PathBuf::from("/test/test.rs");
1239 /// assert_eq!(Path::new("/test"), p);
1241 /// assert_eq!(Path::new("/"), p);
1243 #[stable(feature = "rust1", since = "1.0.0")]
1244 pub fn pop(&mut self) -> bool {
1245 match self.parent().map(|p| p.as_u8_slice().len()) {
1247 self.as_mut_vec().truncate(len);
1254 /// Updates [`self.file_name`] to `file_name`.
1256 /// If [`self.file_name`] was [`None`], this is equivalent to pushing
1259 /// Otherwise it is equivalent to calling [`pop`] and then pushing
1260 /// `file_name`. The new path will be a sibling of the original path.
1261 /// (That is, it will have the same parent.)
1263 /// [`self.file_name`]: struct.PathBuf.html#method.file_name
1264 /// [`None`]: ../../std/option/enum.Option.html#variant.None
1265 /// [`pop`]: struct.PathBuf.html#method.pop
1270 /// use std::path::PathBuf;
1272 /// let mut buf = PathBuf::from("/");
1273 /// assert!(buf.file_name() == None);
1274 /// buf.set_file_name("bar");
1275 /// assert!(buf == PathBuf::from("/bar"));
1276 /// assert!(buf.file_name().is_some());
1277 /// buf.set_file_name("baz.txt");
1278 /// assert!(buf == PathBuf::from("/baz.txt"));
1280 #[stable(feature = "rust1", since = "1.0.0")]
1281 pub fn set_file_name<S: AsRef<OsStr>>(&mut self, file_name: S) {
1282 self._set_file_name(file_name.as_ref())
1285 fn _set_file_name(&mut self, file_name: &OsStr) {
1286 if self.file_name().is_some() {
1287 let popped = self.pop();
1288 debug_assert!(popped);
1290 self.push(file_name);
1293 /// Updates [`self.extension`] to `extension`.
1295 /// Returns `false` and does nothing if [`self.file_name`] is [`None`],
1296 /// returns `true` and updates the extension otherwise.
1298 /// If [`self.extension`] is [`None`], the extension is added; otherwise
1301 /// [`self.file_name`]: struct.PathBuf.html#method.file_name
1302 /// [`self.extension`]: struct.PathBuf.html#method.extension
1303 /// [`None`]: ../../std/option/enum.Option.html#variant.None
1308 /// use std::path::{Path, PathBuf};
1310 /// let mut p = PathBuf::from("/feel/the");
1312 /// p.set_extension("force");
1313 /// assert_eq!(Path::new("/feel/the.force"), p.as_path());
1315 /// p.set_extension("dark_side");
1316 /// assert_eq!(Path::new("/feel/the.dark_side"), p.as_path());
1318 #[stable(feature = "rust1", since = "1.0.0")]
1319 pub fn set_extension<S: AsRef<OsStr>>(&mut self, extension: S) -> bool {
1320 self._set_extension(extension.as_ref())
1323 fn _set_extension(&mut self, extension: &OsStr) -> bool {
1324 let file_stem = match self.file_stem() {
1325 None => return false,
1326 Some(f) => os_str_as_u8_slice(f),
1329 // truncate until right after the file stem
1330 let end_file_stem = file_stem[file_stem.len()..].as_ptr() as usize;
1331 let start = os_str_as_u8_slice(&self.inner).as_ptr() as usize;
1332 let v = self.as_mut_vec();
1333 v.truncate(end_file_stem.wrapping_sub(start));
1335 // add the new extension, if any
1336 let new = os_str_as_u8_slice(extension);
1337 if !new.is_empty() {
1338 v.reserve_exact(new.len() + 1);
1340 v.extend_from_slice(new);
1346 /// Consumes the `PathBuf`, yielding its internal [`OsString`] storage.
1348 /// [`OsString`]: ../ffi/struct.OsString.html
1353 /// use std::path::PathBuf;
1355 /// let p = PathBuf::from("/the/head");
1356 /// let os_str = p.into_os_string();
1358 #[stable(feature = "rust1", since = "1.0.0")]
1359 pub fn into_os_string(self) -> OsString {
1363 /// Converts this `PathBuf` into a [boxed][`Box`] [`Path`].
1365 /// [`Box`]: ../../std/boxed/struct.Box.html
1366 /// [`Path`]: struct.Path.html
1367 #[stable(feature = "into_boxed_path", since = "1.20.0")]
1368 pub fn into_boxed_path(self) -> Box<Path> {
1369 let rw = Box::into_raw(self.inner.into_boxed_os_str()) as *mut Path;
1370 unsafe { Box::from_raw(rw) }
1373 /// Invokes [`capacity`] on the underlying instance of [`OsString`].
1375 /// [`capacity`]: ../ffi/struct.OsString.html#method.capacity
1376 /// [`OsString`]: ../ffi/struct.OsString.html
1377 #[unstable(feature = "path_buf_capacity", issue = "58234")]
1378 pub fn capacity(&self) -> usize {
1379 self.inner.capacity()
1382 /// Invokes [`clear`] on the underlying instance of [`OsString`].
1384 /// [`clear`]: ../ffi/struct.OsString.html#method.clear
1385 /// [`OsString`]: ../ffi/struct.OsString.html
1386 #[unstable(feature = "path_buf_capacity", issue = "58234")]
1387 pub fn clear(&mut self) {
1391 /// Invokes [`reserve`] on the underlying instance of [`OsString`].
1393 /// [`reserve`]: ../ffi/struct.OsString.html#method.reserve
1394 /// [`OsString`]: ../ffi/struct.OsString.html
1395 #[unstable(feature = "path_buf_capacity", issue = "58234")]
1396 pub fn reserve(&mut self, additional: usize) {
1397 self.inner.reserve(additional)
1400 /// Invokes [`reserve_exact`] on the underlying instance of [`OsString`].
1402 /// [`reserve_exact`]: ../ffi/struct.OsString.html#method.reserve_exact
1403 /// [`OsString`]: ../ffi/struct.OsString.html
1404 #[unstable(feature = "path_buf_capacity", issue = "58234")]
1405 pub fn reserve_exact(&mut self, additional: usize) {
1406 self.inner.reserve_exact(additional)
1409 /// Invokes [`shrink_to_fit`] on the underlying instance of [`OsString`].
1411 /// [`shrink_to_fit`]: ../ffi/struct.OsString.html#method.shrink_to_fit
1412 /// [`OsString`]: ../ffi/struct.OsString.html
1413 #[unstable(feature = "path_buf_capacity", issue = "58234")]
1414 pub fn shrink_to_fit(&mut self) {
1415 self.inner.shrink_to_fit()
1418 /// Invokes [`shrink_to`] on the underlying instance of [`OsString`].
1420 /// [`shrink_to`]: ../ffi/struct.OsString.html#method.shrink_to
1421 /// [`OsString`]: ../ffi/struct.OsString.html
1422 #[unstable(feature = "path_buf_capacity", issue = "58234")]
1423 pub fn shrink_to(&mut self, min_capacity: usize) {
1424 self.inner.shrink_to(min_capacity)
1428 #[stable(feature = "box_from_path", since = "1.17.0")]
1429 impl From<&Path> for Box<Path> {
1430 fn from(path: &Path) -> Box<Path> {
1431 let boxed: Box<OsStr> = path.inner.into();
1432 let rw = Box::into_raw(boxed) as *mut Path;
1433 unsafe { Box::from_raw(rw) }
1437 #[stable(feature = "path_buf_from_box", since = "1.18.0")]
1438 impl From<Box<Path>> for PathBuf {
1439 /// Converts a `Box<Path>` into a `PathBuf`
1441 /// This conversion does not allocate or copy memory.
1442 fn from(boxed: Box<Path>) -> PathBuf {
1443 boxed.into_path_buf()
1447 #[stable(feature = "box_from_path_buf", since = "1.20.0")]
1448 impl From<PathBuf> for Box<Path> {
1449 /// Converts a `PathBuf` into a `Box<Path>`
1451 /// This conversion currently should not allocate memory,
1452 /// but this behavior is not guaranteed on all platforms or in all future versions.
1453 fn from(p: PathBuf) -> Box<Path> {
1458 #[stable(feature = "more_box_slice_clone", since = "1.29.0")]
1459 impl Clone for Box<Path> {
1461 fn clone(&self) -> Self {
1462 self.to_path_buf().into_boxed_path()
1466 #[stable(feature = "rust1", since = "1.0.0")]
1467 impl<T: ?Sized + AsRef<OsStr>> From<&T> for PathBuf {
1468 fn from(s: &T) -> PathBuf {
1469 PathBuf::from(s.as_ref().to_os_string())
1473 #[stable(feature = "rust1", since = "1.0.0")]
1474 impl From<OsString> for PathBuf {
1475 /// Converts a `OsString` into a `PathBuf`
1477 /// This conversion does not allocate or copy memory.
1478 fn from(s: OsString) -> PathBuf {
1479 PathBuf { inner: s }
1483 #[stable(feature = "from_path_buf_for_os_string", since = "1.14.0")]
1484 impl From<PathBuf> for OsString {
1485 /// Converts a `PathBuf` into a `OsString`
1487 /// This conversion does not allocate or copy memory.
1488 fn from(path_buf: PathBuf) -> OsString {
1493 #[stable(feature = "rust1", since = "1.0.0")]
1494 impl From<String> for PathBuf {
1495 /// Converts a `String` into a `PathBuf`
1497 /// This conversion does not allocate or copy memory.
1498 fn from(s: String) -> PathBuf {
1499 PathBuf::from(OsString::from(s))
1503 #[stable(feature = "path_from_str", since = "1.32.0")]
1504 impl FromStr for PathBuf {
1505 type Err = core::convert::Infallible;
1507 fn from_str(s: &str) -> Result<Self, Self::Err> {
1508 Ok(PathBuf::from(s))
1512 #[stable(feature = "rust1", since = "1.0.0")]
1513 impl<P: AsRef<Path>> iter::FromIterator<P> for PathBuf {
1514 fn from_iter<I: IntoIterator<Item = P>>(iter: I) -> PathBuf {
1515 let mut buf = PathBuf::new();
1521 #[stable(feature = "rust1", since = "1.0.0")]
1522 impl<P: AsRef<Path>> iter::Extend<P> for PathBuf {
1523 fn extend<I: IntoIterator<Item = P>>(&mut self, iter: I) {
1524 iter.into_iter().for_each(move |p| self.push(p.as_ref()));
1528 #[stable(feature = "rust1", since = "1.0.0")]
1529 impl fmt::Debug for PathBuf {
1530 fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
1531 fmt::Debug::fmt(&**self, formatter)
1535 #[stable(feature = "rust1", since = "1.0.0")]
1536 impl ops::Deref for PathBuf {
1539 fn deref(&self) -> &Path {
1540 Path::new(&self.inner)
1544 #[stable(feature = "rust1", since = "1.0.0")]
1545 impl Borrow<Path> for PathBuf {
1546 fn borrow(&self) -> &Path {
1551 #[stable(feature = "default_for_pathbuf", since = "1.17.0")]
1552 impl Default for PathBuf {
1553 fn default() -> Self {
1558 #[stable(feature = "cow_from_path", since = "1.6.0")]
1559 impl<'a> From<&'a Path> for Cow<'a, Path> {
1561 fn from(s: &'a Path) -> Cow<'a, Path> {
1566 #[stable(feature = "cow_from_path", since = "1.6.0")]
1567 impl<'a> From<PathBuf> for Cow<'a, Path> {
1569 fn from(s: PathBuf) -> Cow<'a, Path> {
1574 #[stable(feature = "cow_from_pathbuf_ref", since = "1.28.0")]
1575 impl<'a> From<&'a PathBuf> for Cow<'a, Path> {
1577 fn from(p: &'a PathBuf) -> Cow<'a, Path> {
1578 Cow::Borrowed(p.as_path())
1582 #[stable(feature = "pathbuf_from_cow_path", since = "1.28.0")]
1583 impl<'a> From<Cow<'a, Path>> for PathBuf {
1585 fn from(p: Cow<'a, Path>) -> Self {
1590 #[stable(feature = "shared_from_slice2", since = "1.24.0")]
1591 impl From<PathBuf> for Arc<Path> {
1592 /// Converts a `PathBuf` into an `Arc` by moving the `PathBuf` data into a new `Arc` buffer.
1594 fn from(s: PathBuf) -> Arc<Path> {
1595 let arc: Arc<OsStr> = Arc::from(s.into_os_string());
1596 unsafe { Arc::from_raw(Arc::into_raw(arc) as *const Path) }
1600 #[stable(feature = "shared_from_slice2", since = "1.24.0")]
1601 impl From<&Path> for Arc<Path> {
1602 /// Converts a `Path` into an `Arc` by copying the `Path` data into a new `Arc` buffer.
1604 fn from(s: &Path) -> Arc<Path> {
1605 let arc: Arc<OsStr> = Arc::from(s.as_os_str());
1606 unsafe { Arc::from_raw(Arc::into_raw(arc) as *const Path) }
1610 #[stable(feature = "shared_from_slice2", since = "1.24.0")]
1611 impl From<PathBuf> for Rc<Path> {
1612 /// Converts a `PathBuf` into an `Rc` by moving the `PathBuf` data into a new `Rc` buffer.
1614 fn from(s: PathBuf) -> Rc<Path> {
1615 let rc: Rc<OsStr> = Rc::from(s.into_os_string());
1616 unsafe { Rc::from_raw(Rc::into_raw(rc) as *const Path) }
1620 #[stable(feature = "shared_from_slice2", since = "1.24.0")]
1621 impl From<&Path> for Rc<Path> {
1622 /// Converts a `Path` into an `Rc` by copying the `Path` data into a new `Rc` buffer.
1624 fn from(s: &Path) -> Rc<Path> {
1625 let rc: Rc<OsStr> = Rc::from(s.as_os_str());
1626 unsafe { Rc::from_raw(Rc::into_raw(rc) as *const Path) }
1630 #[stable(feature = "rust1", since = "1.0.0")]
1631 impl ToOwned for Path {
1632 type Owned = PathBuf;
1633 fn to_owned(&self) -> PathBuf {
1636 fn clone_into(&self, target: &mut PathBuf) {
1637 self.inner.clone_into(&mut target.inner);
1641 #[stable(feature = "rust1", since = "1.0.0")]
1642 impl cmp::PartialEq for PathBuf {
1643 fn eq(&self, other: &PathBuf) -> bool {
1644 self.components() == other.components()
1648 #[stable(feature = "rust1", since = "1.0.0")]
1649 impl Hash for PathBuf {
1650 fn hash<H: Hasher>(&self, h: &mut H) {
1651 self.as_path().hash(h)
1655 #[stable(feature = "rust1", since = "1.0.0")]
1656 impl cmp::Eq for PathBuf {}
1658 #[stable(feature = "rust1", since = "1.0.0")]
1659 impl cmp::PartialOrd for PathBuf {
1660 fn partial_cmp(&self, other: &PathBuf) -> Option<cmp::Ordering> {
1661 self.components().partial_cmp(other.components())
1665 #[stable(feature = "rust1", since = "1.0.0")]
1666 impl cmp::Ord for PathBuf {
1667 fn cmp(&self, other: &PathBuf) -> cmp::Ordering {
1668 self.components().cmp(other.components())
1672 #[stable(feature = "rust1", since = "1.0.0")]
1673 impl AsRef<OsStr> for PathBuf {
1674 fn as_ref(&self) -> &OsStr {
1679 /// A slice of a path (akin to [`str`]).
1681 /// This type supports a number of operations for inspecting a path, including
1682 /// breaking the path into its components (separated by `/` on Unix and by either
1683 /// `/` or `\` on Windows), extracting the file name, determining whether the path
1684 /// is absolute, and so on.
1686 /// This is an *unsized* type, meaning that it must always be used behind a
1687 /// pointer like `&` or [`Box`]. For an owned version of this type,
1688 /// see [`PathBuf`].
1690 /// [`str`]: ../primitive.str.html
1691 /// [`Box`]: ../boxed/struct.Box.html
1692 /// [`PathBuf`]: struct.PathBuf.html
1694 /// More details about the overall approach can be found in
1695 /// the [module documentation](index.html).
1700 /// use std::path::Path;
1701 /// use std::ffi::OsStr;
1703 /// // Note: this example does work on Windows
1704 /// let path = Path::new("./foo/bar.txt");
1706 /// let parent = path.parent();
1707 /// assert_eq!(parent, Some(Path::new("./foo")));
1709 /// let file_stem = path.file_stem();
1710 /// assert_eq!(file_stem, Some(OsStr::new("bar")));
1712 /// let extension = path.extension();
1713 /// assert_eq!(extension, Some(OsStr::new("txt")));
1715 #[stable(feature = "rust1", since = "1.0.0")]
1717 // `Path::new` current implementation relies
1718 // on `Path` being layout-compatible with `OsStr`.
1719 // When attribute privacy is implemented, `Path` should be annotated as `#[repr(transparent)]`.
1720 // Anyway, `Path` representation and layout are considered implementation detail, are
1721 // not documented and must not be relied upon.
1726 /// An error returned from [`Path::strip_prefix`][`strip_prefix`] if the prefix
1729 /// This `struct` is created by the [`strip_prefix`] method on [`Path`].
1730 /// See its documentation for more.
1732 /// [`strip_prefix`]: struct.Path.html#method.strip_prefix
1733 /// [`Path`]: struct.Path.html
1734 #[derive(Debug, Clone, PartialEq, Eq)]
1735 #[stable(since = "1.7.0", feature = "strip_prefix")]
1736 pub struct StripPrefixError(());
1739 // The following (private!) function allows construction of a path from a u8
1740 // slice, which is only safe when it is known to follow the OsStr encoding.
1741 unsafe fn from_u8_slice(s: &[u8]) -> &Path {
1742 Path::new(u8_slice_as_os_str(s))
1744 // The following (private!) function reveals the byte encoding used for OsStr.
1745 fn as_u8_slice(&self) -> &[u8] {
1746 os_str_as_u8_slice(&self.inner)
1749 /// Directly wraps a string slice as a `Path` slice.
1751 /// This is a cost-free conversion.
1756 /// use std::path::Path;
1758 /// Path::new("foo.txt");
1761 /// You can create `Path`s from `String`s, or even other `Path`s:
1764 /// use std::path::Path;
1766 /// let string = String::from("foo.txt");
1767 /// let from_string = Path::new(&string);
1768 /// let from_path = Path::new(&from_string);
1769 /// assert_eq!(from_string, from_path);
1771 #[stable(feature = "rust1", since = "1.0.0")]
1772 pub fn new<S: AsRef<OsStr> + ?Sized>(s: &S) -> &Path {
1773 unsafe { &*(s.as_ref() as *const OsStr as *const Path) }
1776 /// Yields the underlying [`OsStr`] slice.
1778 /// [`OsStr`]: ../ffi/struct.OsStr.html
1783 /// use std::path::Path;
1785 /// let os_str = Path::new("foo.txt").as_os_str();
1786 /// assert_eq!(os_str, std::ffi::OsStr::new("foo.txt"));
1788 #[stable(feature = "rust1", since = "1.0.0")]
1789 pub fn as_os_str(&self) -> &OsStr {
1793 /// Yields a [`&str`] slice if the `Path` is valid unicode.
1795 /// This conversion may entail doing a check for UTF-8 validity.
1796 /// Note that validation is performed because non-UTF-8 strings are
1797 /// perfectly valid for some OS.
1799 /// [`&str`]: ../primitive.str.html
1804 /// use std::path::Path;
1806 /// let path = Path::new("foo.txt");
1807 /// assert_eq!(path.to_str(), Some("foo.txt"));
1809 #[stable(feature = "rust1", since = "1.0.0")]
1810 pub fn to_str(&self) -> Option<&str> {
1814 /// Converts a `Path` to a [`Cow<str>`].
1816 /// Any non-Unicode sequences are replaced with
1817 /// [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD].
1819 /// [`Cow<str>`]: ../borrow/enum.Cow.html
1820 /// [U+FFFD]: ../char/constant.REPLACEMENT_CHARACTER.html
1824 /// Calling `to_string_lossy` on a `Path` with valid unicode:
1827 /// use std::path::Path;
1829 /// let path = Path::new("foo.txt");
1830 /// assert_eq!(path.to_string_lossy(), "foo.txt");
1833 /// Had `path` contained invalid unicode, the `to_string_lossy` call might
1834 /// have returned `"fo�.txt"`.
1835 #[stable(feature = "rust1", since = "1.0.0")]
1836 pub fn to_string_lossy(&self) -> Cow<'_, str> {
1837 self.inner.to_string_lossy()
1840 /// Converts a `Path` to an owned [`PathBuf`].
1842 /// [`PathBuf`]: struct.PathBuf.html
1847 /// use std::path::Path;
1849 /// let path_buf = Path::new("foo.txt").to_path_buf();
1850 /// assert_eq!(path_buf, std::path::PathBuf::from("foo.txt"));
1852 #[rustc_conversion_suggestion]
1853 #[stable(feature = "rust1", since = "1.0.0")]
1854 pub fn to_path_buf(&self) -> PathBuf {
1855 PathBuf::from(self.inner.to_os_string())
1858 /// Returns `true` if the `Path` is absolute, i.e., if it is independent of
1859 /// the current directory.
1861 /// * On Unix, a path is absolute if it starts with the root, so
1862 /// `is_absolute` and [`has_root`] are equivalent.
1864 /// * On Windows, a path is absolute if it has a prefix and starts with the
1865 /// root: `c:\windows` is absolute, while `c:temp` and `\temp` are not.
1870 /// use std::path::Path;
1872 /// assert!(!Path::new("foo.txt").is_absolute());
1875 /// [`has_root`]: #method.has_root
1876 #[stable(feature = "rust1", since = "1.0.0")]
1877 #[allow(deprecated)]
1878 pub fn is_absolute(&self) -> bool {
1879 if cfg!(target_os = "redox") {
1880 // FIXME: Allow Redox prefixes
1881 self.has_root() || has_redox_scheme(self.as_u8_slice())
1883 self.has_root() && (cfg!(unix) || self.prefix().is_some())
1887 /// Returns `true` if the `Path` is relative, i.e., not absolute.
1889 /// See [`is_absolute`]'s documentation for more details.
1894 /// use std::path::Path;
1896 /// assert!(Path::new("foo.txt").is_relative());
1899 /// [`is_absolute`]: #method.is_absolute
1900 #[stable(feature = "rust1", since = "1.0.0")]
1901 pub fn is_relative(&self) -> bool {
1905 fn prefix(&self) -> Option<Prefix<'_>> {
1906 self.components().prefix
1909 /// Returns `true` if the `Path` has a root.
1911 /// * On Unix, a path has a root if it begins with `/`.
1913 /// * On Windows, a path has a root if it:
1914 /// * has no prefix and begins with a separator, e.g., `\windows`
1915 /// * has a prefix followed by a separator, e.g., `c:\windows` but not `c:windows`
1916 /// * has any non-disk prefix, e.g., `\\server\share`
1921 /// use std::path::Path;
1923 /// assert!(Path::new("/etc/passwd").has_root());
1925 #[stable(feature = "rust1", since = "1.0.0")]
1926 pub fn has_root(&self) -> bool {
1927 self.components().has_root()
1930 /// Returns the `Path` without its final component, if there is one.
1932 /// Returns [`None`] if the path terminates in a root or prefix.
1934 /// [`None`]: ../../std/option/enum.Option.html#variant.None
1939 /// use std::path::Path;
1941 /// let path = Path::new("/foo/bar");
1942 /// let parent = path.parent().unwrap();
1943 /// assert_eq!(parent, Path::new("/foo"));
1945 /// let grand_parent = parent.parent().unwrap();
1946 /// assert_eq!(grand_parent, Path::new("/"));
1947 /// assert_eq!(grand_parent.parent(), None);
1949 #[stable(feature = "rust1", since = "1.0.0")]
1950 pub fn parent(&self) -> Option<&Path> {
1951 let mut comps = self.components();
1952 let comp = comps.next_back();
1953 comp.and_then(|p| match p {
1954 Component::Normal(_) | Component::CurDir | Component::ParentDir => {
1955 Some(comps.as_path())
1961 /// Produces an iterator over `Path` and its ancestors.
1963 /// The iterator will yield the `Path` that is returned if the [`parent`] method is used zero
1964 /// or more times. That means, the iterator will yield `&self`, `&self.parent().unwrap()`,
1965 /// `&self.parent().unwrap().parent().unwrap()` and so on. If the [`parent`] method returns
1966 /// [`None`], the iterator will do likewise. The iterator will always yield at least one value,
1972 /// use std::path::Path;
1974 /// let mut ancestors = Path::new("/foo/bar").ancestors();
1975 /// assert_eq!(ancestors.next(), Some(Path::new("/foo/bar")));
1976 /// assert_eq!(ancestors.next(), Some(Path::new("/foo")));
1977 /// assert_eq!(ancestors.next(), Some(Path::new("/")));
1978 /// assert_eq!(ancestors.next(), None);
1981 /// [`None`]: ../../std/option/enum.Option.html#variant.None
1982 /// [`parent`]: struct.Path.html#method.parent
1983 #[stable(feature = "path_ancestors", since = "1.28.0")]
1984 pub fn ancestors(&self) -> Ancestors<'_> {
1985 Ancestors { next: Some(&self) }
1988 /// Returns the final component of the `Path`, if there is one.
1990 /// If the path is a normal file, this is the file name. If it's the path of a directory, this
1991 /// is the directory name.
1993 /// Returns [`None`] if the path terminates in `..`.
1995 /// [`None`]: ../../std/option/enum.Option.html#variant.None
2000 /// use std::path::Path;
2001 /// use std::ffi::OsStr;
2003 /// assert_eq!(Some(OsStr::new("bin")), Path::new("/usr/bin/").file_name());
2004 /// assert_eq!(Some(OsStr::new("foo.txt")), Path::new("tmp/foo.txt").file_name());
2005 /// assert_eq!(Some(OsStr::new("foo.txt")), Path::new("foo.txt/.").file_name());
2006 /// assert_eq!(Some(OsStr::new("foo.txt")), Path::new("foo.txt/.//").file_name());
2007 /// assert_eq!(None, Path::new("foo.txt/..").file_name());
2008 /// assert_eq!(None, Path::new("/").file_name());
2010 #[stable(feature = "rust1", since = "1.0.0")]
2011 pub fn file_name(&self) -> Option<&OsStr> {
2012 self.components().next_back().and_then(|p| match p {
2013 Component::Normal(p) => Some(p.as_ref()),
2018 /// Returns a path that, when joined onto `base`, yields `self`.
2022 /// If `base` is not a prefix of `self` (i.e., [`starts_with`]
2023 /// returns `false`), returns [`Err`].
2025 /// [`starts_with`]: #method.starts_with
2026 /// [`Err`]: ../../std/result/enum.Result.html#variant.Err
2031 /// use std::path::{Path, PathBuf};
2033 /// let path = Path::new("/test/haha/foo.txt");
2035 /// assert_eq!(path.strip_prefix("/"), Ok(Path::new("test/haha/foo.txt")));
2036 /// assert_eq!(path.strip_prefix("/test"), Ok(Path::new("haha/foo.txt")));
2037 /// assert_eq!(path.strip_prefix("/test/"), Ok(Path::new("haha/foo.txt")));
2038 /// assert_eq!(path.strip_prefix("/test/haha/foo.txt"), Ok(Path::new("")));
2039 /// assert_eq!(path.strip_prefix("/test/haha/foo.txt/"), Ok(Path::new("")));
2040 /// assert_eq!(path.strip_prefix("test").is_ok(), false);
2041 /// assert_eq!(path.strip_prefix("/haha").is_ok(), false);
2043 /// let prefix = PathBuf::from("/test/");
2044 /// assert_eq!(path.strip_prefix(prefix), Ok(Path::new("haha/foo.txt")));
2046 #[stable(since = "1.7.0", feature = "path_strip_prefix")]
2047 pub fn strip_prefix<P>(&self, base: P) -> Result<&Path, StripPrefixError>
2051 self._strip_prefix(base.as_ref())
2054 fn _strip_prefix(&self, base: &Path) -> Result<&Path, StripPrefixError> {
2055 iter_after(self.components(), base.components())
2056 .map(|c| c.as_path())
2057 .ok_or(StripPrefixError(()))
2060 /// Determines whether `base` is a prefix of `self`.
2062 /// Only considers whole path components to match.
2067 /// use std::path::Path;
2069 /// let path = Path::new("/etc/passwd");
2071 /// assert!(path.starts_with("/etc"));
2072 /// assert!(path.starts_with("/etc/"));
2073 /// assert!(path.starts_with("/etc/passwd"));
2074 /// assert!(path.starts_with("/etc/passwd/"));
2076 /// assert!(!path.starts_with("/e"));
2078 #[stable(feature = "rust1", since = "1.0.0")]
2079 pub fn starts_with<P: AsRef<Path>>(&self, base: P) -> bool {
2080 self._starts_with(base.as_ref())
2083 fn _starts_with(&self, base: &Path) -> bool {
2084 iter_after(self.components(), base.components()).is_some()
2087 /// Determines whether `child` is a suffix of `self`.
2089 /// Only considers whole path components to match.
2094 /// use std::path::Path;
2096 /// let path = Path::new("/etc/passwd");
2098 /// assert!(path.ends_with("passwd"));
2100 #[stable(feature = "rust1", since = "1.0.0")]
2101 pub fn ends_with<P: AsRef<Path>>(&self, child: P) -> bool {
2102 self._ends_with(child.as_ref())
2105 fn _ends_with(&self, child: &Path) -> bool {
2106 iter_after(self.components().rev(), child.components().rev()).is_some()
2109 /// Extracts the stem (non-extension) portion of [`self.file_name`].
2111 /// [`self.file_name`]: struct.Path.html#method.file_name
2115 /// * [`None`], if there is no file name;
2116 /// * The entire file name if there is no embedded `.`;
2117 /// * The entire file name if the file name begins with `.` and has no other `.`s within;
2118 /// * Otherwise, the portion of the file name before the final `.`
2120 /// [`None`]: ../../std/option/enum.Option.html#variant.None
2125 /// use std::path::Path;
2127 /// let path = Path::new("foo.rs");
2129 /// assert_eq!("foo", path.file_stem().unwrap());
2131 #[stable(feature = "rust1", since = "1.0.0")]
2132 pub fn file_stem(&self) -> Option<&OsStr> {
2133 self.file_name().map(split_file_at_dot).and_then(|(before, after)| before.or(after))
2136 /// Extracts the extension of [`self.file_name`], if possible.
2138 /// The extension is:
2140 /// * [`None`], if there is no file name;
2141 /// * [`None`], if there is no embedded `.`;
2142 /// * [`None`], if the file name begins with `.` and has no other `.`s within;
2143 /// * Otherwise, the portion of the file name after the final `.`
2145 /// [`self.file_name`]: struct.Path.html#method.file_name
2146 /// [`None`]: ../../std/option/enum.Option.html#variant.None
2151 /// use std::path::Path;
2153 /// let path = Path::new("foo.rs");
2155 /// assert_eq!("rs", path.extension().unwrap());
2157 #[stable(feature = "rust1", since = "1.0.0")]
2158 pub fn extension(&self) -> Option<&OsStr> {
2159 self.file_name().map(split_file_at_dot).and_then(|(before, after)| before.and(after))
2162 /// Creates an owned [`PathBuf`] with `path` adjoined to `self`.
2164 /// See [`PathBuf::push`] for more details on what it means to adjoin a path.
2166 /// [`PathBuf`]: struct.PathBuf.html
2167 /// [`PathBuf::push`]: struct.PathBuf.html#method.push
2172 /// use std::path::{Path, PathBuf};
2174 /// assert_eq!(Path::new("/etc").join("passwd"), PathBuf::from("/etc/passwd"));
2176 #[stable(feature = "rust1", since = "1.0.0")]
2178 pub fn join<P: AsRef<Path>>(&self, path: P) -> PathBuf {
2179 self._join(path.as_ref())
2182 fn _join(&self, path: &Path) -> PathBuf {
2183 let mut buf = self.to_path_buf();
2188 /// Creates an owned [`PathBuf`] like `self` but with the given file name.
2190 /// See [`PathBuf::set_file_name`] for more details.
2192 /// [`PathBuf`]: struct.PathBuf.html
2193 /// [`PathBuf::set_file_name`]: struct.PathBuf.html#method.set_file_name
2198 /// use std::path::{Path, PathBuf};
2200 /// let path = Path::new("/tmp/foo.txt");
2201 /// assert_eq!(path.with_file_name("bar.txt"), PathBuf::from("/tmp/bar.txt"));
2203 /// let path = Path::new("/tmp");
2204 /// assert_eq!(path.with_file_name("var"), PathBuf::from("/var"));
2206 #[stable(feature = "rust1", since = "1.0.0")]
2207 pub fn with_file_name<S: AsRef<OsStr>>(&self, file_name: S) -> PathBuf {
2208 self._with_file_name(file_name.as_ref())
2211 fn _with_file_name(&self, file_name: &OsStr) -> PathBuf {
2212 let mut buf = self.to_path_buf();
2213 buf.set_file_name(file_name);
2217 /// Creates an owned [`PathBuf`] like `self` but with the given extension.
2219 /// See [`PathBuf::set_extension`] for more details.
2221 /// [`PathBuf`]: struct.PathBuf.html
2222 /// [`PathBuf::set_extension`]: struct.PathBuf.html#method.set_extension
2227 /// use std::path::{Path, PathBuf};
2229 /// let path = Path::new("foo.rs");
2230 /// assert_eq!(path.with_extension("txt"), PathBuf::from("foo.txt"));
2232 #[stable(feature = "rust1", since = "1.0.0")]
2233 pub fn with_extension<S: AsRef<OsStr>>(&self, extension: S) -> PathBuf {
2234 self._with_extension(extension.as_ref())
2237 fn _with_extension(&self, extension: &OsStr) -> PathBuf {
2238 let mut buf = self.to_path_buf();
2239 buf.set_extension(extension);
2243 /// Produces an iterator over the [`Component`]s of the path.
2245 /// When parsing the path, there is a small amount of normalization:
2247 /// * Repeated separators are ignored, so `a/b` and `a//b` both have
2248 /// `a` and `b` as components.
2250 /// * Occurrences of `.` are normalized away, except if they are at the
2251 /// beginning of the path. For example, `a/./b`, `a/b/`, `a/b/.` and
2252 /// `a/b` all have `a` and `b` as components, but `./a/b` starts with
2253 /// an additional [`CurDir`] component.
2255 /// * A trailing slash is normalized away, `/a/b` and `/a/b/` are equivalent.
2257 /// Note that no other normalization takes place; in particular, `a/c`
2258 /// and `a/b/../c` are distinct, to account for the possibility that `b`
2259 /// is a symbolic link (so its parent isn't `a`).
2264 /// use std::path::{Path, Component};
2265 /// use std::ffi::OsStr;
2267 /// let mut components = Path::new("/tmp/foo.txt").components();
2269 /// assert_eq!(components.next(), Some(Component::RootDir));
2270 /// assert_eq!(components.next(), Some(Component::Normal(OsStr::new("tmp"))));
2271 /// assert_eq!(components.next(), Some(Component::Normal(OsStr::new("foo.txt"))));
2272 /// assert_eq!(components.next(), None)
2275 /// [`Component`]: enum.Component.html
2276 /// [`CurDir`]: enum.Component.html#variant.CurDir
2277 #[stable(feature = "rust1", since = "1.0.0")]
2278 pub fn components(&self) -> Components<'_> {
2279 let prefix = parse_prefix(self.as_os_str());
2281 path: self.as_u8_slice(),
2283 has_physical_root: has_physical_root(self.as_u8_slice(), prefix)
2284 || has_redox_scheme(self.as_u8_slice()),
2285 front: State::Prefix,
2290 /// Produces an iterator over the path's components viewed as [`OsStr`]
2293 /// For more information about the particulars of how the path is separated
2294 /// into components, see [`components`].
2296 /// [`components`]: #method.components
2297 /// [`OsStr`]: ../ffi/struct.OsStr.html
2302 /// use std::path::{self, Path};
2303 /// use std::ffi::OsStr;
2305 /// let mut it = Path::new("/tmp/foo.txt").iter();
2306 /// assert_eq!(it.next(), Some(OsStr::new(&path::MAIN_SEPARATOR.to_string())));
2307 /// assert_eq!(it.next(), Some(OsStr::new("tmp")));
2308 /// assert_eq!(it.next(), Some(OsStr::new("foo.txt")));
2309 /// assert_eq!(it.next(), None)
2311 #[stable(feature = "rust1", since = "1.0.0")]
2312 pub fn iter(&self) -> Iter<'_> {
2313 Iter { inner: self.components() }
2316 /// Returns an object that implements [`Display`] for safely printing paths
2317 /// that may contain non-Unicode data.
2319 /// [`Display`]: ../fmt/trait.Display.html
2324 /// use std::path::Path;
2326 /// let path = Path::new("/tmp/foo.rs");
2328 /// println!("{}", path.display());
2330 #[stable(feature = "rust1", since = "1.0.0")]
2331 pub fn display(&self) -> Display<'_> {
2332 Display { path: self }
2335 /// Queries the file system to get information about a file, directory, etc.
2337 /// This function will traverse symbolic links to query information about the
2338 /// destination file.
2340 /// This is an alias to [`fs::metadata`].
2342 /// [`fs::metadata`]: ../fs/fn.metadata.html
2347 /// use std::path::Path;
2349 /// let path = Path::new("/Minas/tirith");
2350 /// let metadata = path.metadata().expect("metadata call failed");
2351 /// println!("{:?}", metadata.file_type());
2353 #[stable(feature = "path_ext", since = "1.5.0")]
2354 pub fn metadata(&self) -> io::Result<fs::Metadata> {
2358 /// Queries the metadata about a file without following symlinks.
2360 /// This is an alias to [`fs::symlink_metadata`].
2362 /// [`fs::symlink_metadata`]: ../fs/fn.symlink_metadata.html
2367 /// use std::path::Path;
2369 /// let path = Path::new("/Minas/tirith");
2370 /// let metadata = path.symlink_metadata().expect("symlink_metadata call failed");
2371 /// println!("{:?}", metadata.file_type());
2373 #[stable(feature = "path_ext", since = "1.5.0")]
2374 pub fn symlink_metadata(&self) -> io::Result<fs::Metadata> {
2375 fs::symlink_metadata(self)
2378 /// Returns the canonical, absolute form of the path with all intermediate
2379 /// components normalized and symbolic links resolved.
2381 /// This is an alias to [`fs::canonicalize`].
2383 /// [`fs::canonicalize`]: ../fs/fn.canonicalize.html
2388 /// use std::path::{Path, PathBuf};
2390 /// let path = Path::new("/foo/test/../test/bar.rs");
2391 /// assert_eq!(path.canonicalize().unwrap(), PathBuf::from("/foo/test/bar.rs"));
2393 #[stable(feature = "path_ext", since = "1.5.0")]
2394 pub fn canonicalize(&self) -> io::Result<PathBuf> {
2395 fs::canonicalize(self)
2398 /// Reads a symbolic link, returning the file that the link points to.
2400 /// This is an alias to [`fs::read_link`].
2402 /// [`fs::read_link`]: ../fs/fn.read_link.html
2407 /// use std::path::Path;
2409 /// let path = Path::new("/laputa/sky_castle.rs");
2410 /// let path_link = path.read_link().expect("read_link call failed");
2412 #[stable(feature = "path_ext", since = "1.5.0")]
2413 pub fn read_link(&self) -> io::Result<PathBuf> {
2417 /// Returns an iterator over the entries within a directory.
2419 /// The iterator will yield instances of [`io::Result`]`<`[`DirEntry`]`>`. New
2420 /// errors may be encountered after an iterator is initially constructed.
2422 /// This is an alias to [`fs::read_dir`].
2424 /// [`io::Result`]: ../io/type.Result.html
2425 /// [`DirEntry`]: ../fs/struct.DirEntry.html
2426 /// [`fs::read_dir`]: ../fs/fn.read_dir.html
2431 /// use std::path::Path;
2433 /// let path = Path::new("/laputa");
2434 /// for entry in path.read_dir().expect("read_dir call failed") {
2435 /// if let Ok(entry) = entry {
2436 /// println!("{:?}", entry.path());
2440 #[stable(feature = "path_ext", since = "1.5.0")]
2441 pub fn read_dir(&self) -> io::Result<fs::ReadDir> {
2445 /// Returns `true` if the path points at an existing entity.
2447 /// This function will traverse symbolic links to query information about the
2448 /// destination file. In case of broken symbolic links this will return `false`.
2450 /// If you cannot access the directory containing the file, e.g., because of a
2451 /// permission error, this will return `false`.
2456 /// use std::path::Path;
2457 /// assert_eq!(Path::new("does_not_exist.txt").exists(), false);
2462 /// This is a convenience function that coerces errors to false. If you want to
2463 /// check errors, call [fs::metadata].
2465 /// [fs::metadata]: ../../std/fs/fn.metadata.html
2466 #[stable(feature = "path_ext", since = "1.5.0")]
2467 pub fn exists(&self) -> bool {
2468 fs::metadata(self).is_ok()
2471 /// Returns `true` if the path exists on disk and is pointing at a regular file.
2473 /// This function will traverse symbolic links to query information about the
2474 /// destination file. In case of broken symbolic links this will return `false`.
2476 /// If you cannot access the directory containing the file, e.g., because of a
2477 /// permission error, this will return `false`.
2482 /// use std::path::Path;
2483 /// assert_eq!(Path::new("./is_a_directory/").is_file(), false);
2484 /// assert_eq!(Path::new("a_file.txt").is_file(), true);
2489 /// This is a convenience function that coerces errors to false. If you want to
2490 /// check errors, call [fs::metadata] and handle its Result. Then call
2491 /// [fs::Metadata::is_file] if it was Ok.
2493 /// [fs::metadata]: ../../std/fs/fn.metadata.html
2494 /// [fs::Metadata::is_file]: ../../std/fs/struct.Metadata.html#method.is_file
2495 #[stable(feature = "path_ext", since = "1.5.0")]
2496 pub fn is_file(&self) -> bool {
2497 fs::metadata(self).map(|m| m.is_file()).unwrap_or(false)
2500 /// Returns `true` if the path exists on disk and is pointing at a directory.
2502 /// This function will traverse symbolic links to query information about the
2503 /// destination file. In case of broken symbolic links this will return `false`.
2505 /// If you cannot access the directory containing the file, e.g., because of a
2506 /// permission error, this will return `false`.
2511 /// use std::path::Path;
2512 /// assert_eq!(Path::new("./is_a_directory/").is_dir(), true);
2513 /// assert_eq!(Path::new("a_file.txt").is_dir(), false);
2518 /// This is a convenience function that coerces errors to false. If you want to
2519 /// check errors, call [fs::metadata] and handle its Result. Then call
2520 /// [fs::Metadata::is_dir] if it was Ok.
2522 /// [fs::metadata]: ../../std/fs/fn.metadata.html
2523 /// [fs::Metadata::is_dir]: ../../std/fs/struct.Metadata.html#method.is_dir
2524 #[stable(feature = "path_ext", since = "1.5.0")]
2525 pub fn is_dir(&self) -> bool {
2526 fs::metadata(self).map(|m| m.is_dir()).unwrap_or(false)
2529 /// Converts a [`Box<Path>`][`Box`] into a [`PathBuf`] without copying or
2532 /// [`Box`]: ../../std/boxed/struct.Box.html
2533 /// [`PathBuf`]: struct.PathBuf.html
2534 #[stable(feature = "into_boxed_path", since = "1.20.0")]
2535 pub fn into_path_buf(self: Box<Path>) -> PathBuf {
2536 let rw = Box::into_raw(self) as *mut OsStr;
2537 let inner = unsafe { Box::from_raw(rw) };
2538 PathBuf { inner: OsString::from(inner) }
2542 #[stable(feature = "rust1", since = "1.0.0")]
2543 impl AsRef<OsStr> for Path {
2544 fn as_ref(&self) -> &OsStr {
2549 #[stable(feature = "rust1", since = "1.0.0")]
2550 impl fmt::Debug for Path {
2551 fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
2552 fmt::Debug::fmt(&self.inner, formatter)
2556 /// Helper struct for safely printing paths with [`format!`] and `{}`.
2558 /// A [`Path`] might contain non-Unicode data. This `struct` implements the
2559 /// [`Display`] trait in a way that mitigates that. It is created by the
2560 /// [`display`][`Path::display`] method on [`Path`].
2565 /// use std::path::Path;
2567 /// let path = Path::new("/tmp/foo.rs");
2569 /// println!("{}", path.display());
2572 /// [`Display`]: ../../std/fmt/trait.Display.html
2573 /// [`format!`]: ../../std/macro.format.html
2574 /// [`Path`]: struct.Path.html
2575 /// [`Path::display`]: struct.Path.html#method.display
2576 #[stable(feature = "rust1", since = "1.0.0")]
2577 pub struct Display<'a> {
2581 #[stable(feature = "rust1", since = "1.0.0")]
2582 impl fmt::Debug for Display<'_> {
2583 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2584 fmt::Debug::fmt(&self.path, f)
2588 #[stable(feature = "rust1", since = "1.0.0")]
2589 impl fmt::Display for Display<'_> {
2590 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2591 self.path.inner.display(f)
2595 #[stable(feature = "rust1", since = "1.0.0")]
2596 impl cmp::PartialEq for Path {
2597 fn eq(&self, other: &Path) -> bool {
2598 self.components().eq(other.components())
2602 #[stable(feature = "rust1", since = "1.0.0")]
2603 impl Hash for Path {
2604 fn hash<H: Hasher>(&self, h: &mut H) {
2605 for component in self.components() {
2611 #[stable(feature = "rust1", since = "1.0.0")]
2612 impl cmp::Eq for Path {}
2614 #[stable(feature = "rust1", since = "1.0.0")]
2615 impl cmp::PartialOrd for Path {
2616 fn partial_cmp(&self, other: &Path) -> Option<cmp::Ordering> {
2617 self.components().partial_cmp(other.components())
2621 #[stable(feature = "rust1", since = "1.0.0")]
2622 impl cmp::Ord for Path {
2623 fn cmp(&self, other: &Path) -> cmp::Ordering {
2624 self.components().cmp(other.components())
2628 #[stable(feature = "rust1", since = "1.0.0")]
2629 impl AsRef<Path> for Path {
2630 fn as_ref(&self) -> &Path {
2635 #[stable(feature = "rust1", since = "1.0.0")]
2636 impl AsRef<Path> for OsStr {
2637 fn as_ref(&self) -> &Path {
2642 #[stable(feature = "cow_os_str_as_ref_path", since = "1.8.0")]
2643 impl AsRef<Path> for Cow<'_, OsStr> {
2644 fn as_ref(&self) -> &Path {
2649 #[stable(feature = "rust1", since = "1.0.0")]
2650 impl AsRef<Path> for OsString {
2651 fn as_ref(&self) -> &Path {
2656 #[stable(feature = "rust1", since = "1.0.0")]
2657 impl AsRef<Path> for str {
2658 fn as_ref(&self) -> &Path {
2663 #[stable(feature = "rust1", since = "1.0.0")]
2664 impl AsRef<Path> for String {
2665 fn as_ref(&self) -> &Path {
2670 #[stable(feature = "rust1", since = "1.0.0")]
2671 impl AsRef<Path> for PathBuf {
2672 fn as_ref(&self) -> &Path {
2677 #[stable(feature = "path_into_iter", since = "1.6.0")]
2678 impl<'a> IntoIterator for &'a PathBuf {
2679 type Item = &'a OsStr;
2680 type IntoIter = Iter<'a>;
2681 fn into_iter(self) -> Iter<'a> {
2686 #[stable(feature = "path_into_iter", since = "1.6.0")]
2687 impl<'a> IntoIterator for &'a Path {
2688 type Item = &'a OsStr;
2689 type IntoIter = Iter<'a>;
2690 fn into_iter(self) -> Iter<'a> {
2695 macro_rules! impl_cmp {
2696 ($lhs:ty, $rhs: ty) => {
2697 #[stable(feature = "partialeq_path", since = "1.6.0")]
2698 impl<'a, 'b> PartialEq<$rhs> for $lhs {
2700 fn eq(&self, other: &$rhs) -> bool {
2701 <Path as PartialEq>::eq(self, other)
2705 #[stable(feature = "partialeq_path", since = "1.6.0")]
2706 impl<'a, 'b> PartialEq<$lhs> for $rhs {
2708 fn eq(&self, other: &$lhs) -> bool {
2709 <Path as PartialEq>::eq(self, other)
2713 #[stable(feature = "cmp_path", since = "1.8.0")]
2714 impl<'a, 'b> PartialOrd<$rhs> for $lhs {
2716 fn partial_cmp(&self, other: &$rhs) -> Option<cmp::Ordering> {
2717 <Path as PartialOrd>::partial_cmp(self, other)
2721 #[stable(feature = "cmp_path", since = "1.8.0")]
2722 impl<'a, 'b> PartialOrd<$lhs> for $rhs {
2724 fn partial_cmp(&self, other: &$lhs) -> Option<cmp::Ordering> {
2725 <Path as PartialOrd>::partial_cmp(self, other)
2731 impl_cmp!(PathBuf, Path);
2732 impl_cmp!(PathBuf, &'a Path);
2733 impl_cmp!(Cow<'a, Path>, Path);
2734 impl_cmp!(Cow<'a, Path>, &'b Path);
2735 impl_cmp!(Cow<'a, Path>, PathBuf);
2737 macro_rules! impl_cmp_os_str {
2738 ($lhs:ty, $rhs: ty) => {
2739 #[stable(feature = "cmp_path", since = "1.8.0")]
2740 impl<'a, 'b> PartialEq<$rhs> for $lhs {
2742 fn eq(&self, other: &$rhs) -> bool {
2743 <Path as PartialEq>::eq(self, other.as_ref())
2747 #[stable(feature = "cmp_path", since = "1.8.0")]
2748 impl<'a, 'b> PartialEq<$lhs> for $rhs {
2750 fn eq(&self, other: &$lhs) -> bool {
2751 <Path as PartialEq>::eq(self.as_ref(), other)
2755 #[stable(feature = "cmp_path", since = "1.8.0")]
2756 impl<'a, 'b> PartialOrd<$rhs> for $lhs {
2758 fn partial_cmp(&self, other: &$rhs) -> Option<cmp::Ordering> {
2759 <Path as PartialOrd>::partial_cmp(self, other.as_ref())
2763 #[stable(feature = "cmp_path", since = "1.8.0")]
2764 impl<'a, 'b> PartialOrd<$lhs> for $rhs {
2766 fn partial_cmp(&self, other: &$lhs) -> Option<cmp::Ordering> {
2767 <Path as PartialOrd>::partial_cmp(self.as_ref(), other)
2773 impl_cmp_os_str!(PathBuf, OsStr);
2774 impl_cmp_os_str!(PathBuf, &'a OsStr);
2775 impl_cmp_os_str!(PathBuf, Cow<'a, OsStr>);
2776 impl_cmp_os_str!(PathBuf, OsString);
2777 impl_cmp_os_str!(Path, OsStr);
2778 impl_cmp_os_str!(Path, &'a OsStr);
2779 impl_cmp_os_str!(Path, Cow<'a, OsStr>);
2780 impl_cmp_os_str!(Path, OsString);
2781 impl_cmp_os_str!(&'a Path, OsStr);
2782 impl_cmp_os_str!(&'a Path, Cow<'b, OsStr>);
2783 impl_cmp_os_str!(&'a Path, OsString);
2784 impl_cmp_os_str!(Cow<'a, Path>, OsStr);
2785 impl_cmp_os_str!(Cow<'a, Path>, &'b OsStr);
2786 impl_cmp_os_str!(Cow<'a, Path>, OsString);
2788 #[stable(since = "1.7.0", feature = "strip_prefix")]
2789 impl fmt::Display for StripPrefixError {
2790 #[allow(deprecated, deprecated_in_future)]
2791 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2792 self.description().fmt(f)
2796 #[stable(since = "1.7.0", feature = "strip_prefix")]
2797 impl Error for StripPrefixError {
2798 #[allow(deprecated)]
2799 fn description(&self) -> &str {
2809 use crate::sync::Arc;
2812 ($path:expr, iter: $iter:expr) => (
2814 let path = Path::new($path);
2816 // Forward iteration
2817 let comps = path.iter()
2818 .map(|p| p.to_string_lossy().into_owned())
2819 .collect::<Vec<String>>();
2820 let exp: &[&str] = &$iter;
2821 let exps = exp.iter().map(|s| s.to_string()).collect::<Vec<String>>();
2822 assert!(comps == exps, "iter: Expected {:?}, found {:?}",
2825 // Reverse iteration
2826 let comps = Path::new($path).iter().rev()
2827 .map(|p| p.to_string_lossy().into_owned())
2828 .collect::<Vec<String>>();
2829 let exps = exps.into_iter().rev().collect::<Vec<String>>();
2830 assert!(comps == exps, "iter().rev(): Expected {:?}, found {:?}",
2835 ($path:expr, has_root: $has_root:expr, is_absolute: $is_absolute:expr) => (
2837 let path = Path::new($path);
2839 let act_root = path.has_root();
2840 assert!(act_root == $has_root, "has_root: Expected {:?}, found {:?}",
2841 $has_root, act_root);
2843 let act_abs = path.is_absolute();
2844 assert!(act_abs == $is_absolute, "is_absolute: Expected {:?}, found {:?}",
2845 $is_absolute, act_abs);
2849 ($path:expr, parent: $parent:expr, file_name: $file:expr) => (
2851 let path = Path::new($path);
2853 let parent = path.parent().map(|p| p.to_str().unwrap());
2854 let exp_parent: Option<&str> = $parent;
2855 assert!(parent == exp_parent, "parent: Expected {:?}, found {:?}",
2856 exp_parent, parent);
2858 let file = path.file_name().map(|p| p.to_str().unwrap());
2859 let exp_file: Option<&str> = $file;
2860 assert!(file == exp_file, "file_name: Expected {:?}, found {:?}",
2865 ($path:expr, file_stem: $file_stem:expr, extension: $extension:expr) => (
2867 let path = Path::new($path);
2869 let stem = path.file_stem().map(|p| p.to_str().unwrap());
2870 let exp_stem: Option<&str> = $file_stem;
2871 assert!(stem == exp_stem, "file_stem: Expected {:?}, found {:?}",
2874 let ext = path.extension().map(|p| p.to_str().unwrap());
2875 let exp_ext: Option<&str> = $extension;
2876 assert!(ext == exp_ext, "extension: Expected {:?}, found {:?}",
2881 ($path:expr, iter: $iter:expr,
2882 has_root: $has_root:expr, is_absolute: $is_absolute:expr,
2883 parent: $parent:expr, file_name: $file:expr,
2884 file_stem: $file_stem:expr, extension: $extension:expr) => (
2886 t!($path, iter: $iter);
2887 t!($path, has_root: $has_root, is_absolute: $is_absolute);
2888 t!($path, parent: $parent, file_name: $file);
2889 t!($path, file_stem: $file_stem, extension: $extension);
2896 use crate::borrow::Cow;
2898 let static_path = Path::new("/home/foo");
2899 let static_cow_path: Cow<'static, Path> = static_path.into();
2900 let pathbuf = PathBuf::from("/home/foo");
2903 let path: &Path = &pathbuf;
2904 let borrowed_cow_path: Cow<'_, Path> = path.into();
2906 assert_eq!(static_cow_path, borrowed_cow_path);
2909 let owned_cow_path: Cow<'static, Path> = pathbuf.into();
2911 assert_eq!(static_cow_path, owned_cow_path);
2916 pub fn test_decompositions_unix() {
2932 file_name: Some("foo"),
2933 file_stem: Some("foo"),
2952 file_name: Some("foo"),
2953 file_stem: Some("foo"),
2962 file_name: Some("foo"),
2963 file_stem: Some("foo"),
2972 file_name: Some("foo"),
2973 file_stem: Some("foo"),
2978 iter: ["foo", "bar"],
2981 parent: Some("foo"),
2982 file_name: Some("bar"),
2983 file_stem: Some("bar"),
2988 iter: ["/", "foo", "bar"],
2991 parent: Some("/foo"),
2992 file_name: Some("bar"),
2993 file_stem: Some("bar"),
3002 file_name: Some("foo"),
3003 file_stem: Some("foo"),
3008 iter: ["/", "foo", "bar"],
3011 parent: Some("///foo"),
3012 file_name: Some("bar"),
3013 file_stem: Some("bar"),
3052 file_name: Some("foo"),
3053 file_stem: Some("foo"),
3058 iter: ["foo", ".."],
3061 parent: Some("foo"),
3072 file_name: Some("foo"),
3073 file_stem: Some("foo"),
3078 iter: ["foo", "bar"],
3081 parent: Some("foo"),
3082 file_name: Some("bar"),
3083 file_stem: Some("bar"),
3088 iter: ["foo", ".."],
3091 parent: Some("foo"),
3098 iter: ["foo", "..", "bar"],
3101 parent: Some("foo/.."),
3102 file_name: Some("bar"),
3103 file_stem: Some("bar"),
3112 file_name: Some("a"),
3113 file_stem: Some("a"),
3142 file_name: Some("b"),
3143 file_stem: Some("b"),
3152 file_name: Some("b"),
3153 file_stem: Some("b"),
3162 file_name: Some("b"),
3163 file_stem: Some("b"),
3168 iter: ["a", "b", "c"],
3171 parent: Some("a/b"),
3172 file_name: Some("c"),
3173 file_stem: Some("c"),
3182 file_name: Some(".foo"),
3183 file_stem: Some(".foo"),
3190 pub fn test_decompositions_windows() {
3206 file_name: Some("foo"),
3207 file_stem: Some("foo"),
3262 iter: ["\\", "foo"],
3266 file_name: Some("foo"),
3267 file_stem: Some("foo"),
3276 file_name: Some("foo"),
3277 file_stem: Some("foo"),
3282 iter: ["\\", "foo"],
3286 file_name: Some("foo"),
3287 file_stem: Some("foo"),
3292 iter: ["foo", "bar"],
3295 parent: Some("foo"),
3296 file_name: Some("bar"),
3297 file_stem: Some("bar"),
3302 iter: ["\\", "foo", "bar"],
3305 parent: Some("/foo"),
3306 file_name: Some("bar"),
3307 file_stem: Some("bar"),
3312 iter: ["\\", "foo"],
3316 file_name: Some("foo"),
3317 file_stem: Some("foo"),
3322 iter: ["\\", "foo", "bar"],
3325 parent: Some("///foo"),
3326 file_name: Some("bar"),
3327 file_stem: Some("bar"),
3366 file_name: Some("foo"),
3367 file_stem: Some("foo"),
3372 iter: ["foo", ".."],
3375 parent: Some("foo"),
3386 file_name: Some("foo"),
3387 file_stem: Some("foo"),
3392 iter: ["foo", "bar"],
3395 parent: Some("foo"),
3396 file_name: Some("bar"),
3397 file_stem: Some("bar"),
3402 iter: ["foo", ".."],
3405 parent: Some("foo"),
3412 iter: ["foo", "..", "bar"],
3415 parent: Some("foo/.."),
3416 file_name: Some("bar"),
3417 file_stem: Some("bar"),
3426 file_name: Some("a"),
3427 file_stem: Some("a"),
3456 file_name: Some("b"),
3457 file_stem: Some("b"),
3466 file_name: Some("b"),
3467 file_stem: Some("b"),
3476 file_name: Some("b"),
3477 file_stem: Some("b"),
3482 iter: ["a", "b", "c"],
3485 parent: Some("a/b"),
3486 file_name: Some("c"),
3487 file_stem: Some("c"),
3491 iter: ["a", "b", "c"],
3494 parent: Some("a\\b"),
3495 file_name: Some("c"),
3496 file_stem: Some("c"),
3505 file_name: Some("a"),
3506 file_stem: Some("a"),
3511 iter: ["c:", "\\", "foo.txt"],
3514 parent: Some("c:\\"),
3515 file_name: Some("foo.txt"),
3516 file_stem: Some("foo"),
3517 extension: Some("txt")
3520 t!("\\\\server\\share\\foo.txt",
3521 iter: ["\\\\server\\share", "\\", "foo.txt"],
3524 parent: Some("\\\\server\\share\\"),
3525 file_name: Some("foo.txt"),
3526 file_stem: Some("foo"),
3527 extension: Some("txt")
3530 t!("\\\\server\\share",
3531 iter: ["\\\\server\\share", "\\"],
3541 iter: ["\\", "server"],
3545 file_name: Some("server"),
3546 file_stem: Some("server"),
3550 t!("\\\\?\\bar\\foo.txt",
3551 iter: ["\\\\?\\bar", "\\", "foo.txt"],
3554 parent: Some("\\\\?\\bar\\"),
3555 file_name: Some("foo.txt"),
3556 file_stem: Some("foo"),
3557 extension: Some("txt")
3561 iter: ["\\\\?\\bar"],
3580 t!("\\\\?\\UNC\\server\\share\\foo.txt",
3581 iter: ["\\\\?\\UNC\\server\\share", "\\", "foo.txt"],
3584 parent: Some("\\\\?\\UNC\\server\\share\\"),
3585 file_name: Some("foo.txt"),
3586 file_stem: Some("foo"),
3587 extension: Some("txt")
3590 t!("\\\\?\\UNC\\server",
3591 iter: ["\\\\?\\UNC\\server"],
3601 iter: ["\\\\?\\UNC\\"],
3610 t!("\\\\?\\C:\\foo.txt",
3611 iter: ["\\\\?\\C:", "\\", "foo.txt"],
3614 parent: Some("\\\\?\\C:\\"),
3615 file_name: Some("foo.txt"),
3616 file_stem: Some("foo"),
3617 extension: Some("txt")
3621 iter: ["\\\\?\\C:", "\\"],
3631 iter: ["\\\\?\\C:"],
3640 t!("\\\\?\\foo/bar",
3641 iter: ["\\\\?\\foo/bar"],
3651 iter: ["\\\\?\\C:/foo"],
3660 t!("\\\\.\\foo\\bar",
3661 iter: ["\\\\.\\foo", "\\", "bar"],
3664 parent: Some("\\\\.\\foo\\"),
3665 file_name: Some("bar"),
3666 file_stem: Some("bar"),
3671 iter: ["\\\\.\\foo", "\\"],
3680 t!("\\\\.\\foo/bar",
3681 iter: ["\\\\.\\foo/bar", "\\"],
3690 t!("\\\\.\\foo\\bar/baz",
3691 iter: ["\\\\.\\foo", "\\", "bar", "baz"],
3694 parent: Some("\\\\.\\foo\\bar"),
3695 file_name: Some("baz"),
3696 file_stem: Some("baz"),
3701 iter: ["\\\\.\\", "\\"],
3711 iter: ["\\\\?\\a", "\\", "b"],
3714 parent: Some("\\\\?\\a\\"),
3715 file_name: Some("b"),
3716 file_stem: Some("b"),
3722 pub fn test_stem_ext() {
3724 file_stem: Some("foo"),
3729 file_stem: Some("foo"),
3734 file_stem: Some(".foo"),
3739 file_stem: Some("foo"),
3740 extension: Some("txt")
3744 file_stem: Some("foo.bar"),
3745 extension: Some("txt")
3749 file_stem: Some("foo.bar"),
3753 t!(".", file_stem: None, extension: None);
3755 t!("..", file_stem: None, extension: None);
3757 t!("", file_stem: None, extension: None);
3761 pub fn test_push() {
3763 ($path:expr, $push:expr, $expected:expr) => ( {
3764 let mut actual = PathBuf::from($path);
3766 assert!(actual.to_str() == Some($expected),
3767 "pushing {:?} onto {:?}: Expected {:?}, got {:?}",
3768 $push, $path, $expected, actual.to_str().unwrap());
3772 if cfg!(unix) || cfg!(all(target_env = "sgx", target_vendor = "fortanix")) {
3773 tp!("", "foo", "foo");
3774 tp!("foo", "bar", "foo/bar");
3775 tp!("foo/", "bar", "foo/bar");
3776 tp!("foo//", "bar", "foo//bar");
3777 tp!("foo/.", "bar", "foo/./bar");
3778 tp!("foo./.", "bar", "foo././bar");
3779 tp!("foo", "", "foo/");
3780 tp!("foo", ".", "foo/.");
3781 tp!("foo", "..", "foo/..");
3782 tp!("foo", "/", "/");
3783 tp!("/foo/bar", "/", "/");
3784 tp!("/foo/bar", "/baz", "/baz");
3785 tp!("/foo/bar", "./baz", "/foo/bar/./baz");
3787 tp!("", "foo", "foo");
3788 tp!("foo", "bar", r"foo\bar");
3789 tp!("foo/", "bar", r"foo/bar");
3790 tp!(r"foo\", "bar", r"foo\bar");
3791 tp!("foo//", "bar", r"foo//bar");
3792 tp!(r"foo\\", "bar", r"foo\\bar");
3793 tp!("foo/.", "bar", r"foo/.\bar");
3794 tp!("foo./.", "bar", r"foo./.\bar");
3795 tp!(r"foo\.", "bar", r"foo\.\bar");
3796 tp!(r"foo.\.", "bar", r"foo.\.\bar");
3797 tp!("foo", "", "foo\\");
3798 tp!("foo", ".", r"foo\.");
3799 tp!("foo", "..", r"foo\..");
3800 tp!("foo", "/", "/");
3801 tp!("foo", r"\", r"\");
3802 tp!("/foo/bar", "/", "/");
3803 tp!(r"\foo\bar", r"\", r"\");
3804 tp!("/foo/bar", "/baz", "/baz");
3805 tp!("/foo/bar", r"\baz", r"\baz");
3806 tp!("/foo/bar", "./baz", r"/foo/bar\./baz");
3807 tp!("/foo/bar", r".\baz", r"/foo/bar\.\baz");
3809 tp!("c:\\", "windows", "c:\\windows");
3810 tp!("c:", "windows", "c:windows");
3812 tp!("a\\b\\c", "d", "a\\b\\c\\d");
3813 tp!("\\a\\b\\c", "d", "\\a\\b\\c\\d");
3814 tp!("a\\b", "c\\d", "a\\b\\c\\d");
3815 tp!("a\\b", "\\c\\d", "\\c\\d");
3816 tp!("a\\b", ".", "a\\b\\.");
3817 tp!("a\\b", "..\\c", "a\\b\\..\\c");
3818 tp!("a\\b", "C:a.txt", "C:a.txt");
3819 tp!("a\\b", "C:\\a.txt", "C:\\a.txt");
3820 tp!("C:\\a", "C:\\b.txt", "C:\\b.txt");
3821 tp!("C:\\a\\b\\c", "C:d", "C:d");
3822 tp!("C:a\\b\\c", "C:d", "C:d");
3823 tp!("C:", r"a\b\c", r"C:a\b\c");
3824 tp!("C:", r"..\a", r"C:..\a");
3825 tp!("\\\\server\\share\\foo", "bar", "\\\\server\\share\\foo\\bar");
3826 tp!("\\\\server\\share\\foo", "C:baz", "C:baz");
3827 tp!("\\\\?\\C:\\a\\b", "C:c\\d", "C:c\\d");
3828 tp!("\\\\?\\C:a\\b", "C:c\\d", "C:c\\d");
3829 tp!("\\\\?\\C:\\a\\b", "C:\\c\\d", "C:\\c\\d");
3830 tp!("\\\\?\\foo\\bar", "baz", "\\\\?\\foo\\bar\\baz");
3831 tp!("\\\\?\\UNC\\server\\share\\foo", "bar", "\\\\?\\UNC\\server\\share\\foo\\bar");
3832 tp!("\\\\?\\UNC\\server\\share", "C:\\a", "C:\\a");
3833 tp!("\\\\?\\UNC\\server\\share", "C:a", "C:a");
3835 // Note: modified from old path API
3836 tp!("\\\\?\\UNC\\server", "foo", "\\\\?\\UNC\\server\\foo");
3838 tp!("C:\\a", "\\\\?\\UNC\\server\\share", "\\\\?\\UNC\\server\\share");
3839 tp!("\\\\.\\foo\\bar", "baz", "\\\\.\\foo\\bar\\baz");
3840 tp!("\\\\.\\foo\\bar", "C:a", "C:a");
3841 // again, not sure about the following, but I'm assuming \\.\ should be verbatim
3842 tp!("\\\\.\\foo", "..\\bar", "\\\\.\\foo\\..\\bar");
3844 tp!("\\\\?\\C:", "foo", "\\\\?\\C:\\foo"); // this is a weird one
3851 ($path:expr, $expected:expr, $output:expr) => ( {
3852 let mut actual = PathBuf::from($path);
3853 let output = actual.pop();
3854 assert!(actual.to_str() == Some($expected) && output == $output,
3855 "popping from {:?}: Expected {:?}/{:?}, got {:?}/{:?}",
3856 $path, $expected, $output,
3857 actual.to_str().unwrap(), output);
3862 tp!("/", "/", false);
3863 tp!("foo", "", true);
3865 tp!("/foo", "/", true);
3866 tp!("/foo/bar", "/foo", true);
3867 tp!("foo/bar", "foo", true);
3868 tp!("foo/.", "", true);
3869 tp!("foo//bar", "foo", true);
3872 tp!("a\\b\\c", "a\\b", true);
3873 tp!("\\a", "\\", true);
3874 tp!("\\", "\\", false);
3876 tp!("C:\\a\\b", "C:\\a", true);
3877 tp!("C:\\a", "C:\\", true);
3878 tp!("C:\\", "C:\\", false);
3879 tp!("C:a\\b", "C:a", true);
3880 tp!("C:a", "C:", true);
3881 tp!("C:", "C:", false);
3882 tp!("\\\\server\\share\\a\\b", "\\\\server\\share\\a", true);
3883 tp!("\\\\server\\share\\a", "\\\\server\\share\\", true);
3884 tp!("\\\\server\\share", "\\\\server\\share", false);
3885 tp!("\\\\?\\a\\b\\c", "\\\\?\\a\\b", true);
3886 tp!("\\\\?\\a\\b", "\\\\?\\a\\", true);
3887 tp!("\\\\?\\a", "\\\\?\\a", false);
3888 tp!("\\\\?\\C:\\a\\b", "\\\\?\\C:\\a", true);
3889 tp!("\\\\?\\C:\\a", "\\\\?\\C:\\", true);
3890 tp!("\\\\?\\C:\\", "\\\\?\\C:\\", false);
3891 tp!("\\\\?\\UNC\\server\\share\\a\\b", "\\\\?\\UNC\\server\\share\\a", true);
3892 tp!("\\\\?\\UNC\\server\\share\\a", "\\\\?\\UNC\\server\\share\\", true);
3893 tp!("\\\\?\\UNC\\server\\share", "\\\\?\\UNC\\server\\share", false);
3894 tp!("\\\\.\\a\\b\\c", "\\\\.\\a\\b", true);
3895 tp!("\\\\.\\a\\b", "\\\\.\\a\\", true);
3896 tp!("\\\\.\\a", "\\\\.\\a", false);
3898 tp!("\\\\?\\a\\b\\", "\\\\?\\a\\", true);
3903 pub fn test_set_file_name() {
3905 ($path:expr, $file:expr, $expected:expr) => ( {
3906 let mut p = PathBuf::from($path);
3907 p.set_file_name($file);
3908 assert!(p.to_str() == Some($expected),
3909 "setting file name of {:?} to {:?}: Expected {:?}, got {:?}",
3910 $path, $file, $expected,
3911 p.to_str().unwrap());
3915 tfn!("foo", "foo", "foo");
3916 tfn!("foo", "bar", "bar");
3917 tfn!("foo", "", "");
3918 tfn!("", "foo", "foo");
3919 if cfg!(unix) || cfg!(all(target_env = "sgx", target_vendor = "fortanix")) {
3920 tfn!(".", "foo", "./foo");
3921 tfn!("foo/", "bar", "bar");
3922 tfn!("foo/.", "bar", "bar");
3923 tfn!("..", "foo", "../foo");
3924 tfn!("foo/..", "bar", "foo/../bar");
3925 tfn!("/", "foo", "/foo");
3927 tfn!(".", "foo", r".\foo");
3928 tfn!(r"foo\", "bar", r"bar");
3929 tfn!(r"foo\.", "bar", r"bar");
3930 tfn!("..", "foo", r"..\foo");
3931 tfn!(r"foo\..", "bar", r"foo\..\bar");
3932 tfn!(r"\", "foo", r"\foo");
3937 pub fn test_set_extension() {
3939 ($path:expr, $ext:expr, $expected:expr, $output:expr) => ( {
3940 let mut p = PathBuf::from($path);
3941 let output = p.set_extension($ext);
3942 assert!(p.to_str() == Some($expected) && output == $output,
3943 "setting extension of {:?} to {:?}: Expected {:?}/{:?}, got {:?}/{:?}",
3944 $path, $ext, $expected, $output,
3945 p.to_str().unwrap(), output);
3949 tfe!("foo", "txt", "foo.txt", true);
3950 tfe!("foo.bar", "txt", "foo.txt", true);
3951 tfe!("foo.bar.baz", "txt", "foo.bar.txt", true);
3952 tfe!(".test", "txt", ".test.txt", true);
3953 tfe!("foo.txt", "", "foo", true);
3954 tfe!("foo", "", "foo", true);
3955 tfe!("", "foo", "", false);
3956 tfe!(".", "foo", ".", false);
3957 tfe!("foo/", "bar", "foo.bar", true);
3958 tfe!("foo/.", "bar", "foo.bar", true);
3959 tfe!("..", "foo", "..", false);
3960 tfe!("foo/..", "bar", "foo/..", false);
3961 tfe!("/", "foo", "/", false);
3965 fn test_eq_receivers() {
3966 use crate::borrow::Cow;
3968 let borrowed: &Path = Path::new("foo/bar");
3969 let mut owned: PathBuf = PathBuf::new();
3972 let borrowed_cow: Cow<'_, Path> = borrowed.into();
3973 let owned_cow: Cow<'_, Path> = owned.clone().into();
3976 ($($current:expr),+) => {
3978 assert_eq!($current, borrowed);
3979 assert_eq!($current, owned);
3980 assert_eq!($current, borrowed_cow);
3981 assert_eq!($current, owned_cow);
3986 t!(borrowed, owned, borrowed_cow, owned_cow);
3990 pub fn test_compare() {
3991 use crate::collections::hash_map::DefaultHasher;
3992 use crate::hash::{Hash, Hasher};
3994 fn hash<T: Hash>(t: T) -> u64 {
3995 let mut s = DefaultHasher::new();
4001 ($path1:expr, $path2:expr, eq: $eq:expr,
4002 starts_with: $starts_with:expr, ends_with: $ends_with:expr,
4003 relative_from: $relative_from:expr) => ({
4004 let path1 = Path::new($path1);
4005 let path2 = Path::new($path2);
4007 let eq = path1 == path2;
4008 assert!(eq == $eq, "{:?} == {:?}, expected {:?}, got {:?}",
4009 $path1, $path2, $eq, eq);
4010 assert!($eq == (hash(path1) == hash(path2)),
4011 "{:?} == {:?}, expected {:?}, got {} and {}",
4012 $path1, $path2, $eq, hash(path1), hash(path2));
4014 let starts_with = path1.starts_with(path2);
4015 assert!(starts_with == $starts_with,
4016 "{:?}.starts_with({:?}), expected {:?}, got {:?}", $path1, $path2,
4017 $starts_with, starts_with);
4019 let ends_with = path1.ends_with(path2);
4020 assert!(ends_with == $ends_with,
4021 "{:?}.ends_with({:?}), expected {:?}, got {:?}", $path1, $path2,
4022 $ends_with, ends_with);
4024 let relative_from = path1.strip_prefix(path2)
4025 .map(|p| p.to_str().unwrap())
4027 let exp: Option<&str> = $relative_from;
4028 assert!(relative_from == exp,
4029 "{:?}.strip_prefix({:?}), expected {:?}, got {:?}",
4030 $path1, $path2, exp, relative_from);
4038 relative_from: Some("")
4045 relative_from: Some("foo")
4059 relative_from: Some("")
4066 relative_from: Some("")
4069 tc!("foo/bar", "foo",
4073 relative_from: Some("bar")
4076 tc!("foo/bar/baz", "foo/bar",
4080 relative_from: Some("baz")
4083 tc!("foo/bar", "foo/bar/baz",
4090 tc!("./foo/bar/", ".",
4094 relative_from: Some("foo/bar")
4098 tc!(r"C:\src\rust\cargo-test\test\Cargo.toml",
4099 r"c:\src\rust\cargo-test\test",
4103 relative_from: Some("Cargo.toml")
4106 tc!(r"c:\foo", r"C:\foo",
4110 relative_from: Some("")
4116 fn test_components_debug() {
4117 let path = Path::new("/tmp");
4119 let mut components = path.components();
4121 let expected = "Components([RootDir, Normal(\"tmp\")])";
4122 let actual = format!("{:?}", components);
4123 assert_eq!(expected, actual);
4125 let _ = components.next().unwrap();
4126 let expected = "Components([Normal(\"tmp\")])";
4127 let actual = format!("{:?}", components);
4128 assert_eq!(expected, actual);
4130 let _ = components.next().unwrap();
4131 let expected = "Components([])";
4132 let actual = format!("{:?}", components);
4133 assert_eq!(expected, actual);
4138 fn test_iter_debug() {
4139 let path = Path::new("/tmp");
4141 let mut iter = path.iter();
4143 let expected = "Iter([\"/\", \"tmp\"])";
4144 let actual = format!("{:?}", iter);
4145 assert_eq!(expected, actual);
4147 let _ = iter.next().unwrap();
4148 let expected = "Iter([\"tmp\"])";
4149 let actual = format!("{:?}", iter);
4150 assert_eq!(expected, actual);
4152 let _ = iter.next().unwrap();
4153 let expected = "Iter([])";
4154 let actual = format!("{:?}", iter);
4155 assert_eq!(expected, actual);
4160 let orig: &str = "some/sort/of/path";
4161 let path = Path::new(orig);
4162 let boxed: Box<Path> = Box::from(path);
4163 let path_buf = path.to_owned().into_boxed_path().into_path_buf();
4164 assert_eq!(path, &*boxed);
4165 assert_eq!(&*boxed, &*path_buf);
4166 assert_eq!(&*path_buf, path);
4170 fn test_clone_into() {
4171 let mut path_buf = PathBuf::from("supercalifragilisticexpialidocious");
4172 let path = Path::new("short");
4173 path.clone_into(&mut path_buf);
4174 assert_eq!(path, path_buf);
4175 assert!(path_buf.into_os_string().capacity() >= 15);
4179 fn display_format_flags() {
4180 assert_eq!(format!("a{:#<5}b", Path::new("").display()), "a#####b");
4181 assert_eq!(format!("a{:#<5}b", Path::new("a").display()), "aa####b");
4186 let orig = "hello/world";
4187 let path = Path::new(orig);
4188 let rc: Rc<Path> = Rc::from(path);
4189 let arc: Arc<Path> = Arc::from(path);
4191 assert_eq!(&*rc, path);
4192 assert_eq!(&*arc, path);
4194 let rc2: Rc<Path> = Rc::from(path.to_owned());
4195 let arc2: Arc<Path> = Arc::from(path.to_owned());
4197 assert_eq!(&*rc2, path);
4198 assert_eq!(&*arc2, path);