1 // Copyright 2015 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 //! Cross-platform path manipulation.
13 //! This module provides two types, [`PathBuf`] and [`Path`][`Path`] (akin to [`String`]
14 //! and [`str`]), for working with paths abstractly. These types are thin wrappers
15 //! around [`OsString`] and [`OsStr`] respectively, meaning that they work directly
16 //! on strings according to the local platform's path syntax.
18 //! Paths can be parsed into [`Component`]s by iterating over the structure
19 //! returned by the [`components`] method on [`Path`]. [`Component`]s roughly
20 //! correspond to the substrings between path separators (`/` or `\`). You can
21 //! reconstruct an equivalent path from components with the [`push`] method on
22 //! [`PathBuf`]; note that the paths may differ syntactically by the
23 //! normalization described in the documentation for the [`components`] method.
27 //! Path manipulation includes both parsing components from slices and building
30 //! To parse a path, you can create a [`Path`] slice from a [`str`]
31 //! slice and start asking questions:
34 //! use std::path::Path;
35 //! use std::ffi::OsStr;
37 //! let path = Path::new("/tmp/foo/bar.txt");
39 //! let parent = path.parent();
40 //! assert_eq!(parent, Some(Path::new("/tmp/foo")));
42 //! let file_stem = path.file_stem();
43 //! assert_eq!(file_stem, Some(OsStr::new("bar")));
45 //! let extension = path.extension();
46 //! assert_eq!(extension, Some(OsStr::new("txt")));
49 //! To build or modify paths, use [`PathBuf`]:
52 //! use std::path::PathBuf;
54 //! // This way works...
55 //! let mut path = PathBuf::from("c:\\");
57 //! path.push("windows");
58 //! path.push("system32");
60 //! path.set_extension("dll");
62 //! // ... but push is best used if you don't know everything up
63 //! // front. If you do, this way is better:
64 //! let path: PathBuf = ["c:\\", "windows", "system32.dll"].iter().collect();
67 //! [`Component`]: ../../std/path/enum.Component.html
68 //! [`components`]: ../../std/path/struct.Path.html#method.components
69 //! [`PathBuf`]: ../../std/path/struct.PathBuf.html
70 //! [`Path`]: ../../std/path/struct.Path.html
71 //! [`push`]: ../../std/path/struct.PathBuf.html#method.push
72 //! [`String`]: ../../std/string/struct.String.html
74 //! [`str`]: ../../std/primitive.str.html
75 //! [`OsString`]: ../../std/ffi/struct.OsString.html
76 //! [`OsStr`]: ../../std/ffi/struct.OsStr.html
78 #![stable(feature = "rust1", since = "1.0.0")]
80 use borrow::{Borrow, Cow};
85 use hash::{Hash, Hasher};
87 use iter::{self, FusedIterator};
88 use ops::{self, Deref};
91 use string::ParseError;
94 use ffi::{OsStr, OsString};
96 use sys::path::{is_sep_byte, is_verbatim_sep, MAIN_SEP_STR, parse_prefix};
98 ////////////////////////////////////////////////////////////////////////////////
100 ////////////////////////////////////////////////////////////////////////////////
102 // Parsing in this module is done by directly transmuting OsStr to [u8] slices,
103 // taking advantage of the fact that OsStr always encodes ASCII characters
104 // as-is. Eventually, this transmutation should be replaced by direct uses of
105 // OsStr APIs for parsing, but it will take a while for those to become
108 ////////////////////////////////////////////////////////////////////////////////
110 ////////////////////////////////////////////////////////////////////////////////
112 /// Windows path prefixes, e.g. `C:` or `\\server\share`.
114 /// Windows uses a variety of path prefix styles, including references to drive
115 /// volumes (like `C:`), network shared folders (like `\\server\share`), and
116 /// others. In addition, some path prefixes are "verbatim" (i.e. prefixed with
117 /// `\\?\`), in which case `/` is *not* treated as a separator and essentially
118 /// no normalization is performed.
123 /// use std::path::{Component, Path, Prefix};
124 /// use std::path::Prefix::*;
125 /// use std::ffi::OsStr;
127 /// fn get_path_prefix(s: &str) -> Prefix {
128 /// let path = Path::new(s);
129 /// match path.components().next().unwrap() {
130 /// Component::Prefix(prefix_component) => prefix_component.kind(),
135 /// # if cfg!(windows) {
136 /// assert_eq!(Verbatim(OsStr::new("pictures")),
137 /// get_path_prefix(r"\\?\pictures\kittens"));
138 /// assert_eq!(VerbatimUNC(OsStr::new("server"), OsStr::new("share")),
139 /// get_path_prefix(r"\\?\UNC\server\share"));
140 /// assert_eq!(VerbatimDisk(b'C'), get_path_prefix(r"\\?\c:\"));
141 /// assert_eq!(DeviceNS(OsStr::new("BrainInterface")),
142 /// get_path_prefix(r"\\.\BrainInterface"));
143 /// assert_eq!(UNC(OsStr::new("server"), OsStr::new("share")),
144 /// get_path_prefix(r"\\server\share"));
145 /// assert_eq!(Disk(b'C'), get_path_prefix(r"C:\Users\Rust\Pictures\Ferris"));
148 #[derive(Copy, Clone, Debug, Hash, PartialOrd, Ord, PartialEq, Eq)]
149 #[stable(feature = "rust1", since = "1.0.0")]
150 pub enum Prefix<'a> {
151 /// Verbatim prefix, e.g. `\\?\cat_pics`.
153 /// Verbatim prefixes consist of `\\?\` immediately followed by the given
155 #[stable(feature = "rust1", since = "1.0.0")]
156 Verbatim(#[stable(feature = "rust1", since = "1.0.0")] &'a OsStr),
158 /// Verbatim prefix using Windows' _**U**niform **N**aming **C**onvention_,
159 /// e.g. `\\?\UNC\server\share`.
161 /// Verbatim UNC prefixes consist of `\\?\UNC\` immediately followed by the
162 /// server's hostname and a share name.
163 #[stable(feature = "rust1", since = "1.0.0")]
165 #[stable(feature = "rust1", since = "1.0.0")] &'a OsStr,
166 #[stable(feature = "rust1", since = "1.0.0")] &'a OsStr,
169 /// Verbatim disk prefix, e.g. `\\?\C:\`.
171 /// Verbatim disk prefixes consist of `\\?\` immediately followed by the
172 /// drive letter and `:\`.
173 #[stable(feature = "rust1", since = "1.0.0")]
174 VerbatimDisk(#[stable(feature = "rust1", since = "1.0.0")] u8),
176 /// Device namespace prefix, e.g. `\\.\COM42`.
178 /// Device namespace prefixes consist of `\\.\` immediately followed by the
180 #[stable(feature = "rust1", since = "1.0.0")]
181 DeviceNS(#[stable(feature = "rust1", since = "1.0.0")] &'a OsStr),
183 /// Prefix using Windows' _**U**niform **N**aming **C**onvention_, e.g.
184 /// `\\server\share`.
186 /// UNC prefixes consist of the server's hostname and a share name.
187 #[stable(feature = "rust1", since = "1.0.0")]
189 #[stable(feature = "rust1", since = "1.0.0")] &'a OsStr,
190 #[stable(feature = "rust1", since = "1.0.0")] &'a OsStr,
193 /// Prefix `C:` for the given disk drive.
194 #[stable(feature = "rust1", since = "1.0.0")]
195 Disk(#[stable(feature = "rust1", since = "1.0.0")] u8),
198 impl<'a> Prefix<'a> {
200 fn len(&self) -> usize {
202 fn os_str_len(s: &OsStr) -> usize {
203 os_str_as_u8_slice(s).len()
206 Verbatim(x) => 4 + os_str_len(x),
207 VerbatimUNC(x, y) => {
209 if os_str_len(y) > 0 {
215 VerbatimDisk(_) => 6,
218 if os_str_len(y) > 0 {
224 DeviceNS(x) => 4 + os_str_len(x),
230 /// Determines if the prefix is verbatim, i.e. begins with `\\?\`.
235 /// use std::path::Prefix::*;
236 /// use std::ffi::OsStr;
238 /// assert!(Verbatim(OsStr::new("pictures")).is_verbatim());
239 /// assert!(VerbatimUNC(OsStr::new("server"), OsStr::new("share")).is_verbatim());
240 /// assert!(VerbatimDisk(b'C').is_verbatim());
241 /// assert!(!DeviceNS(OsStr::new("BrainInterface")).is_verbatim());
242 /// assert!(!UNC(OsStr::new("server"), OsStr::new("share")).is_verbatim());
243 /// assert!(!Disk(b'C').is_verbatim());
246 #[stable(feature = "rust1", since = "1.0.0")]
247 pub fn is_verbatim(&self) -> bool {
250 Verbatim(_) | VerbatimDisk(_) | VerbatimUNC(..) => true,
256 fn is_drive(&self) -> bool {
258 Prefix::Disk(_) => true,
264 fn has_implicit_root(&self) -> bool {
269 ////////////////////////////////////////////////////////////////////////////////
270 // Exposed parsing helpers
271 ////////////////////////////////////////////////////////////////////////////////
273 /// Determines whether the character is one of the permitted path
274 /// separators for the current platform.
281 /// assert!(path::is_separator('/')); // '/' works for both Unix and Windows
282 /// assert!(!path::is_separator('❤'));
284 #[stable(feature = "rust1", since = "1.0.0")]
285 pub fn is_separator(c: char) -> bool {
286 c.is_ascii() && is_sep_byte(c as u8)
289 /// The primary separator of path components for the current platform.
291 /// For example, `/` on Unix and `\` on Windows.
292 #[stable(feature = "rust1", since = "1.0.0")]
293 pub const MAIN_SEPARATOR: char = ::sys::path::MAIN_SEP;
295 ////////////////////////////////////////////////////////////////////////////////
297 ////////////////////////////////////////////////////////////////////////////////
299 // Iterate through `iter` while it matches `prefix`; return `None` if `prefix`
300 // is not a prefix of `iter`, otherwise return `Some(iter_after_prefix)` giving
301 // `iter` after having exhausted `prefix`.
302 fn iter_after<'a, 'b, I, J>(mut iter: I, mut prefix: J) -> Option<I>
303 where I: Iterator<Item = Component<'a>> + Clone,
304 J: Iterator<Item = Component<'b>>,
307 let mut iter_next = iter.clone();
308 match (iter_next.next(), prefix.next()) {
309 (Some(ref x), Some(ref y)) if x == y => (),
310 (Some(_), Some(_)) => return None,
311 (Some(_), None) => return Some(iter),
312 (None, None) => return Some(iter),
313 (None, Some(_)) => return None,
319 // See note at the top of this module to understand why these are used:
320 fn os_str_as_u8_slice(s: &OsStr) -> &[u8] {
321 unsafe { &*(s as *const OsStr as *const [u8]) }
323 unsafe fn u8_slice_as_os_str(s: &[u8]) -> &OsStr {
324 &*(s as *const [u8] as *const OsStr)
327 // Detect scheme on Redox
328 fn has_redox_scheme(s: &[u8]) -> bool {
329 cfg!(target_os = "redox") && s.split(|b| *b == b'/').next().unwrap_or(b"").contains(&b':')
332 ////////////////////////////////////////////////////////////////////////////////
333 // Cross-platform, iterator-independent parsing
334 ////////////////////////////////////////////////////////////////////////////////
336 /// Says whether the first byte after the prefix is a separator.
337 fn has_physical_root(s: &[u8], prefix: Option<Prefix>) -> bool {
338 let path = if let Some(p) = prefix {
343 !path.is_empty() && is_sep_byte(path[0])
346 // basic workhorse for splitting stem and extension
347 fn split_file_at_dot(file: &OsStr) -> (Option<&OsStr>, Option<&OsStr>) {
349 if os_str_as_u8_slice(file) == b".." {
350 return (Some(file), None);
353 // The unsafety here stems from converting between &OsStr and &[u8]
354 // and back. This is safe to do because (1) we only look at ASCII
355 // contents of the encoding and (2) new &OsStr values are produced
356 // only from ASCII-bounded slices of existing &OsStr values.
358 let mut iter = os_str_as_u8_slice(file).rsplitn(2, |b| *b == b'.');
359 let after = iter.next();
360 let before = iter.next();
361 if before == Some(b"") {
364 (before.map(|s| u8_slice_as_os_str(s)),
365 after.map(|s| u8_slice_as_os_str(s)))
370 ////////////////////////////////////////////////////////////////////////////////
371 // The core iterators
372 ////////////////////////////////////////////////////////////////////////////////
374 /// Component parsing works by a double-ended state machine; the cursors at the
375 /// front and back of the path each keep track of what parts of the path have
376 /// been consumed so far.
378 /// Going front to back, a path is made up of a prefix, a starting
379 /// directory component, and a body (of normal components)
380 #[derive(Copy, Clone, PartialEq, PartialOrd, Debug)]
383 StartDir = 1, // / or . or nothing
384 Body = 2, // foo/bar/baz
388 /// A structure wrapping a Windows path prefix as well as its unparsed string
391 /// In addition to the parsed [`Prefix`] information returned by [`kind`],
392 /// `PrefixComponent` also holds the raw and unparsed [`OsStr`] slice,
393 /// returned by [`as_os_str`].
395 /// Instances of this `struct` can be obtained by matching against the
396 /// [`Prefix` variant] on [`Component`].
398 /// Does not occur on Unix.
403 /// # if cfg!(windows) {
404 /// use std::path::{Component, Path, Prefix};
405 /// use std::ffi::OsStr;
407 /// let path = Path::new(r"c:\you\later\");
408 /// match path.components().next().unwrap() {
409 /// Component::Prefix(prefix_component) => {
410 /// assert_eq!(Prefix::Disk(b'C'), prefix_component.kind());
411 /// assert_eq!(OsStr::new("c:"), prefix_component.as_os_str());
413 /// _ => unreachable!(),
418 /// [`as_os_str`]: #method.as_os_str
419 /// [`Component`]: enum.Component.html
420 /// [`kind`]: #method.kind
421 /// [`OsStr`]: ../../std/ffi/struct.OsStr.html
422 /// [`Prefix` variant]: enum.Component.html#variant.Prefix
423 /// [`Prefix`]: enum.Prefix.html
424 #[stable(feature = "rust1", since = "1.0.0")]
425 #[derive(Copy, Clone, Eq, Debug)]
426 pub struct PrefixComponent<'a> {
427 /// The prefix as an unparsed `OsStr` slice.
430 /// The parsed prefix data.
434 impl<'a> PrefixComponent<'a> {
435 /// Returns the parsed prefix data.
437 /// See [`Prefix`]'s documentation for more information on the different
438 /// kinds of prefixes.
440 /// [`Prefix`]: enum.Prefix.html
441 #[stable(feature = "rust1", since = "1.0.0")]
442 pub fn kind(&self) -> Prefix<'a> {
446 /// Returns the raw [`OsStr`] slice for this prefix.
448 /// [`OsStr`]: ../../std/ffi/struct.OsStr.html
449 #[stable(feature = "rust1", since = "1.0.0")]
450 pub fn as_os_str(&self) -> &'a OsStr {
455 #[stable(feature = "rust1", since = "1.0.0")]
456 impl<'a> cmp::PartialEq for PrefixComponent<'a> {
457 fn eq(&self, other: &PrefixComponent<'a>) -> bool {
458 cmp::PartialEq::eq(&self.parsed, &other.parsed)
462 #[stable(feature = "rust1", since = "1.0.0")]
463 impl<'a> cmp::PartialOrd for PrefixComponent<'a> {
464 fn partial_cmp(&self, other: &PrefixComponent<'a>) -> Option<cmp::Ordering> {
465 cmp::PartialOrd::partial_cmp(&self.parsed, &other.parsed)
469 #[stable(feature = "rust1", since = "1.0.0")]
470 impl<'a> cmp::Ord for PrefixComponent<'a> {
471 fn cmp(&self, other: &PrefixComponent<'a>) -> cmp::Ordering {
472 cmp::Ord::cmp(&self.parsed, &other.parsed)
476 #[stable(feature = "rust1", since = "1.0.0")]
477 impl<'a> Hash for PrefixComponent<'a> {
478 fn hash<H: Hasher>(&self, h: &mut H) {
483 /// A single component of a path.
485 /// A `Component` roughly corresponds to a substring between path separators
488 /// This `enum` is created by iterating over [`Components`], which in turn is
489 /// created by the [`components`][`Path::components`] method on [`Path`].
494 /// use std::path::{Component, Path};
496 /// let path = Path::new("/tmp/foo/bar.txt");
497 /// let components = path.components().collect::<Vec<_>>();
498 /// assert_eq!(&components, &[
499 /// Component::RootDir,
500 /// Component::Normal("tmp".as_ref()),
501 /// Component::Normal("foo".as_ref()),
502 /// Component::Normal("bar.txt".as_ref()),
506 /// [`Components`]: struct.Components.html
507 /// [`Path`]: struct.Path.html
508 /// [`Path::components`]: struct.Path.html#method.components
509 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
510 #[stable(feature = "rust1", since = "1.0.0")]
511 pub enum Component<'a> {
512 /// A Windows path prefix, e.g. `C:` or `\\server\share`.
514 /// There is a large variety of prefix types, see [`Prefix`]'s documentation
517 /// Does not occur on Unix.
519 /// [`Prefix`]: enum.Prefix.html
520 #[stable(feature = "rust1", since = "1.0.0")]
522 #[stable(feature = "rust1", since = "1.0.0")] PrefixComponent<'a>
525 /// The root directory component, appears after any prefix and before anything else.
527 /// It represents a separator that designates that a path starts from root.
528 #[stable(feature = "rust1", since = "1.0.0")]
531 /// A reference to the current directory, i.e. `.`.
532 #[stable(feature = "rust1", since = "1.0.0")]
535 /// A reference to the parent directory, i.e. `..`.
536 #[stable(feature = "rust1", since = "1.0.0")]
539 /// A normal component, e.g. `a` and `b` in `a/b`.
541 /// This variant is the most common one, it represents references to files
543 #[stable(feature = "rust1", since = "1.0.0")]
544 Normal(#[stable(feature = "rust1", since = "1.0.0")] &'a OsStr),
547 impl<'a> Component<'a> {
548 /// Extracts the underlying [`OsStr`] slice.
553 /// use std::path::Path;
555 /// let path = Path::new("./tmp/foo/bar.txt");
556 /// let components: Vec<_> = path.components().map(|comp| comp.as_os_str()).collect();
557 /// assert_eq!(&components, &[".", "tmp", "foo", "bar.txt"]);
560 /// [`OsStr`]: ../../std/ffi/struct.OsStr.html
561 #[stable(feature = "rust1", since = "1.0.0")]
562 pub fn as_os_str(self) -> &'a OsStr {
564 Component::Prefix(p) => p.as_os_str(),
565 Component::RootDir => OsStr::new(MAIN_SEP_STR),
566 Component::CurDir => OsStr::new("."),
567 Component::ParentDir => OsStr::new(".."),
568 Component::Normal(path) => path,
573 #[stable(feature = "rust1", since = "1.0.0")]
574 impl<'a> AsRef<OsStr> for Component<'a> {
575 fn as_ref(&self) -> &OsStr {
580 #[stable(feature = "path_component_asref", since = "1.25.0")]
581 impl<'a> AsRef<Path> for Component<'a> {
582 fn as_ref(&self) -> &Path {
583 self.as_os_str().as_ref()
587 /// An iterator over the [`Component`]s of a [`Path`].
589 /// This `struct` is created by the [`components`] method on [`Path`].
590 /// See its documentation for more.
595 /// use std::path::Path;
597 /// let path = Path::new("/tmp/foo/bar.txt");
599 /// for component in path.components() {
600 /// println!("{:?}", component);
604 /// [`Component`]: enum.Component.html
605 /// [`components`]: struct.Path.html#method.components
606 /// [`Path`]: struct.Path.html
608 #[stable(feature = "rust1", since = "1.0.0")]
609 pub struct Components<'a> {
610 // The path left to parse components from
613 // The prefix as it was originally parsed, if any
614 prefix: Option<Prefix<'a>>,
616 // true if path *physically* has a root separator; for most Windows
617 // prefixes, it may have a "logical" rootseparator for the purposes of
618 // normalization, e.g. \\server\share == \\server\share\.
619 has_physical_root: bool,
621 // The iterator is double-ended, and these two states keep track of what has
622 // been produced from either end
627 /// An iterator over the [`Component`]s of a [`Path`], as [`OsStr`] slices.
629 /// This `struct` is created by the [`iter`] method on [`Path`].
630 /// See its documentation for more.
632 /// [`Component`]: enum.Component.html
633 /// [`iter`]: struct.Path.html#method.iter
634 /// [`OsStr`]: ../../std/ffi/struct.OsStr.html
635 /// [`Path`]: struct.Path.html
637 #[stable(feature = "rust1", since = "1.0.0")]
638 pub struct Iter<'a> {
639 inner: Components<'a>,
642 #[stable(feature = "path_components_debug", since = "1.13.0")]
643 impl<'a> fmt::Debug for Components<'a> {
644 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
645 struct DebugHelper<'a>(&'a Path);
647 impl<'a> fmt::Debug for DebugHelper<'a> {
648 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
650 .entries(self.0.components())
655 f.debug_tuple("Components")
656 .field(&DebugHelper(self.as_path()))
661 impl<'a> Components<'a> {
662 // how long is the prefix, if any?
664 fn prefix_len(&self) -> usize {
665 self.prefix.as_ref().map(Prefix::len).unwrap_or(0)
669 fn prefix_verbatim(&self) -> bool {
670 self.prefix.as_ref().map(Prefix::is_verbatim).unwrap_or(false)
673 /// how much of the prefix is left from the point of view of iteration?
675 fn prefix_remaining(&self) -> usize {
676 if self.front == State::Prefix {
683 // Given the iteration so far, how much of the pre-State::Body path is left?
685 fn len_before_body(&self) -> usize {
686 let root = if self.front <= State::StartDir && self.has_physical_root {
691 let cur_dir = if self.front <= State::StartDir && self.include_cur_dir() {
696 self.prefix_remaining() + root + cur_dir
699 // is the iteration complete?
701 fn finished(&self) -> bool {
702 self.front == State::Done || self.back == State::Done || self.front > self.back
706 fn is_sep_byte(&self, b: u8) -> bool {
707 if self.prefix_verbatim() {
714 /// Extracts a slice corresponding to the portion of the path remaining for iteration.
719 /// use std::path::Path;
721 /// let mut components = Path::new("/tmp/foo/bar.txt").components();
722 /// components.next();
723 /// components.next();
725 /// assert_eq!(Path::new("foo/bar.txt"), components.as_path());
727 #[stable(feature = "rust1", since = "1.0.0")]
728 pub fn as_path(&self) -> &'a Path {
729 let mut comps = self.clone();
730 if comps.front == State::Body {
733 if comps.back == State::Body {
736 unsafe { Path::from_u8_slice(comps.path) }
739 /// Is the *original* path rooted?
740 fn has_root(&self) -> bool {
741 if self.has_physical_root {
744 if let Some(p) = self.prefix {
745 if p.has_implicit_root() {
752 /// Should the normalized path include a leading . ?
753 fn include_cur_dir(&self) -> bool {
757 let mut iter = self.path[self.prefix_len()..].iter();
758 match (iter.next(), iter.next()) {
759 (Some(&b'.'), None) => true,
760 (Some(&b'.'), Some(&b)) => self.is_sep_byte(b),
765 // parse a given byte sequence into the corresponding path component
766 fn parse_single_component<'b>(&self, comp: &'b [u8]) -> Option<Component<'b>> {
768 b"." if self.prefix_verbatim() => Some(Component::CurDir),
769 b"." => None, // . components are normalized away, except at
770 // the beginning of a path, which is treated
771 // separately via `include_cur_dir`
772 b".." => Some(Component::ParentDir),
774 _ => Some(Component::Normal(unsafe { u8_slice_as_os_str(comp) })),
778 // parse a component from the left, saying how many bytes to consume to
779 // remove the component
780 fn parse_next_component(&self) -> (usize, Option<Component<'a>>) {
781 debug_assert!(self.front == State::Body);
782 let (extra, comp) = match self.path.iter().position(|b| self.is_sep_byte(*b)) {
783 None => (0, self.path),
784 Some(i) => (1, &self.path[..i]),
786 (comp.len() + extra, self.parse_single_component(comp))
789 // parse a component from the right, saying how many bytes to consume to
790 // remove the component
791 fn parse_next_component_back(&self) -> (usize, Option<Component<'a>>) {
792 debug_assert!(self.back == State::Body);
793 let start = self.len_before_body();
794 let (extra, comp) = match self.path[start..].iter().rposition(|b| self.is_sep_byte(*b)) {
795 None => (0, &self.path[start..]),
796 Some(i) => (1, &self.path[start + i + 1..]),
798 (comp.len() + extra, self.parse_single_component(comp))
801 // trim away repeated separators (i.e. empty components) on the left
802 fn trim_left(&mut self) {
803 while !self.path.is_empty() {
804 let (size, comp) = self.parse_next_component();
808 self.path = &self.path[size..];
813 // trim away repeated separators (i.e. empty components) on the right
814 fn trim_right(&mut self) {
815 while self.path.len() > self.len_before_body() {
816 let (size, comp) = self.parse_next_component_back();
820 self.path = &self.path[..self.path.len() - size];
826 #[stable(feature = "rust1", since = "1.0.0")]
827 impl<'a> AsRef<Path> for Components<'a> {
828 fn as_ref(&self) -> &Path {
833 #[stable(feature = "rust1", since = "1.0.0")]
834 impl<'a> AsRef<OsStr> for Components<'a> {
835 fn as_ref(&self) -> &OsStr {
836 self.as_path().as_os_str()
840 #[stable(feature = "path_iter_debug", since = "1.13.0")]
841 impl<'a> fmt::Debug for Iter<'a> {
842 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
843 struct DebugHelper<'a>(&'a Path);
845 impl<'a> fmt::Debug for DebugHelper<'a> {
846 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
848 .entries(self.0.iter())
853 f.debug_tuple("Iter")
854 .field(&DebugHelper(self.as_path()))
860 /// Extracts a slice corresponding to the portion of the path remaining for iteration.
865 /// use std::path::Path;
867 /// let mut iter = Path::new("/tmp/foo/bar.txt").iter();
871 /// assert_eq!(Path::new("foo/bar.txt"), iter.as_path());
873 #[stable(feature = "rust1", since = "1.0.0")]
874 pub fn as_path(&self) -> &'a Path {
879 #[stable(feature = "rust1", since = "1.0.0")]
880 impl<'a> AsRef<Path> for Iter<'a> {
881 fn as_ref(&self) -> &Path {
886 #[stable(feature = "rust1", since = "1.0.0")]
887 impl<'a> AsRef<OsStr> for Iter<'a> {
888 fn as_ref(&self) -> &OsStr {
889 self.as_path().as_os_str()
893 #[stable(feature = "rust1", since = "1.0.0")]
894 impl<'a> Iterator for Iter<'a> {
895 type Item = &'a OsStr;
897 fn next(&mut self) -> Option<&'a OsStr> {
898 self.inner.next().map(Component::as_os_str)
902 #[stable(feature = "rust1", since = "1.0.0")]
903 impl<'a> DoubleEndedIterator for Iter<'a> {
904 fn next_back(&mut self) -> Option<&'a OsStr> {
905 self.inner.next_back().map(Component::as_os_str)
909 #[stable(feature = "fused", since = "1.26.0")]
910 impl<'a> FusedIterator for Iter<'a> {}
912 #[stable(feature = "rust1", since = "1.0.0")]
913 impl<'a> Iterator for Components<'a> {
914 type Item = Component<'a>;
916 fn next(&mut self) -> Option<Component<'a>> {
917 while !self.finished() {
919 State::Prefix if self.prefix_len() > 0 => {
920 self.front = State::StartDir;
921 debug_assert!(self.prefix_len() <= self.path.len());
922 let raw = &self.path[..self.prefix_len()];
923 self.path = &self.path[self.prefix_len()..];
924 return Some(Component::Prefix(PrefixComponent {
925 raw: unsafe { u8_slice_as_os_str(raw) },
926 parsed: self.prefix.unwrap(),
930 self.front = State::StartDir;
933 self.front = State::Body;
934 if self.has_physical_root {
935 debug_assert!(!self.path.is_empty());
936 self.path = &self.path[1..];
937 return Some(Component::RootDir);
938 } else if let Some(p) = self.prefix {
939 if p.has_implicit_root() && !p.is_verbatim() {
940 return Some(Component::RootDir);
942 } else if self.include_cur_dir() {
943 debug_assert!(!self.path.is_empty());
944 self.path = &self.path[1..];
945 return Some(Component::CurDir);
948 State::Body if !self.path.is_empty() => {
949 let (size, comp) = self.parse_next_component();
950 self.path = &self.path[size..];
956 self.front = State::Done;
958 State::Done => unreachable!(),
965 #[stable(feature = "rust1", since = "1.0.0")]
966 impl<'a> DoubleEndedIterator for Components<'a> {
967 fn next_back(&mut self) -> Option<Component<'a>> {
968 while !self.finished() {
970 State::Body if self.path.len() > self.len_before_body() => {
971 let (size, comp) = self.parse_next_component_back();
972 self.path = &self.path[..self.path.len() - size];
978 self.back = State::StartDir;
981 self.back = State::Prefix;
982 if self.has_physical_root {
983 self.path = &self.path[..self.path.len() - 1];
984 return Some(Component::RootDir);
985 } else if let Some(p) = self.prefix {
986 if p.has_implicit_root() && !p.is_verbatim() {
987 return Some(Component::RootDir);
989 } else if self.include_cur_dir() {
990 self.path = &self.path[..self.path.len() - 1];
991 return Some(Component::CurDir);
994 State::Prefix if self.prefix_len() > 0 => {
995 self.back = State::Done;
996 return Some(Component::Prefix(PrefixComponent {
997 raw: unsafe { u8_slice_as_os_str(self.path) },
998 parsed: self.prefix.unwrap(),
1002 self.back = State::Done;
1005 State::Done => unreachable!(),
1012 #[stable(feature = "fused", since = "1.26.0")]
1013 impl<'a> FusedIterator for Components<'a> {}
1015 #[stable(feature = "rust1", since = "1.0.0")]
1016 impl<'a> cmp::PartialEq for Components<'a> {
1017 fn eq(&self, other: &Components<'a>) -> bool {
1018 Iterator::eq(self.clone(), other.clone())
1022 #[stable(feature = "rust1", since = "1.0.0")]
1023 impl<'a> cmp::Eq for Components<'a> {}
1025 #[stable(feature = "rust1", since = "1.0.0")]
1026 impl<'a> cmp::PartialOrd for Components<'a> {
1027 fn partial_cmp(&self, other: &Components<'a>) -> Option<cmp::Ordering> {
1028 Iterator::partial_cmp(self.clone(), other.clone())
1032 #[stable(feature = "rust1", since = "1.0.0")]
1033 impl<'a> cmp::Ord for Components<'a> {
1034 fn cmp(&self, other: &Components<'a>) -> cmp::Ordering {
1035 Iterator::cmp(self.clone(), other.clone())
1039 /// An iterator over [`Path`] and its ancestors.
1041 /// This `struct` is created by the [`ancestors`] method on [`Path`].
1042 /// See its documentation for more.
1047 /// use std::path::Path;
1049 /// let path = Path::new("/foo/bar");
1051 /// for ancestor in path.ancestors() {
1052 /// println!("{}", ancestor.display());
1056 /// [`ancestors`]: struct.Path.html#method.ancestors
1057 /// [`Path`]: struct.Path.html
1058 #[derive(Copy, Clone, Debug)]
1059 #[stable(feature = "path_ancestors", since = "1.28.0")]
1060 pub struct Ancestors<'a> {
1061 next: Option<&'a Path>,
1064 #[stable(feature = "path_ancestors", since = "1.28.0")]
1065 impl<'a> Iterator for Ancestors<'a> {
1066 type Item = &'a Path;
1068 fn next(&mut self) -> Option<Self::Item> {
1069 let next = self.next;
1070 self.next = next.and_then(Path::parent);
1075 #[stable(feature = "path_ancestors", since = "1.28.0")]
1076 impl<'a> FusedIterator for Ancestors<'a> {}
1078 ////////////////////////////////////////////////////////////////////////////////
1079 // Basic types and traits
1080 ////////////////////////////////////////////////////////////////////////////////
1082 /// An owned, mutable path (akin to [`String`]).
1084 /// This type provides methods like [`push`] and [`set_extension`] that mutate
1085 /// the path in place. It also implements [`Deref`] to [`Path`], meaning that
1086 /// all methods on [`Path`] slices are available on `PathBuf` values as well.
1088 /// [`String`]: ../string/struct.String.html
1089 /// [`Path`]: struct.Path.html
1090 /// [`push`]: struct.PathBuf.html#method.push
1091 /// [`set_extension`]: struct.PathBuf.html#method.set_extension
1092 /// [`Deref`]: ../ops/trait.Deref.html
1094 /// More details about the overall approach can be found in
1095 /// the [module documentation](index.html).
1099 /// You can use [`push`] to build up a `PathBuf` from
1103 /// use std::path::PathBuf;
1105 /// let mut path = PathBuf::new();
1107 /// path.push(r"C:\");
1108 /// path.push("windows");
1109 /// path.push("system32");
1111 /// path.set_extension("dll");
1114 /// However, [`push`] is best used for dynamic situations. This is a better way
1115 /// to do this when you know all of the components ahead of time:
1118 /// use std::path::PathBuf;
1120 /// let path: PathBuf = [r"C:\", "windows", "system32.dll"].iter().collect();
1123 /// We can still do better than this! Since these are all strings, we can use
1127 /// use std::path::PathBuf;
1129 /// let path = PathBuf::from(r"C:\windows\system32.dll");
1132 /// Which method works best depends on what kind of situation you're in.
1134 #[stable(feature = "rust1", since = "1.0.0")]
1135 pub struct PathBuf {
1140 fn as_mut_vec(&mut self) -> &mut Vec<u8> {
1141 unsafe { &mut *(self as *mut PathBuf as *mut Vec<u8>) }
1144 /// Allocates an empty `PathBuf`.
1149 /// use std::path::PathBuf;
1151 /// let path = PathBuf::new();
1153 #[stable(feature = "rust1", since = "1.0.0")]
1154 pub fn new() -> PathBuf {
1155 PathBuf { inner: OsString::new() }
1158 /// Coerces to a [`Path`] slice.
1160 /// [`Path`]: struct.Path.html
1165 /// use std::path::{Path, PathBuf};
1167 /// let p = PathBuf::from("/test");
1168 /// assert_eq!(Path::new("/test"), p.as_path());
1170 #[stable(feature = "rust1", since = "1.0.0")]
1171 pub fn as_path(&self) -> &Path {
1175 /// Extends `self` with `path`.
1177 /// If `path` is absolute, it replaces the current path.
1181 /// * if `path` has a root but no prefix (e.g. `\windows`), it
1182 /// replaces everything except for the prefix (if any) of `self`.
1183 /// * if `path` has a prefix but no root, it replaces `self`.
1187 /// Pushing a relative path extends the existing path:
1190 /// use std::path::PathBuf;
1192 /// let mut path = PathBuf::from("/tmp");
1193 /// path.push("file.bk");
1194 /// assert_eq!(path, PathBuf::from("/tmp/file.bk"));
1197 /// Pushing an absolute path replaces the existing path:
1200 /// use std::path::PathBuf;
1202 /// let mut path = PathBuf::from("/tmp");
1203 /// path.push("/etc");
1204 /// assert_eq!(path, PathBuf::from("/etc"));
1206 #[stable(feature = "rust1", since = "1.0.0")]
1207 pub fn push<P: AsRef<Path>>(&mut self, path: P) {
1208 self._push(path.as_ref())
1211 fn _push(&mut self, path: &Path) {
1212 // in general, a separator is needed if the rightmost byte is not a separator
1213 let mut need_sep = self.as_mut_vec().last().map(|c| !is_sep_byte(*c)).unwrap_or(false);
1215 // in the special case of `C:` on Windows, do *not* add a separator
1217 let comps = self.components();
1218 if comps.prefix_len() > 0 && comps.prefix_len() == comps.path.len() &&
1219 comps.prefix.unwrap().is_drive() {
1224 // absolute `path` replaces `self`
1225 if path.is_absolute() || path.prefix().is_some() {
1226 self.as_mut_vec().truncate(0);
1228 // `path` has a root but no prefix, e.g. `\windows` (Windows only)
1229 } else if path.has_root() {
1230 let prefix_len = self.components().prefix_remaining();
1231 self.as_mut_vec().truncate(prefix_len);
1233 // `path` is a pure relative path
1234 } else if need_sep {
1235 self.inner.push(MAIN_SEP_STR);
1238 self.inner.push(path);
1241 /// Truncates `self` to [`self.parent`].
1243 /// Returns `false` and does nothing if [`self.file_name`] is [`None`].
1244 /// Otherwise, returns `true`.
1246 /// [`None`]: ../../std/option/enum.Option.html#variant.None
1247 /// [`self.parent`]: struct.PathBuf.html#method.parent
1248 /// [`self.file_name`]: struct.PathBuf.html#method.file_name
1253 /// use std::path::{Path, PathBuf};
1255 /// let mut p = PathBuf::from("/test/test.rs");
1258 /// assert_eq!(Path::new("/test"), p);
1260 /// assert_eq!(Path::new("/"), p);
1262 #[stable(feature = "rust1", since = "1.0.0")]
1263 pub fn pop(&mut self) -> bool {
1264 match self.parent().map(|p| p.as_u8_slice().len()) {
1266 self.as_mut_vec().truncate(len);
1273 /// Updates [`self.file_name`] to `file_name`.
1275 /// If [`self.file_name`] was [`None`], this is equivalent to pushing
1278 /// Otherwise it is equivalent to calling [`pop`] and then pushing
1279 /// `file_name`. The new path will be a sibling of the original path.
1280 /// (That is, it will have the same parent.)
1282 /// [`self.file_name`]: struct.PathBuf.html#method.file_name
1283 /// [`None`]: ../../std/option/enum.Option.html#variant.None
1284 /// [`pop`]: struct.PathBuf.html#method.pop
1289 /// use std::path::PathBuf;
1291 /// let mut buf = PathBuf::from("/");
1292 /// assert!(buf.file_name() == None);
1293 /// buf.set_file_name("bar");
1294 /// assert!(buf == PathBuf::from("/bar"));
1295 /// assert!(buf.file_name().is_some());
1296 /// buf.set_file_name("baz.txt");
1297 /// assert!(buf == PathBuf::from("/baz.txt"));
1299 #[stable(feature = "rust1", since = "1.0.0")]
1300 pub fn set_file_name<S: AsRef<OsStr>>(&mut self, file_name: S) {
1301 self._set_file_name(file_name.as_ref())
1304 fn _set_file_name(&mut self, file_name: &OsStr) {
1305 if self.file_name().is_some() {
1306 let popped = self.pop();
1307 debug_assert!(popped);
1309 self.push(file_name);
1312 /// Updates [`self.extension`] to `extension`.
1314 /// Returns `false` and does nothing if [`self.file_name`] is [`None`],
1315 /// returns `true` and updates the extension otherwise.
1317 /// If [`self.extension`] is [`None`], the extension is added; otherwise
1320 /// [`self.file_name`]: struct.PathBuf.html#method.file_name
1321 /// [`self.extension`]: struct.PathBuf.html#method.extension
1322 /// [`None`]: ../../std/option/enum.Option.html#variant.None
1327 /// use std::path::{Path, PathBuf};
1329 /// let mut p = PathBuf::from("/feel/the");
1331 /// p.set_extension("force");
1332 /// assert_eq!(Path::new("/feel/the.force"), p.as_path());
1334 /// p.set_extension("dark_side");
1335 /// assert_eq!(Path::new("/feel/the.dark_side"), p.as_path());
1337 #[stable(feature = "rust1", since = "1.0.0")]
1338 pub fn set_extension<S: AsRef<OsStr>>(&mut self, extension: S) -> bool {
1339 self._set_extension(extension.as_ref())
1342 fn _set_extension(&mut self, extension: &OsStr) -> bool {
1343 if self.file_name().is_none() {
1347 let mut stem = match self.file_stem() {
1348 Some(stem) => stem.to_os_string(),
1349 None => OsString::new(),
1352 if !os_str_as_u8_slice(extension).is_empty() {
1354 stem.push(extension);
1356 self.set_file_name(&stem);
1361 /// Consumes the `PathBuf`, yielding its internal [`OsString`] storage.
1363 /// [`OsString`]: ../ffi/struct.OsString.html
1368 /// use std::path::PathBuf;
1370 /// let p = PathBuf::from("/the/head");
1371 /// let os_str = p.into_os_string();
1373 #[stable(feature = "rust1", since = "1.0.0")]
1374 pub fn into_os_string(self) -> OsString {
1378 /// Converts this `PathBuf` into a [boxed][`Box`] [`Path`].
1380 /// [`Box`]: ../../std/boxed/struct.Box.html
1381 /// [`Path`]: struct.Path.html
1382 #[stable(feature = "into_boxed_path", since = "1.20.0")]
1383 pub fn into_boxed_path(self) -> Box<Path> {
1384 let rw = Box::into_raw(self.inner.into_boxed_os_str()) as *mut Path;
1385 unsafe { Box::from_raw(rw) }
1389 #[stable(feature = "box_from_path", since = "1.17.0")]
1390 impl<'a> From<&'a Path> for Box<Path> {
1391 fn from(path: &'a Path) -> Box<Path> {
1392 let boxed: Box<OsStr> = path.inner.into();
1393 let rw = Box::into_raw(boxed) as *mut Path;
1394 unsafe { Box::from_raw(rw) }
1398 #[stable(feature = "path_buf_from_box", since = "1.18.0")]
1399 impl From<Box<Path>> for PathBuf {
1400 fn from(boxed: Box<Path>) -> PathBuf {
1401 boxed.into_path_buf()
1405 #[stable(feature = "box_from_path_buf", since = "1.20.0")]
1406 impl From<PathBuf> for Box<Path> {
1407 fn from(p: PathBuf) -> Box<Path> {
1412 #[stable(feature = "more_box_slice_clone", since = "1.29.0")]
1413 impl Clone for Box<Path> {
1415 fn clone(&self) -> Self {
1416 self.to_path_buf().into_boxed_path()
1420 #[stable(feature = "rust1", since = "1.0.0")]
1421 impl<'a, T: ?Sized + AsRef<OsStr>> From<&'a T> for PathBuf {
1422 fn from(s: &'a T) -> PathBuf {
1423 PathBuf::from(s.as_ref().to_os_string())
1427 #[stable(feature = "rust1", since = "1.0.0")]
1428 impl From<OsString> for PathBuf {
1429 fn from(s: OsString) -> PathBuf {
1430 PathBuf { inner: s }
1434 #[stable(feature = "from_path_buf_for_os_string", since = "1.14.0")]
1435 impl From<PathBuf> for OsString {
1436 fn from(path_buf : PathBuf) -> OsString {
1441 #[stable(feature = "rust1", since = "1.0.0")]
1442 impl From<String> for PathBuf {
1443 fn from(s: String) -> PathBuf {
1444 PathBuf::from(OsString::from(s))
1448 #[stable(feature = "path_from_str", since = "1.26.0")]
1449 impl FromStr for PathBuf {
1450 type Err = ParseError;
1452 fn from_str(s: &str) -> Result<Self, Self::Err> {
1453 Ok(PathBuf::from(s))
1457 #[stable(feature = "rust1", since = "1.0.0")]
1458 impl<P: AsRef<Path>> iter::FromIterator<P> for PathBuf {
1459 fn from_iter<I: IntoIterator<Item = P>>(iter: I) -> PathBuf {
1460 let mut buf = PathBuf::new();
1466 #[stable(feature = "rust1", since = "1.0.0")]
1467 impl<P: AsRef<Path>> iter::Extend<P> for PathBuf {
1468 fn extend<I: IntoIterator<Item = P>>(&mut self, iter: I) {
1470 self.push(p.as_ref())
1475 #[stable(feature = "rust1", since = "1.0.0")]
1476 impl fmt::Debug for PathBuf {
1477 fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
1478 fmt::Debug::fmt(&**self, formatter)
1482 #[stable(feature = "rust1", since = "1.0.0")]
1483 impl ops::Deref for PathBuf {
1486 fn deref(&self) -> &Path {
1487 Path::new(&self.inner)
1491 #[stable(feature = "rust1", since = "1.0.0")]
1492 impl Borrow<Path> for PathBuf {
1493 fn borrow(&self) -> &Path {
1498 #[stable(feature = "default_for_pathbuf", since = "1.17.0")]
1499 impl Default for PathBuf {
1500 fn default() -> Self {
1505 #[stable(feature = "cow_from_path", since = "1.6.0")]
1506 impl<'a> From<&'a Path> for Cow<'a, Path> {
1508 fn from(s: &'a Path) -> Cow<'a, Path> {
1513 #[stable(feature = "cow_from_path", since = "1.6.0")]
1514 impl<'a> From<PathBuf> for Cow<'a, Path> {
1516 fn from(s: PathBuf) -> Cow<'a, Path> {
1521 #[stable(feature = "cow_from_pathbuf_ref", since = "1.28.0")]
1522 impl<'a> From<&'a PathBuf> for Cow<'a, Path> {
1524 fn from(p: &'a PathBuf) -> Cow<'a, Path> {
1525 Cow::Borrowed(p.as_path())
1529 #[stable(feature = "pathbuf_from_cow_path", since = "1.28.0")]
1530 impl<'a> From<Cow<'a, Path>> for PathBuf {
1532 fn from(p: Cow<'a, Path>) -> Self {
1537 #[stable(feature = "shared_from_slice2", since = "1.24.0")]
1538 impl From<PathBuf> for Arc<Path> {
1540 fn from(s: PathBuf) -> Arc<Path> {
1541 let arc: Arc<OsStr> = Arc::from(s.into_os_string());
1542 unsafe { Arc::from_raw(Arc::into_raw(arc) as *const Path) }
1546 #[stable(feature = "shared_from_slice2", since = "1.24.0")]
1547 impl<'a> From<&'a Path> for Arc<Path> {
1549 fn from(s: &Path) -> Arc<Path> {
1550 let arc: Arc<OsStr> = Arc::from(s.as_os_str());
1551 unsafe { Arc::from_raw(Arc::into_raw(arc) as *const Path) }
1555 #[stable(feature = "shared_from_slice2", since = "1.24.0")]
1556 impl From<PathBuf> for Rc<Path> {
1558 fn from(s: PathBuf) -> Rc<Path> {
1559 let rc: Rc<OsStr> = Rc::from(s.into_os_string());
1560 unsafe { Rc::from_raw(Rc::into_raw(rc) as *const Path) }
1564 #[stable(feature = "shared_from_slice2", since = "1.24.0")]
1565 impl<'a> From<&'a Path> for Rc<Path> {
1567 fn from(s: &Path) -> Rc<Path> {
1568 let rc: Rc<OsStr> = Rc::from(s.as_os_str());
1569 unsafe { Rc::from_raw(Rc::into_raw(rc) as *const Path) }
1573 #[stable(feature = "rust1", since = "1.0.0")]
1574 impl ToOwned for Path {
1575 type Owned = PathBuf;
1576 fn to_owned(&self) -> PathBuf {
1579 fn clone_into(&self, target: &mut PathBuf) {
1580 self.inner.clone_into(&mut target.inner);
1584 #[stable(feature = "rust1", since = "1.0.0")]
1585 impl cmp::PartialEq for PathBuf {
1586 fn eq(&self, other: &PathBuf) -> bool {
1587 self.components() == other.components()
1591 #[stable(feature = "rust1", since = "1.0.0")]
1592 impl Hash for PathBuf {
1593 fn hash<H: Hasher>(&self, h: &mut H) {
1594 self.as_path().hash(h)
1598 #[stable(feature = "rust1", since = "1.0.0")]
1599 impl cmp::Eq for PathBuf {}
1601 #[stable(feature = "rust1", since = "1.0.0")]
1602 impl cmp::PartialOrd for PathBuf {
1603 fn partial_cmp(&self, other: &PathBuf) -> Option<cmp::Ordering> {
1604 self.components().partial_cmp(other.components())
1608 #[stable(feature = "rust1", since = "1.0.0")]
1609 impl cmp::Ord for PathBuf {
1610 fn cmp(&self, other: &PathBuf) -> cmp::Ordering {
1611 self.components().cmp(other.components())
1615 #[stable(feature = "rust1", since = "1.0.0")]
1616 impl AsRef<OsStr> for PathBuf {
1617 fn as_ref(&self) -> &OsStr {
1622 /// A slice of a path (akin to [`str`]).
1624 /// This type supports a number of operations for inspecting a path, including
1625 /// breaking the path into its components (separated by `/` on Unix and by either
1626 /// `/` or `\` on Windows), extracting the file name, determining whether the path
1627 /// is absolute, and so on.
1629 /// This is an *unsized* type, meaning that it must always be used behind a
1630 /// pointer like `&` or [`Box`]. For an owned version of this type,
1631 /// see [`PathBuf`].
1633 /// [`str`]: ../primitive.str.html
1634 /// [`Box`]: ../boxed/struct.Box.html
1635 /// [`PathBuf`]: struct.PathBuf.html
1637 /// More details about the overall approach can be found in
1638 /// the [module documentation](index.html).
1643 /// use std::path::Path;
1644 /// use std::ffi::OsStr;
1646 /// // Note: this example does work on Windows
1647 /// let path = Path::new("./foo/bar.txt");
1649 /// let parent = path.parent();
1650 /// assert_eq!(parent, Some(Path::new("./foo")));
1652 /// let file_stem = path.file_stem();
1653 /// assert_eq!(file_stem, Some(OsStr::new("bar")));
1655 /// let extension = path.extension();
1656 /// assert_eq!(extension, Some(OsStr::new("txt")));
1658 #[stable(feature = "rust1", since = "1.0.0")]
1663 /// An error returned from [`Path::strip_prefix`][`strip_prefix`] if the prefix
1666 /// This `struct` is created by the [`strip_prefix`] method on [`Path`].
1667 /// See its documentation for more.
1669 /// [`strip_prefix`]: struct.Path.html#method.strip_prefix
1670 /// [`Path`]: struct.Path.html
1671 #[derive(Debug, Clone, PartialEq, Eq)]
1672 #[stable(since = "1.7.0", feature = "strip_prefix")]
1673 pub struct StripPrefixError(());
1676 // The following (private!) function allows construction of a path from a u8
1677 // slice, which is only safe when it is known to follow the OsStr encoding.
1678 unsafe fn from_u8_slice(s: &[u8]) -> &Path {
1679 Path::new(u8_slice_as_os_str(s))
1681 // The following (private!) function reveals the byte encoding used for OsStr.
1682 fn as_u8_slice(&self) -> &[u8] {
1683 os_str_as_u8_slice(&self.inner)
1686 /// Directly wraps a string slice as a `Path` slice.
1688 /// This is a cost-free conversion.
1693 /// use std::path::Path;
1695 /// Path::new("foo.txt");
1698 /// You can create `Path`s from `String`s, or even other `Path`s:
1701 /// use std::path::Path;
1703 /// let string = String::from("foo.txt");
1704 /// let from_string = Path::new(&string);
1705 /// let from_path = Path::new(&from_string);
1706 /// assert_eq!(from_string, from_path);
1708 #[stable(feature = "rust1", since = "1.0.0")]
1709 pub fn new<S: AsRef<OsStr> + ?Sized>(s: &S) -> &Path {
1710 unsafe { &*(s.as_ref() as *const OsStr as *const Path) }
1713 /// Yields the underlying [`OsStr`] slice.
1715 /// [`OsStr`]: ../ffi/struct.OsStr.html
1720 /// use std::path::Path;
1722 /// let os_str = Path::new("foo.txt").as_os_str();
1723 /// assert_eq!(os_str, std::ffi::OsStr::new("foo.txt"));
1725 #[stable(feature = "rust1", since = "1.0.0")]
1726 pub fn as_os_str(&self) -> &OsStr {
1730 /// Yields a [`&str`] slice if the `Path` is valid unicode.
1732 /// This conversion may entail doing a check for UTF-8 validity.
1734 /// [`&str`]: ../primitive.str.html
1739 /// use std::path::Path;
1741 /// let path = Path::new("foo.txt");
1742 /// assert_eq!(path.to_str(), Some("foo.txt"));
1744 #[stable(feature = "rust1", since = "1.0.0")]
1745 pub fn to_str(&self) -> Option<&str> {
1749 /// Converts a `Path` to a [`Cow<str>`].
1751 /// Any non-Unicode sequences are replaced with
1752 /// [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD].
1754 /// [`Cow<str>`]: ../borrow/enum.Cow.html
1755 /// [U+FFFD]: ../char/constant.REPLACEMENT_CHARACTER.html
1759 /// Calling `to_string_lossy` on a `Path` with valid unicode:
1762 /// use std::path::Path;
1764 /// let path = Path::new("foo.txt");
1765 /// assert_eq!(path.to_string_lossy(), "foo.txt");
1768 /// Had `path` contained invalid unicode, the `to_string_lossy` call might
1769 /// have returned `"fo�.txt"`.
1770 #[stable(feature = "rust1", since = "1.0.0")]
1771 pub fn to_string_lossy(&self) -> Cow<str> {
1772 self.inner.to_string_lossy()
1775 /// Converts a `Path` to an owned [`PathBuf`].
1777 /// [`PathBuf`]: struct.PathBuf.html
1782 /// use std::path::Path;
1784 /// let path_buf = Path::new("foo.txt").to_path_buf();
1785 /// assert_eq!(path_buf, std::path::PathBuf::from("foo.txt"));
1787 #[rustc_conversion_suggestion]
1788 #[stable(feature = "rust1", since = "1.0.0")]
1789 pub fn to_path_buf(&self) -> PathBuf {
1790 PathBuf::from(self.inner.to_os_string())
1793 /// Returns `true` if the `Path` is absolute, i.e. if it is independent of
1794 /// the current directory.
1796 /// * On Unix, a path is absolute if it starts with the root, so
1797 /// `is_absolute` and [`has_root`] are equivalent.
1799 /// * On Windows, a path is absolute if it has a prefix and starts with the
1800 /// root: `c:\windows` is absolute, while `c:temp` and `\temp` are not.
1805 /// use std::path::Path;
1807 /// assert!(!Path::new("foo.txt").is_absolute());
1810 /// [`has_root`]: #method.has_root
1811 #[stable(feature = "rust1", since = "1.0.0")]
1812 #[allow(deprecated)]
1813 pub fn is_absolute(&self) -> bool {
1814 if cfg!(target_os = "redox") {
1815 // FIXME: Allow Redox prefixes
1816 self.has_root() || has_redox_scheme(self.as_u8_slice())
1818 self.has_root() && (cfg!(unix) || self.prefix().is_some())
1822 /// Returns `true` if the `Path` is relative, i.e. not absolute.
1824 /// See [`is_absolute`]'s documentation for more details.
1829 /// use std::path::Path;
1831 /// assert!(Path::new("foo.txt").is_relative());
1834 /// [`is_absolute`]: #method.is_absolute
1835 #[stable(feature = "rust1", since = "1.0.0")]
1836 pub fn is_relative(&self) -> bool {
1840 fn prefix(&self) -> Option<Prefix> {
1841 self.components().prefix
1844 /// Returns `true` if the `Path` has a root.
1846 /// * On Unix, a path has a root if it begins with `/`.
1848 /// * On Windows, a path has a root if it:
1849 /// * has no prefix and begins with a separator, e.g. `\windows`
1850 /// * has a prefix followed by a separator, e.g. `c:\windows` but not `c:windows`
1851 /// * has any non-disk prefix, e.g. `\\server\share`
1856 /// use std::path::Path;
1858 /// assert!(Path::new("/etc/passwd").has_root());
1860 #[stable(feature = "rust1", since = "1.0.0")]
1861 pub fn has_root(&self) -> bool {
1862 self.components().has_root()
1865 /// Returns the `Path` without its final component, if there is one.
1867 /// Returns [`None`] if the path terminates in a root or prefix.
1869 /// [`None`]: ../../std/option/enum.Option.html#variant.None
1874 /// use std::path::Path;
1876 /// let path = Path::new("/foo/bar");
1877 /// let parent = path.parent().unwrap();
1878 /// assert_eq!(parent, Path::new("/foo"));
1880 /// let grand_parent = parent.parent().unwrap();
1881 /// assert_eq!(grand_parent, Path::new("/"));
1882 /// assert_eq!(grand_parent.parent(), None);
1884 #[stable(feature = "rust1", since = "1.0.0")]
1885 pub fn parent(&self) -> Option<&Path> {
1886 let mut comps = self.components();
1887 let comp = comps.next_back();
1890 Component::Normal(_) |
1892 Component::ParentDir => Some(comps.as_path()),
1898 /// Produces an iterator over `Path` and its ancestors.
1900 /// The iterator will yield the `Path` that is returned if the [`parent`] method is used zero
1901 /// or more times. That means, the iterator will yield `&self`, `&self.parent().unwrap()`,
1902 /// `&self.parent().unwrap().parent().unwrap()` and so on. If the [`parent`] method returns
1903 /// [`None`], the iterator will do likewise. The iterator will always yield at least one value,
1909 /// use std::path::Path;
1911 /// let mut ancestors = Path::new("/foo/bar").ancestors();
1912 /// assert_eq!(ancestors.next(), Some(Path::new("/foo/bar")));
1913 /// assert_eq!(ancestors.next(), Some(Path::new("/foo")));
1914 /// assert_eq!(ancestors.next(), Some(Path::new("/")));
1915 /// assert_eq!(ancestors.next(), None);
1918 /// [`None`]: ../../std/option/enum.Option.html#variant.None
1919 /// [`parent`]: struct.Path.html#method.parent
1920 #[stable(feature = "path_ancestors", since = "1.28.0")]
1921 pub fn ancestors(&self) -> Ancestors {
1927 /// Returns the final component of the `Path`, if there is one.
1929 /// If the path is a normal file, this is the file name. If it's the path of a directory, this
1930 /// is the directory name.
1932 /// Returns [`None`] if the path terminates in `..`.
1934 /// [`None`]: ../../std/option/enum.Option.html#variant.None
1939 /// use std::path::Path;
1940 /// use std::ffi::OsStr;
1942 /// assert_eq!(Some(OsStr::new("bin")), Path::new("/usr/bin/").file_name());
1943 /// assert_eq!(Some(OsStr::new("foo.txt")), Path::new("tmp/foo.txt").file_name());
1944 /// assert_eq!(Some(OsStr::new("foo.txt")), Path::new("foo.txt/.").file_name());
1945 /// assert_eq!(Some(OsStr::new("foo.txt")), Path::new("foo.txt/.//").file_name());
1946 /// assert_eq!(None, Path::new("foo.txt/..").file_name());
1947 /// assert_eq!(None, Path::new("/").file_name());
1949 #[stable(feature = "rust1", since = "1.0.0")]
1950 pub fn file_name(&self) -> Option<&OsStr> {
1951 self.components().next_back().and_then(|p| {
1953 Component::Normal(p) => Some(p.as_ref()),
1959 /// Returns a path that, when joined onto `base`, yields `self`.
1963 /// If `base` is not a prefix of `self` (i.e. [`starts_with`]
1964 /// returns `false`), returns [`Err`].
1966 /// [`starts_with`]: #method.starts_with
1967 /// [`Err`]: ../../std/result/enum.Result.html#variant.Err
1972 /// use std::path::{Path, PathBuf};
1974 /// let path = Path::new("/test/haha/foo.txt");
1976 /// assert_eq!(path.strip_prefix("/"), Ok(Path::new("test/haha/foo.txt")));
1977 /// assert_eq!(path.strip_prefix("/test"), Ok(Path::new("haha/foo.txt")));
1978 /// assert_eq!(path.strip_prefix("/test/"), Ok(Path::new("haha/foo.txt")));
1979 /// assert_eq!(path.strip_prefix("/test/haha/foo.txt"), Ok(Path::new("")));
1980 /// assert_eq!(path.strip_prefix("/test/haha/foo.txt/"), Ok(Path::new("")));
1981 /// assert_eq!(path.strip_prefix("test").is_ok(), false);
1982 /// assert_eq!(path.strip_prefix("/haha").is_ok(), false);
1984 /// let prefix = PathBuf::from("/test/");
1985 /// assert_eq!(path.strip_prefix(prefix), Ok(Path::new("haha/foo.txt")));
1987 #[stable(since = "1.7.0", feature = "path_strip_prefix")]
1988 pub fn strip_prefix<P>(&self, base: P)
1989 -> Result<&Path, StripPrefixError>
1990 where P: AsRef<Path>
1992 self._strip_prefix(base.as_ref())
1995 fn _strip_prefix(&self, base: &Path)
1996 -> Result<&Path, StripPrefixError> {
1997 iter_after(self.components(), base.components())
1998 .map(|c| c.as_path())
1999 .ok_or(StripPrefixError(()))
2002 /// Determines whether `base` is a prefix of `self`.
2004 /// Only considers whole path components to match.
2009 /// use std::path::Path;
2011 /// let path = Path::new("/etc/passwd");
2013 /// assert!(path.starts_with("/etc"));
2014 /// assert!(path.starts_with("/etc/"));
2015 /// assert!(path.starts_with("/etc/passwd"));
2016 /// assert!(path.starts_with("/etc/passwd/"));
2018 /// assert!(!path.starts_with("/e"));
2020 #[stable(feature = "rust1", since = "1.0.0")]
2021 pub fn starts_with<P: AsRef<Path>>(&self, base: P) -> bool {
2022 self._starts_with(base.as_ref())
2025 fn _starts_with(&self, base: &Path) -> bool {
2026 iter_after(self.components(), base.components()).is_some()
2029 /// Determines whether `child` is a suffix of `self`.
2031 /// Only considers whole path components to match.
2036 /// use std::path::Path;
2038 /// let path = Path::new("/etc/passwd");
2040 /// assert!(path.ends_with("passwd"));
2042 #[stable(feature = "rust1", since = "1.0.0")]
2043 pub fn ends_with<P: AsRef<Path>>(&self, child: P) -> bool {
2044 self._ends_with(child.as_ref())
2047 fn _ends_with(&self, child: &Path) -> bool {
2048 iter_after(self.components().rev(), child.components().rev()).is_some()
2051 /// Extracts the stem (non-extension) portion of [`self.file_name`].
2053 /// [`self.file_name`]: struct.Path.html#method.file_name
2057 /// * [`None`], if there is no file name;
2058 /// * The entire file name if there is no embedded `.`;
2059 /// * The entire file name if the file name begins with `.` and has no other `.`s within;
2060 /// * Otherwise, the portion of the file name before the final `.`
2062 /// [`None`]: ../../std/option/enum.Option.html#variant.None
2067 /// use std::path::Path;
2069 /// let path = Path::new("foo.rs");
2071 /// assert_eq!("foo", path.file_stem().unwrap());
2073 #[stable(feature = "rust1", since = "1.0.0")]
2074 pub fn file_stem(&self) -> Option<&OsStr> {
2075 self.file_name().map(split_file_at_dot).and_then(|(before, after)| before.or(after))
2078 /// Extracts the extension of [`self.file_name`], if possible.
2080 /// The extension is:
2082 /// * [`None`], if there is no file name;
2083 /// * [`None`], if there is no embedded `.`;
2084 /// * [`None`], if the file name begins with `.` and has no other `.`s within;
2085 /// * Otherwise, the portion of the file name after the final `.`
2087 /// [`self.file_name`]: struct.Path.html#method.file_name
2088 /// [`None`]: ../../std/option/enum.Option.html#variant.None
2093 /// use std::path::Path;
2095 /// let path = Path::new("foo.rs");
2097 /// assert_eq!("rs", path.extension().unwrap());
2099 #[stable(feature = "rust1", since = "1.0.0")]
2100 pub fn extension(&self) -> Option<&OsStr> {
2101 self.file_name().map(split_file_at_dot).and_then(|(before, after)| before.and(after))
2104 /// Creates an owned [`PathBuf`] with `path` adjoined to `self`.
2106 /// See [`PathBuf::push`] for more details on what it means to adjoin a path.
2108 /// [`PathBuf`]: struct.PathBuf.html
2109 /// [`PathBuf::push`]: struct.PathBuf.html#method.push
2114 /// use std::path::{Path, PathBuf};
2116 /// assert_eq!(Path::new("/etc").join("passwd"), PathBuf::from("/etc/passwd"));
2118 #[stable(feature = "rust1", since = "1.0.0")]
2119 pub fn join<P: AsRef<Path>>(&self, path: P) -> PathBuf {
2120 self._join(path.as_ref())
2123 fn _join(&self, path: &Path) -> PathBuf {
2124 let mut buf = self.to_path_buf();
2129 /// Creates an owned [`PathBuf`] like `self` but with the given file name.
2131 /// See [`PathBuf::set_file_name`] for more details.
2133 /// [`PathBuf`]: struct.PathBuf.html
2134 /// [`PathBuf::set_file_name`]: struct.PathBuf.html#method.set_file_name
2139 /// use std::path::{Path, PathBuf};
2141 /// let path = Path::new("/tmp/foo.txt");
2142 /// assert_eq!(path.with_file_name("bar.txt"), PathBuf::from("/tmp/bar.txt"));
2144 /// let path = Path::new("/tmp");
2145 /// assert_eq!(path.with_file_name("var"), PathBuf::from("/var"));
2147 #[stable(feature = "rust1", since = "1.0.0")]
2148 pub fn with_file_name<S: AsRef<OsStr>>(&self, file_name: S) -> PathBuf {
2149 self._with_file_name(file_name.as_ref())
2152 fn _with_file_name(&self, file_name: &OsStr) -> PathBuf {
2153 let mut buf = self.to_path_buf();
2154 buf.set_file_name(file_name);
2158 /// Creates an owned [`PathBuf`] like `self` but with the given extension.
2160 /// See [`PathBuf::set_extension`] for more details.
2162 /// [`PathBuf`]: struct.PathBuf.html
2163 /// [`PathBuf::set_extension`]: struct.PathBuf.html#method.set_extension
2168 /// use std::path::{Path, PathBuf};
2170 /// let path = Path::new("foo.rs");
2171 /// assert_eq!(path.with_extension("txt"), PathBuf::from("foo.txt"));
2173 #[stable(feature = "rust1", since = "1.0.0")]
2174 pub fn with_extension<S: AsRef<OsStr>>(&self, extension: S) -> PathBuf {
2175 self._with_extension(extension.as_ref())
2178 fn _with_extension(&self, extension: &OsStr) -> PathBuf {
2179 let mut buf = self.to_path_buf();
2180 buf.set_extension(extension);
2184 /// Produces an iterator over the [`Component`]s of the path.
2186 /// When parsing the path, there is a small amount of normalization:
2188 /// * Repeated separators are ignored, so `a/b` and `a//b` both have
2189 /// `a` and `b` as components.
2191 /// * Occurrences of `.` are normalized away, except if they are at the
2192 /// beginning of the path. For example, `a/./b`, `a/b/`, `a/b/.` and
2193 /// `a/b` all have `a` and `b` as components, but `./a/b` starts with
2194 /// an additional [`CurDir`] component.
2196 /// Note that no other normalization takes place; in particular, `a/c`
2197 /// and `a/b/../c` are distinct, to account for the possibility that `b`
2198 /// is a symbolic link (so its parent isn't `a`).
2203 /// use std::path::{Path, Component};
2204 /// use std::ffi::OsStr;
2206 /// let mut components = Path::new("/tmp/foo.txt").components();
2208 /// assert_eq!(components.next(), Some(Component::RootDir));
2209 /// assert_eq!(components.next(), Some(Component::Normal(OsStr::new("tmp"))));
2210 /// assert_eq!(components.next(), Some(Component::Normal(OsStr::new("foo.txt"))));
2211 /// assert_eq!(components.next(), None)
2214 /// [`Component`]: enum.Component.html
2215 /// [`CurDir`]: enum.Component.html#variant.CurDir
2216 #[stable(feature = "rust1", since = "1.0.0")]
2217 pub fn components(&self) -> Components {
2218 let prefix = parse_prefix(self.as_os_str());
2220 path: self.as_u8_slice(),
2222 has_physical_root: has_physical_root(self.as_u8_slice(), prefix) ||
2223 has_redox_scheme(self.as_u8_slice()),
2224 front: State::Prefix,
2229 /// Produces an iterator over the path's components viewed as [`OsStr`]
2232 /// For more information about the particulars of how the path is separated
2233 /// into components, see [`components`].
2235 /// [`components`]: #method.components
2236 /// [`OsStr`]: ../ffi/struct.OsStr.html
2241 /// use std::path::{self, Path};
2242 /// use std::ffi::OsStr;
2244 /// let mut it = Path::new("/tmp/foo.txt").iter();
2245 /// assert_eq!(it.next(), Some(OsStr::new(&path::MAIN_SEPARATOR.to_string())));
2246 /// assert_eq!(it.next(), Some(OsStr::new("tmp")));
2247 /// assert_eq!(it.next(), Some(OsStr::new("foo.txt")));
2248 /// assert_eq!(it.next(), None)
2250 #[stable(feature = "rust1", since = "1.0.0")]
2251 pub fn iter(&self) -> Iter {
2252 Iter { inner: self.components() }
2255 /// Returns an object that implements [`Display`] for safely printing paths
2256 /// that may contain non-Unicode data.
2258 /// [`Display`]: ../fmt/trait.Display.html
2263 /// use std::path::Path;
2265 /// let path = Path::new("/tmp/foo.rs");
2267 /// println!("{}", path.display());
2269 #[stable(feature = "rust1", since = "1.0.0")]
2270 pub fn display(&self) -> Display {
2271 Display { path: self }
2274 /// Queries the file system to get information about a file, directory, etc.
2276 /// This function will traverse symbolic links to query information about the
2277 /// destination file.
2279 /// This is an alias to [`fs::metadata`].
2281 /// [`fs::metadata`]: ../fs/fn.metadata.html
2286 /// use std::path::Path;
2288 /// let path = Path::new("/Minas/tirith");
2289 /// let metadata = path.metadata().expect("metadata call failed");
2290 /// println!("{:?}", metadata.file_type());
2292 #[stable(feature = "path_ext", since = "1.5.0")]
2293 pub fn metadata(&self) -> io::Result<fs::Metadata> {
2297 /// Queries the metadata about a file without following symlinks.
2299 /// This is an alias to [`fs::symlink_metadata`].
2301 /// [`fs::symlink_metadata`]: ../fs/fn.symlink_metadata.html
2306 /// use std::path::Path;
2308 /// let path = Path::new("/Minas/tirith");
2309 /// let metadata = path.symlink_metadata().expect("symlink_metadata call failed");
2310 /// println!("{:?}", metadata.file_type());
2312 #[stable(feature = "path_ext", since = "1.5.0")]
2313 pub fn symlink_metadata(&self) -> io::Result<fs::Metadata> {
2314 fs::symlink_metadata(self)
2317 /// Returns the canonical, absolute form of the path with all intermediate
2318 /// components normalized and symbolic links resolved.
2320 /// This is an alias to [`fs::canonicalize`].
2322 /// [`fs::canonicalize`]: ../fs/fn.canonicalize.html
2327 /// use std::path::{Path, PathBuf};
2329 /// let path = Path::new("/foo/test/../test/bar.rs");
2330 /// assert_eq!(path.canonicalize().unwrap(), PathBuf::from("/foo/test/bar.rs"));
2332 #[stable(feature = "path_ext", since = "1.5.0")]
2333 pub fn canonicalize(&self) -> io::Result<PathBuf> {
2334 fs::canonicalize(self)
2337 /// Reads a symbolic link, returning the file that the link points to.
2339 /// This is an alias to [`fs::read_link`].
2341 /// [`fs::read_link`]: ../fs/fn.read_link.html
2346 /// use std::path::Path;
2348 /// let path = Path::new("/laputa/sky_castle.rs");
2349 /// let path_link = path.read_link().expect("read_link call failed");
2351 #[stable(feature = "path_ext", since = "1.5.0")]
2352 pub fn read_link(&self) -> io::Result<PathBuf> {
2356 /// Returns an iterator over the entries within a directory.
2358 /// The iterator will yield instances of [`io::Result`]`<`[`DirEntry`]`>`. New
2359 /// errors may be encountered after an iterator is initially constructed.
2361 /// This is an alias to [`fs::read_dir`].
2363 /// [`io::Result`]: ../io/type.Result.html
2364 /// [`DirEntry`]: ../fs/struct.DirEntry.html
2365 /// [`fs::read_dir`]: ../fs/fn.read_dir.html
2370 /// use std::path::Path;
2372 /// let path = Path::new("/laputa");
2373 /// for entry in path.read_dir().expect("read_dir call failed") {
2374 /// if let Ok(entry) = entry {
2375 /// println!("{:?}", entry.path());
2379 #[stable(feature = "path_ext", since = "1.5.0")]
2380 pub fn read_dir(&self) -> io::Result<fs::ReadDir> {
2384 /// Returns whether the path points at an existing entity.
2386 /// This function will traverse symbolic links to query information about the
2387 /// destination file. In case of broken symbolic links this will return `false`.
2389 /// If you cannot access the directory containing the file, e.g. because of a
2390 /// permission error, this will return `false`.
2395 /// use std::path::Path;
2396 /// assert_eq!(Path::new("does_not_exist.txt").exists(), false);
2401 /// This is a convenience function that coerces errors to false. If you want to
2402 /// check errors, call [fs::metadata].
2404 /// [fs::metadata]: ../../std/fs/fn.metadata.html
2405 #[stable(feature = "path_ext", since = "1.5.0")]
2406 pub fn exists(&self) -> bool {
2407 fs::metadata(self).is_ok()
2410 /// Returns whether the path exists on disk and is pointing at a regular file.
2412 /// This function will traverse symbolic links to query information about the
2413 /// destination file. In case of broken symbolic links this will return `false`.
2415 /// If you cannot access the directory containing the file, e.g. because of a
2416 /// permission error, this will return `false`.
2421 /// use std::path::Path;
2422 /// assert_eq!(Path::new("./is_a_directory/").is_file(), false);
2423 /// assert_eq!(Path::new("a_file.txt").is_file(), true);
2428 /// This is a convenience function that coerces errors to false. If you want to
2429 /// check errors, call [fs::metadata] and handle its Result. Then call
2430 /// [fs::Metadata::is_file] if it was Ok.
2432 /// [fs::metadata]: ../../std/fs/fn.metadata.html
2433 /// [fs::Metadata::is_file]: ../../std/fs/struct.Metadata.html#method.is_file
2434 #[stable(feature = "path_ext", since = "1.5.0")]
2435 pub fn is_file(&self) -> bool {
2436 fs::metadata(self).map(|m| m.is_file()).unwrap_or(false)
2439 /// Returns whether the path exists on disk and is pointing at a directory.
2441 /// This function will traverse symbolic links to query information about the
2442 /// destination file. In case of broken symbolic links this will return `false`.
2444 /// If you cannot access the directory containing the file, e.g. because of a
2445 /// permission error, this will return `false`.
2450 /// use std::path::Path;
2451 /// assert_eq!(Path::new("./is_a_directory/").is_dir(), true);
2452 /// assert_eq!(Path::new("a_file.txt").is_dir(), false);
2457 /// This is a convenience function that coerces errors to false. If you want to
2458 /// check errors, call [fs::metadata] and handle its Result. Then call
2459 /// [fs::Metadata::is_dir] if it was Ok.
2461 /// [fs::metadata]: ../../std/fs/fn.metadata.html
2462 /// [fs::Metadata::is_dir]: ../../std/fs/struct.Metadata.html#method.is_dir
2463 #[stable(feature = "path_ext", since = "1.5.0")]
2464 pub fn is_dir(&self) -> bool {
2465 fs::metadata(self).map(|m| m.is_dir()).unwrap_or(false)
2468 /// Converts a [`Box<Path>`][`Box`] into a [`PathBuf`] without copying or
2471 /// [`Box`]: ../../std/boxed/struct.Box.html
2472 /// [`PathBuf`]: struct.PathBuf.html
2473 #[stable(feature = "into_boxed_path", since = "1.20.0")]
2474 pub fn into_path_buf(self: Box<Path>) -> PathBuf {
2475 let rw = Box::into_raw(self) as *mut OsStr;
2476 let inner = unsafe { Box::from_raw(rw) };
2477 PathBuf { inner: OsString::from(inner) }
2481 #[stable(feature = "rust1", since = "1.0.0")]
2482 impl AsRef<OsStr> for Path {
2483 fn as_ref(&self) -> &OsStr {
2488 #[stable(feature = "rust1", since = "1.0.0")]
2489 impl fmt::Debug for Path {
2490 fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
2491 fmt::Debug::fmt(&self.inner, formatter)
2495 /// Helper struct for safely printing paths with [`format!`] and `{}`.
2497 /// A [`Path`] might contain non-Unicode data. This `struct` implements the
2498 /// [`Display`] trait in a way that mitigates that. It is created by the
2499 /// [`display`][`Path::display`] method on [`Path`].
2504 /// use std::path::Path;
2506 /// let path = Path::new("/tmp/foo.rs");
2508 /// println!("{}", path.display());
2511 /// [`Display`]: ../../std/fmt/trait.Display.html
2512 /// [`format!`]: ../../std/macro.format.html
2513 /// [`Path`]: struct.Path.html
2514 /// [`Path::display`]: struct.Path.html#method.display
2515 #[stable(feature = "rust1", since = "1.0.0")]
2516 pub struct Display<'a> {
2520 #[stable(feature = "rust1", since = "1.0.0")]
2521 impl<'a> fmt::Debug for Display<'a> {
2522 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
2523 fmt::Debug::fmt(&self.path, f)
2527 #[stable(feature = "rust1", since = "1.0.0")]
2528 impl<'a> fmt::Display for Display<'a> {
2529 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
2530 self.path.inner.display(f)
2534 #[stable(feature = "rust1", since = "1.0.0")]
2535 impl cmp::PartialEq for Path {
2536 fn eq(&self, other: &Path) -> bool {
2537 self.components().eq(other.components())
2541 #[stable(feature = "rust1", since = "1.0.0")]
2542 impl Hash for Path {
2543 fn hash<H: Hasher>(&self, h: &mut H) {
2544 for component in self.components() {
2550 #[stable(feature = "rust1", since = "1.0.0")]
2551 impl cmp::Eq for Path {}
2553 #[stable(feature = "rust1", since = "1.0.0")]
2554 impl cmp::PartialOrd for Path {
2555 fn partial_cmp(&self, other: &Path) -> Option<cmp::Ordering> {
2556 self.components().partial_cmp(other.components())
2560 #[stable(feature = "rust1", since = "1.0.0")]
2561 impl cmp::Ord for Path {
2562 fn cmp(&self, other: &Path) -> cmp::Ordering {
2563 self.components().cmp(other.components())
2567 #[stable(feature = "rust1", since = "1.0.0")]
2568 impl AsRef<Path> for Path {
2569 fn as_ref(&self) -> &Path {
2574 #[stable(feature = "rust1", since = "1.0.0")]
2575 impl AsRef<Path> for OsStr {
2576 fn as_ref(&self) -> &Path {
2581 #[stable(feature = "cow_os_str_as_ref_path", since = "1.8.0")]
2582 impl<'a> AsRef<Path> for Cow<'a, OsStr> {
2583 fn as_ref(&self) -> &Path {
2588 #[stable(feature = "rust1", since = "1.0.0")]
2589 impl AsRef<Path> for OsString {
2590 fn as_ref(&self) -> &Path {
2595 #[stable(feature = "rust1", since = "1.0.0")]
2596 impl AsRef<Path> for str {
2597 fn as_ref(&self) -> &Path {
2602 #[stable(feature = "rust1", since = "1.0.0")]
2603 impl AsRef<Path> for String {
2604 fn as_ref(&self) -> &Path {
2609 #[stable(feature = "rust1", since = "1.0.0")]
2610 impl AsRef<Path> for PathBuf {
2611 fn as_ref(&self) -> &Path {
2616 #[stable(feature = "path_into_iter", since = "1.6.0")]
2617 impl<'a> IntoIterator for &'a PathBuf {
2618 type Item = &'a OsStr;
2619 type IntoIter = Iter<'a>;
2620 fn into_iter(self) -> Iter<'a> { self.iter() }
2623 #[stable(feature = "path_into_iter", since = "1.6.0")]
2624 impl<'a> IntoIterator for &'a Path {
2625 type Item = &'a OsStr;
2626 type IntoIter = Iter<'a>;
2627 fn into_iter(self) -> Iter<'a> { self.iter() }
2630 macro_rules! impl_cmp {
2631 ($lhs:ty, $rhs: ty) => {
2632 #[stable(feature = "partialeq_path", since = "1.6.0")]
2633 impl<'a, 'b> PartialEq<$rhs> for $lhs {
2635 fn eq(&self, other: &$rhs) -> bool { <Path as PartialEq>::eq(self, other) }
2638 #[stable(feature = "partialeq_path", since = "1.6.0")]
2639 impl<'a, 'b> PartialEq<$lhs> for $rhs {
2641 fn eq(&self, other: &$lhs) -> bool { <Path as PartialEq>::eq(self, other) }
2644 #[stable(feature = "cmp_path", since = "1.8.0")]
2645 impl<'a, 'b> PartialOrd<$rhs> for $lhs {
2647 fn partial_cmp(&self, other: &$rhs) -> Option<cmp::Ordering> {
2648 <Path as PartialOrd>::partial_cmp(self, other)
2652 #[stable(feature = "cmp_path", since = "1.8.0")]
2653 impl<'a, 'b> PartialOrd<$lhs> for $rhs {
2655 fn partial_cmp(&self, other: &$lhs) -> Option<cmp::Ordering> {
2656 <Path as PartialOrd>::partial_cmp(self, other)
2662 impl_cmp!(PathBuf, Path);
2663 impl_cmp!(PathBuf, &'a Path);
2664 impl_cmp!(Cow<'a, Path>, Path);
2665 impl_cmp!(Cow<'a, Path>, &'b Path);
2666 impl_cmp!(Cow<'a, Path>, PathBuf);
2668 macro_rules! impl_cmp_os_str {
2669 ($lhs:ty, $rhs: ty) => {
2670 #[stable(feature = "cmp_path", since = "1.8.0")]
2671 impl<'a, 'b> PartialEq<$rhs> for $lhs {
2673 fn eq(&self, other: &$rhs) -> bool { <Path as PartialEq>::eq(self, other.as_ref()) }
2676 #[stable(feature = "cmp_path", since = "1.8.0")]
2677 impl<'a, 'b> PartialEq<$lhs> for $rhs {
2679 fn eq(&self, other: &$lhs) -> bool { <Path as PartialEq>::eq(self.as_ref(), other) }
2682 #[stable(feature = "cmp_path", since = "1.8.0")]
2683 impl<'a, 'b> PartialOrd<$rhs> for $lhs {
2685 fn partial_cmp(&self, other: &$rhs) -> Option<cmp::Ordering> {
2686 <Path as PartialOrd>::partial_cmp(self, other.as_ref())
2690 #[stable(feature = "cmp_path", since = "1.8.0")]
2691 impl<'a, 'b> PartialOrd<$lhs> for $rhs {
2693 fn partial_cmp(&self, other: &$lhs) -> Option<cmp::Ordering> {
2694 <Path as PartialOrd>::partial_cmp(self.as_ref(), other)
2700 impl_cmp_os_str!(PathBuf, OsStr);
2701 impl_cmp_os_str!(PathBuf, &'a OsStr);
2702 impl_cmp_os_str!(PathBuf, Cow<'a, OsStr>);
2703 impl_cmp_os_str!(PathBuf, OsString);
2704 impl_cmp_os_str!(Path, OsStr);
2705 impl_cmp_os_str!(Path, &'a OsStr);
2706 impl_cmp_os_str!(Path, Cow<'a, OsStr>);
2707 impl_cmp_os_str!(Path, OsString);
2708 impl_cmp_os_str!(&'a Path, OsStr);
2709 impl_cmp_os_str!(&'a Path, Cow<'b, OsStr>);
2710 impl_cmp_os_str!(&'a Path, OsString);
2711 impl_cmp_os_str!(Cow<'a, Path>, OsStr);
2712 impl_cmp_os_str!(Cow<'a, Path>, &'b OsStr);
2713 impl_cmp_os_str!(Cow<'a, Path>, OsString);
2715 #[stable(since = "1.7.0", feature = "strip_prefix")]
2716 impl fmt::Display for StripPrefixError {
2717 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
2718 self.description().fmt(f)
2722 #[stable(since = "1.7.0", feature = "strip_prefix")]
2723 impl Error for StripPrefixError {
2724 fn description(&self) -> &str { "prefix not found" }
2735 ($path:expr, iter: $iter:expr) => (
2737 let path = Path::new($path);
2739 // Forward iteration
2740 let comps = path.iter()
2741 .map(|p| p.to_string_lossy().into_owned())
2742 .collect::<Vec<String>>();
2743 let exp: &[&str] = &$iter;
2744 let exps = exp.iter().map(|s| s.to_string()).collect::<Vec<String>>();
2745 assert!(comps == exps, "iter: Expected {:?}, found {:?}",
2748 // Reverse iteration
2749 let comps = Path::new($path).iter().rev()
2750 .map(|p| p.to_string_lossy().into_owned())
2751 .collect::<Vec<String>>();
2752 let exps = exps.into_iter().rev().collect::<Vec<String>>();
2753 assert!(comps == exps, "iter().rev(): Expected {:?}, found {:?}",
2758 ($path:expr, has_root: $has_root:expr, is_absolute: $is_absolute:expr) => (
2760 let path = Path::new($path);
2762 let act_root = path.has_root();
2763 assert!(act_root == $has_root, "has_root: Expected {:?}, found {:?}",
2764 $has_root, act_root);
2766 let act_abs = path.is_absolute();
2767 assert!(act_abs == $is_absolute, "is_absolute: Expected {:?}, found {:?}",
2768 $is_absolute, act_abs);
2772 ($path:expr, parent: $parent:expr, file_name: $file:expr) => (
2774 let path = Path::new($path);
2776 let parent = path.parent().map(|p| p.to_str().unwrap());
2777 let exp_parent: Option<&str> = $parent;
2778 assert!(parent == exp_parent, "parent: Expected {:?}, found {:?}",
2779 exp_parent, parent);
2781 let file = path.file_name().map(|p| p.to_str().unwrap());
2782 let exp_file: Option<&str> = $file;
2783 assert!(file == exp_file, "file_name: Expected {:?}, found {:?}",
2788 ($path:expr, file_stem: $file_stem:expr, extension: $extension:expr) => (
2790 let path = Path::new($path);
2792 let stem = path.file_stem().map(|p| p.to_str().unwrap());
2793 let exp_stem: Option<&str> = $file_stem;
2794 assert!(stem == exp_stem, "file_stem: Expected {:?}, found {:?}",
2797 let ext = path.extension().map(|p| p.to_str().unwrap());
2798 let exp_ext: Option<&str> = $extension;
2799 assert!(ext == exp_ext, "extension: Expected {:?}, found {:?}",
2804 ($path:expr, iter: $iter:expr,
2805 has_root: $has_root:expr, is_absolute: $is_absolute:expr,
2806 parent: $parent:expr, file_name: $file:expr,
2807 file_stem: $file_stem:expr, extension: $extension:expr) => (
2809 t!($path, iter: $iter);
2810 t!($path, has_root: $has_root, is_absolute: $is_absolute);
2811 t!($path, parent: $parent, file_name: $file);
2812 t!($path, file_stem: $file_stem, extension: $extension);
2821 let static_path = Path::new("/home/foo");
2822 let static_cow_path: Cow<'static, Path> = static_path.into();
2823 let pathbuf = PathBuf::from("/home/foo");
2826 let path: &Path = &pathbuf;
2827 let borrowed_cow_path: Cow<Path> = path.into();
2829 assert_eq!(static_cow_path, borrowed_cow_path);
2832 let owned_cow_path: Cow<'static, Path> = pathbuf.into();
2834 assert_eq!(static_cow_path, owned_cow_path);
2839 pub fn test_decompositions_unix() {
2855 file_name: Some("foo"),
2856 file_stem: Some("foo"),
2875 file_name: Some("foo"),
2876 file_stem: Some("foo"),
2885 file_name: Some("foo"),
2886 file_stem: Some("foo"),
2895 file_name: Some("foo"),
2896 file_stem: Some("foo"),
2901 iter: ["foo", "bar"],
2904 parent: Some("foo"),
2905 file_name: Some("bar"),
2906 file_stem: Some("bar"),
2911 iter: ["/", "foo", "bar"],
2914 parent: Some("/foo"),
2915 file_name: Some("bar"),
2916 file_stem: Some("bar"),
2925 file_name: Some("foo"),
2926 file_stem: Some("foo"),
2931 iter: ["/", "foo", "bar"],
2934 parent: Some("///foo"),
2935 file_name: Some("bar"),
2936 file_stem: Some("bar"),
2975 file_name: Some("foo"),
2976 file_stem: Some("foo"),
2981 iter: ["foo", ".."],
2984 parent: Some("foo"),
2995 file_name: Some("foo"),
2996 file_stem: Some("foo"),
3001 iter: ["foo", "bar"],
3004 parent: Some("foo"),
3005 file_name: Some("bar"),
3006 file_stem: Some("bar"),
3011 iter: ["foo", ".."],
3014 parent: Some("foo"),
3021 iter: ["foo", "..", "bar"],
3024 parent: Some("foo/.."),
3025 file_name: Some("bar"),
3026 file_stem: Some("bar"),
3035 file_name: Some("a"),
3036 file_stem: Some("a"),
3065 file_name: Some("b"),
3066 file_stem: Some("b"),
3075 file_name: Some("b"),
3076 file_stem: Some("b"),
3085 file_name: Some("b"),
3086 file_stem: Some("b"),
3091 iter: ["a", "b", "c"],
3094 parent: Some("a/b"),
3095 file_name: Some("c"),
3096 file_stem: Some("c"),
3105 file_name: Some(".foo"),
3106 file_stem: Some(".foo"),
3113 pub fn test_decompositions_windows() {
3129 file_name: Some("foo"),
3130 file_stem: Some("foo"),
3185 iter: ["\\", "foo"],
3189 file_name: Some("foo"),
3190 file_stem: Some("foo"),
3199 file_name: Some("foo"),
3200 file_stem: Some("foo"),
3205 iter: ["\\", "foo"],
3209 file_name: Some("foo"),
3210 file_stem: Some("foo"),
3215 iter: ["foo", "bar"],
3218 parent: Some("foo"),
3219 file_name: Some("bar"),
3220 file_stem: Some("bar"),
3225 iter: ["\\", "foo", "bar"],
3228 parent: Some("/foo"),
3229 file_name: Some("bar"),
3230 file_stem: Some("bar"),
3235 iter: ["\\", "foo"],
3239 file_name: Some("foo"),
3240 file_stem: Some("foo"),
3245 iter: ["\\", "foo", "bar"],
3248 parent: Some("///foo"),
3249 file_name: Some("bar"),
3250 file_stem: Some("bar"),
3289 file_name: Some("foo"),
3290 file_stem: Some("foo"),
3295 iter: ["foo", ".."],
3298 parent: Some("foo"),
3309 file_name: Some("foo"),
3310 file_stem: Some("foo"),
3315 iter: ["foo", "bar"],
3318 parent: Some("foo"),
3319 file_name: Some("bar"),
3320 file_stem: Some("bar"),
3325 iter: ["foo", ".."],
3328 parent: Some("foo"),
3335 iter: ["foo", "..", "bar"],
3338 parent: Some("foo/.."),
3339 file_name: Some("bar"),
3340 file_stem: Some("bar"),
3349 file_name: Some("a"),
3350 file_stem: Some("a"),
3379 file_name: Some("b"),
3380 file_stem: Some("b"),
3389 file_name: Some("b"),
3390 file_stem: Some("b"),
3399 file_name: Some("b"),
3400 file_stem: Some("b"),
3405 iter: ["a", "b", "c"],
3408 parent: Some("a/b"),
3409 file_name: Some("c"),
3410 file_stem: Some("c"),
3414 iter: ["a", "b", "c"],
3417 parent: Some("a\\b"),
3418 file_name: Some("c"),
3419 file_stem: Some("c"),
3428 file_name: Some("a"),
3429 file_stem: Some("a"),
3434 iter: ["c:", "\\", "foo.txt"],
3437 parent: Some("c:\\"),
3438 file_name: Some("foo.txt"),
3439 file_stem: Some("foo"),
3440 extension: Some("txt")
3443 t!("\\\\server\\share\\foo.txt",
3444 iter: ["\\\\server\\share", "\\", "foo.txt"],
3447 parent: Some("\\\\server\\share\\"),
3448 file_name: Some("foo.txt"),
3449 file_stem: Some("foo"),
3450 extension: Some("txt")
3453 t!("\\\\server\\share",
3454 iter: ["\\\\server\\share", "\\"],
3464 iter: ["\\", "server"],
3468 file_name: Some("server"),
3469 file_stem: Some("server"),
3473 t!("\\\\?\\bar\\foo.txt",
3474 iter: ["\\\\?\\bar", "\\", "foo.txt"],
3477 parent: Some("\\\\?\\bar\\"),
3478 file_name: Some("foo.txt"),
3479 file_stem: Some("foo"),
3480 extension: Some("txt")
3484 iter: ["\\\\?\\bar"],
3503 t!("\\\\?\\UNC\\server\\share\\foo.txt",
3504 iter: ["\\\\?\\UNC\\server\\share", "\\", "foo.txt"],
3507 parent: Some("\\\\?\\UNC\\server\\share\\"),
3508 file_name: Some("foo.txt"),
3509 file_stem: Some("foo"),
3510 extension: Some("txt")
3513 t!("\\\\?\\UNC\\server",
3514 iter: ["\\\\?\\UNC\\server"],
3524 iter: ["\\\\?\\UNC\\"],
3533 t!("\\\\?\\C:\\foo.txt",
3534 iter: ["\\\\?\\C:", "\\", "foo.txt"],
3537 parent: Some("\\\\?\\C:\\"),
3538 file_name: Some("foo.txt"),
3539 file_stem: Some("foo"),
3540 extension: Some("txt")
3545 iter: ["\\\\?\\C:", "\\"],
3556 iter: ["\\\\?\\C:"],
3566 t!("\\\\?\\foo/bar",
3567 iter: ["\\\\?\\foo/bar"],
3578 iter: ["\\\\?\\C:/foo"],
3588 t!("\\\\.\\foo\\bar",
3589 iter: ["\\\\.\\foo", "\\", "bar"],
3592 parent: Some("\\\\.\\foo\\"),
3593 file_name: Some("bar"),
3594 file_stem: Some("bar"),
3600 iter: ["\\\\.\\foo", "\\"],
3610 t!("\\\\.\\foo/bar",
3611 iter: ["\\\\.\\foo/bar", "\\"],
3621 t!("\\\\.\\foo\\bar/baz",
3622 iter: ["\\\\.\\foo", "\\", "bar", "baz"],
3625 parent: Some("\\\\.\\foo\\bar"),
3626 file_name: Some("baz"),
3627 file_stem: Some("baz"),
3633 iter: ["\\\\.\\", "\\"],
3643 iter: ["\\\\?\\a", "\\", "b"],
3646 parent: Some("\\\\?\\a\\"),
3647 file_name: Some("b"),
3648 file_stem: Some("b"),
3654 pub fn test_stem_ext() {
3656 file_stem: Some("foo"),
3661 file_stem: Some("foo"),
3666 file_stem: Some(".foo"),
3671 file_stem: Some("foo"),
3672 extension: Some("txt")
3676 file_stem: Some("foo.bar"),
3677 extension: Some("txt")
3681 file_stem: Some("foo.bar"),
3702 pub fn test_push() {
3704 ($path:expr, $push:expr, $expected:expr) => ( {
3705 let mut actual = PathBuf::from($path);
3707 assert!(actual.to_str() == Some($expected),
3708 "pushing {:?} onto {:?}: Expected {:?}, got {:?}",
3709 $push, $path, $expected, actual.to_str().unwrap());
3714 tp!("", "foo", "foo");
3715 tp!("foo", "bar", "foo/bar");
3716 tp!("foo/", "bar", "foo/bar");
3717 tp!("foo//", "bar", "foo//bar");
3718 tp!("foo/.", "bar", "foo/./bar");
3719 tp!("foo./.", "bar", "foo././bar");
3720 tp!("foo", "", "foo/");
3721 tp!("foo", ".", "foo/.");
3722 tp!("foo", "..", "foo/..");
3723 tp!("foo", "/", "/");
3724 tp!("/foo/bar", "/", "/");
3725 tp!("/foo/bar", "/baz", "/baz");
3726 tp!("/foo/bar", "./baz", "/foo/bar/./baz");
3728 tp!("", "foo", "foo");
3729 tp!("foo", "bar", r"foo\bar");
3730 tp!("foo/", "bar", r"foo/bar");
3731 tp!(r"foo\", "bar", r"foo\bar");
3732 tp!("foo//", "bar", r"foo//bar");
3733 tp!(r"foo\\", "bar", r"foo\\bar");
3734 tp!("foo/.", "bar", r"foo/.\bar");
3735 tp!("foo./.", "bar", r"foo./.\bar");
3736 tp!(r"foo\.", "bar", r"foo\.\bar");
3737 tp!(r"foo.\.", "bar", r"foo.\.\bar");
3738 tp!("foo", "", "foo\\");
3739 tp!("foo", ".", r"foo\.");
3740 tp!("foo", "..", r"foo\..");
3741 tp!("foo", "/", "/");
3742 tp!("foo", r"\", r"\");
3743 tp!("/foo/bar", "/", "/");
3744 tp!(r"\foo\bar", r"\", r"\");
3745 tp!("/foo/bar", "/baz", "/baz");
3746 tp!("/foo/bar", r"\baz", r"\baz");
3747 tp!("/foo/bar", "./baz", r"/foo/bar\./baz");
3748 tp!("/foo/bar", r".\baz", r"/foo/bar\.\baz");
3750 tp!("c:\\", "windows", "c:\\windows");
3751 tp!("c:", "windows", "c:windows");
3753 tp!("a\\b\\c", "d", "a\\b\\c\\d");
3754 tp!("\\a\\b\\c", "d", "\\a\\b\\c\\d");
3755 tp!("a\\b", "c\\d", "a\\b\\c\\d");
3756 tp!("a\\b", "\\c\\d", "\\c\\d");
3757 tp!("a\\b", ".", "a\\b\\.");
3758 tp!("a\\b", "..\\c", "a\\b\\..\\c");
3759 tp!("a\\b", "C:a.txt", "C:a.txt");
3760 tp!("a\\b", "C:\\a.txt", "C:\\a.txt");
3761 tp!("C:\\a", "C:\\b.txt", "C:\\b.txt");
3762 tp!("C:\\a\\b\\c", "C:d", "C:d");
3763 tp!("C:a\\b\\c", "C:d", "C:d");
3764 tp!("C:", r"a\b\c", r"C:a\b\c");
3765 tp!("C:", r"..\a", r"C:..\a");
3766 tp!("\\\\server\\share\\foo",
3768 "\\\\server\\share\\foo\\bar");
3769 tp!("\\\\server\\share\\foo", "C:baz", "C:baz");
3770 tp!("\\\\?\\C:\\a\\b", "C:c\\d", "C:c\\d");
3771 tp!("\\\\?\\C:a\\b", "C:c\\d", "C:c\\d");
3772 tp!("\\\\?\\C:\\a\\b", "C:\\c\\d", "C:\\c\\d");
3773 tp!("\\\\?\\foo\\bar", "baz", "\\\\?\\foo\\bar\\baz");
3774 tp!("\\\\?\\UNC\\server\\share\\foo",
3776 "\\\\?\\UNC\\server\\share\\foo\\bar");
3777 tp!("\\\\?\\UNC\\server\\share", "C:\\a", "C:\\a");
3778 tp!("\\\\?\\UNC\\server\\share", "C:a", "C:a");
3780 // Note: modified from old path API
3781 tp!("\\\\?\\UNC\\server", "foo", "\\\\?\\UNC\\server\\foo");
3784 "\\\\?\\UNC\\server\\share",
3785 "\\\\?\\UNC\\server\\share");
3786 tp!("\\\\.\\foo\\bar", "baz", "\\\\.\\foo\\bar\\baz");
3787 tp!("\\\\.\\foo\\bar", "C:a", "C:a");
3788 // again, not sure about the following, but I'm assuming \\.\ should be verbatim
3789 tp!("\\\\.\\foo", "..\\bar", "\\\\.\\foo\\..\\bar");
3791 tp!("\\\\?\\C:", "foo", "\\\\?\\C:\\foo"); // this is a weird one
3798 ($path:expr, $expected:expr, $output:expr) => ( {
3799 let mut actual = PathBuf::from($path);
3800 let output = actual.pop();
3801 assert!(actual.to_str() == Some($expected) && output == $output,
3802 "popping from {:?}: Expected {:?}/{:?}, got {:?}/{:?}",
3803 $path, $expected, $output,
3804 actual.to_str().unwrap(), output);
3809 tp!("/", "/", false);
3810 tp!("foo", "", true);
3812 tp!("/foo", "/", true);
3813 tp!("/foo/bar", "/foo", true);
3814 tp!("foo/bar", "foo", true);
3815 tp!("foo/.", "", true);
3816 tp!("foo//bar", "foo", true);
3819 tp!("a\\b\\c", "a\\b", true);
3820 tp!("\\a", "\\", true);
3821 tp!("\\", "\\", false);
3823 tp!("C:\\a\\b", "C:\\a", true);
3824 tp!("C:\\a", "C:\\", true);
3825 tp!("C:\\", "C:\\", false);
3826 tp!("C:a\\b", "C:a", true);
3827 tp!("C:a", "C:", true);
3828 tp!("C:", "C:", false);
3829 tp!("\\\\server\\share\\a\\b", "\\\\server\\share\\a", true);
3830 tp!("\\\\server\\share\\a", "\\\\server\\share\\", true);
3831 tp!("\\\\server\\share", "\\\\server\\share", false);
3832 tp!("\\\\?\\a\\b\\c", "\\\\?\\a\\b", true);
3833 tp!("\\\\?\\a\\b", "\\\\?\\a\\", true);
3834 tp!("\\\\?\\a", "\\\\?\\a", false);
3835 tp!("\\\\?\\C:\\a\\b", "\\\\?\\C:\\a", true);
3836 tp!("\\\\?\\C:\\a", "\\\\?\\C:\\", true);
3837 tp!("\\\\?\\C:\\", "\\\\?\\C:\\", false);
3838 tp!("\\\\?\\UNC\\server\\share\\a\\b",
3839 "\\\\?\\UNC\\server\\share\\a",
3841 tp!("\\\\?\\UNC\\server\\share\\a",
3842 "\\\\?\\UNC\\server\\share\\",
3844 tp!("\\\\?\\UNC\\server\\share",
3845 "\\\\?\\UNC\\server\\share",
3847 tp!("\\\\.\\a\\b\\c", "\\\\.\\a\\b", true);
3848 tp!("\\\\.\\a\\b", "\\\\.\\a\\", true);
3849 tp!("\\\\.\\a", "\\\\.\\a", false);
3851 tp!("\\\\?\\a\\b\\", "\\\\?\\a\\", true);
3856 pub fn test_set_file_name() {
3858 ($path:expr, $file:expr, $expected:expr) => ( {
3859 let mut p = PathBuf::from($path);
3860 p.set_file_name($file);
3861 assert!(p.to_str() == Some($expected),
3862 "setting file name of {:?} to {:?}: Expected {:?}, got {:?}",
3863 $path, $file, $expected,
3864 p.to_str().unwrap());
3868 tfn!("foo", "foo", "foo");
3869 tfn!("foo", "bar", "bar");
3870 tfn!("foo", "", "");
3871 tfn!("", "foo", "foo");
3873 tfn!(".", "foo", "./foo");
3874 tfn!("foo/", "bar", "bar");
3875 tfn!("foo/.", "bar", "bar");
3876 tfn!("..", "foo", "../foo");
3877 tfn!("foo/..", "bar", "foo/../bar");
3878 tfn!("/", "foo", "/foo");
3880 tfn!(".", "foo", r".\foo");
3881 tfn!(r"foo\", "bar", r"bar");
3882 tfn!(r"foo\.", "bar", r"bar");
3883 tfn!("..", "foo", r"..\foo");
3884 tfn!(r"foo\..", "bar", r"foo\..\bar");
3885 tfn!(r"\", "foo", r"\foo");
3890 pub fn test_set_extension() {
3892 ($path:expr, $ext:expr, $expected:expr, $output:expr) => ( {
3893 let mut p = PathBuf::from($path);
3894 let output = p.set_extension($ext);
3895 assert!(p.to_str() == Some($expected) && output == $output,
3896 "setting extension of {:?} to {:?}: Expected {:?}/{:?}, got {:?}/{:?}",
3897 $path, $ext, $expected, $output,
3898 p.to_str().unwrap(), output);
3902 tfe!("foo", "txt", "foo.txt", true);
3903 tfe!("foo.bar", "txt", "foo.txt", true);
3904 tfe!("foo.bar.baz", "txt", "foo.bar.txt", true);
3905 tfe!(".test", "txt", ".test.txt", true);
3906 tfe!("foo.txt", "", "foo", true);
3907 tfe!("foo", "", "foo", true);
3908 tfe!("", "foo", "", false);
3909 tfe!(".", "foo", ".", false);
3910 tfe!("foo/", "bar", "foo.bar", true);
3911 tfe!("foo/.", "bar", "foo.bar", true);
3912 tfe!("..", "foo", "..", false);
3913 tfe!("foo/..", "bar", "foo/..", false);
3914 tfe!("/", "foo", "/", false);
3918 fn test_eq_receivers() {
3921 let borrowed: &Path = Path::new("foo/bar");
3922 let mut owned: PathBuf = PathBuf::new();
3925 let borrowed_cow: Cow<Path> = borrowed.into();
3926 let owned_cow: Cow<Path> = owned.clone().into();
3929 ($($current:expr),+) => {
3931 assert_eq!($current, borrowed);
3932 assert_eq!($current, owned);
3933 assert_eq!($current, borrowed_cow);
3934 assert_eq!($current, owned_cow);
3939 t!(borrowed, owned, borrowed_cow, owned_cow);
3943 pub fn test_compare() {
3944 use hash::{Hash, Hasher};
3945 use collections::hash_map::DefaultHasher;
3947 fn hash<T: Hash>(t: T) -> u64 {
3948 let mut s = DefaultHasher::new();
3954 ($path1:expr, $path2:expr, eq: $eq:expr,
3955 starts_with: $starts_with:expr, ends_with: $ends_with:expr,
3956 relative_from: $relative_from:expr) => ({
3957 let path1 = Path::new($path1);
3958 let path2 = Path::new($path2);
3960 let eq = path1 == path2;
3961 assert!(eq == $eq, "{:?} == {:?}, expected {:?}, got {:?}",
3962 $path1, $path2, $eq, eq);
3963 assert!($eq == (hash(path1) == hash(path2)),
3964 "{:?} == {:?}, expected {:?}, got {} and {}",
3965 $path1, $path2, $eq, hash(path1), hash(path2));
3967 let starts_with = path1.starts_with(path2);
3968 assert!(starts_with == $starts_with,
3969 "{:?}.starts_with({:?}), expected {:?}, got {:?}", $path1, $path2,
3970 $starts_with, starts_with);
3972 let ends_with = path1.ends_with(path2);
3973 assert!(ends_with == $ends_with,
3974 "{:?}.ends_with({:?}), expected {:?}, got {:?}", $path1, $path2,
3975 $ends_with, ends_with);
3977 let relative_from = path1.strip_prefix(path2)
3978 .map(|p| p.to_str().unwrap())
3980 let exp: Option<&str> = $relative_from;
3981 assert!(relative_from == exp,
3982 "{:?}.strip_prefix({:?}), expected {:?}, got {:?}",
3983 $path1, $path2, exp, relative_from);
3991 relative_from: Some("")
3998 relative_from: Some("foo")
4012 relative_from: Some("")
4019 relative_from: Some("")
4022 tc!("foo/bar", "foo",
4026 relative_from: Some("bar")
4029 tc!("foo/bar/baz", "foo/bar",
4033 relative_from: Some("baz")
4036 tc!("foo/bar", "foo/bar/baz",
4043 tc!("./foo/bar/", ".",
4047 relative_from: Some("foo/bar")
4051 tc!(r"C:\src\rust\cargo-test\test\Cargo.toml",
4052 r"c:\src\rust\cargo-test\test",
4056 relative_from: Some("Cargo.toml")
4059 tc!(r"c:\foo", r"C:\foo",
4063 relative_from: Some("")
4069 fn test_components_debug() {
4070 let path = Path::new("/tmp");
4072 let mut components = path.components();
4074 let expected = "Components([RootDir, Normal(\"tmp\")])";
4075 let actual = format!("{:?}", components);
4076 assert_eq!(expected, actual);
4078 let _ = components.next().unwrap();
4079 let expected = "Components([Normal(\"tmp\")])";
4080 let actual = format!("{:?}", components);
4081 assert_eq!(expected, actual);
4083 let _ = components.next().unwrap();
4084 let expected = "Components([])";
4085 let actual = format!("{:?}", components);
4086 assert_eq!(expected, actual);
4091 fn test_iter_debug() {
4092 let path = Path::new("/tmp");
4094 let mut iter = path.iter();
4096 let expected = "Iter([\"/\", \"tmp\"])";
4097 let actual = format!("{:?}", iter);
4098 assert_eq!(expected, actual);
4100 let _ = iter.next().unwrap();
4101 let expected = "Iter([\"tmp\"])";
4102 let actual = format!("{:?}", iter);
4103 assert_eq!(expected, actual);
4105 let _ = iter.next().unwrap();
4106 let expected = "Iter([])";
4107 let actual = format!("{:?}", iter);
4108 assert_eq!(expected, actual);
4113 let orig: &str = "some/sort/of/path";
4114 let path = Path::new(orig);
4115 let boxed: Box<Path> = Box::from(path);
4116 let path_buf = path.to_owned().into_boxed_path().into_path_buf();
4117 assert_eq!(path, &*boxed);
4118 assert_eq!(&*boxed, &*path_buf);
4119 assert_eq!(&*path_buf, path);
4123 fn test_clone_into() {
4124 let mut path_buf = PathBuf::from("supercalifragilisticexpialidocious");
4125 let path = Path::new("short");
4126 path.clone_into(&mut path_buf);
4127 assert_eq!(path, path_buf);
4128 assert!(path_buf.into_os_string().capacity() >= 15);
4132 fn display_format_flags() {
4133 assert_eq!(format!("a{:#<5}b", Path::new("").display()), "a#####b");
4134 assert_eq!(format!("a{:#<5}b", Path::new("a").display()), "aa####b");
4139 let orig = "hello/world";
4140 let path = Path::new(orig);
4141 let rc: Rc<Path> = Rc::from(path);
4142 let arc: Arc<Path> = Arc::from(path);
4144 assert_eq!(&*rc, path);
4145 assert_eq!(&*arc, path);
4147 let rc2: Rc<Path> = Rc::from(path.to_owned());
4148 let arc2: Arc<Path> = Arc::from(path.to_owned());
4150 assert_eq!(&*rc2, path);
4151 assert_eq!(&*arc2, path);