928: class Path(PurePath):

210:     def _split_extended_path(self, s, ext_prefix=ext_namespace_prefix):

134:     pathmod = ntpath

253:     pathmod = posixpath

565: class PurePath(object):

844:     def joinpath(self, *args):

915: class PurePosixPath(PurePath):

920: class PureWindowsPath(PurePath):

952:     def _make_child_relpath(self, part):

1275: class PosixPath(Path, PurePosixPath):

1278: class WindowsPath(Path, PureWindowsPath):

537: class _PathParents(Sequence):

40:         _getfinalpathname = None

45:     "Path", "PosixPath", "WindowsPath",

67:     """A flavour implements a particular (platform-specific) set of path

119:                 # Same drive => second path is relative to the first

122:             # Second path is non-anchored (common case)

162:             prefix, part = self._split_extended_path(part)

169:             # is a UNC path:

176:                 # a UNC path can't have two slashes in a row

201:     def resolve(self, path):

202:         s = str(path)

221:         # Turn back an extended path into a normal DOS-like path

222:         return self._split_extended_path(s)[1]

236:     def make_uri(self, path):

238:         drive = path.drive

240:             # It's a path on a local drive => 'file:///c:/a/b'

241:             rest = path.as_posix()[2:].lstrip('/')

245:             # It's a path on a network drive => 'file://host/share/a/b'

246:             return 'file:' + urlquote_from_bytes(path.as_posix().encode('utf-8'))

260:             # According to POSIX path resolution:

278:     def resolve(self, path):

280:         accessor = path._accessor

282:         def _resolve(path, rest):

284:                 path = ''

292:                     path, _, _ = path.rpartition(sep)

294:                 newpath = path + sep + name

296:                     # Already seen this path

297:                     path = seen[newpath]

298:                     if path is not None:

310:                     path = newpath

313:                     path = _resolve(path, target)

314:                     seen[newpath] = path # resolved symlink

316:             return path

317:         # NOTE: according to POSIX, getcwd() cannot contain path components

319:         base = '' if path.is_absolute() else os.getcwd()

320:         return _resolve(base, str(path)) or sep

325:     def make_uri(self, path):

326:         # We represent the path using the local filesystem encoding,

328:         bpath = bytes(path)

397:     def readlink(self, path):

398:         return os.readlink(path)

433:         raise ValueError("Invalid pattern: '**' can only be an entire path component")

446:     of a given path."""

455:     def select_from(self, parent_path):

456:         """Iterate over all child paths of `parent_path` matched by this

457:         selector.  This can contain parent_path itself."""

458:         path_cls = type(parent_path)

459:         is_dir = path_cls.is_dir

460:         exists = path_cls.exists

461:         listdir = parent_path._accessor.listdir

462:         return self._select_from(parent_path, is_dir, exists, listdir)

467:     def _select_from(self, parent_path, is_dir, exists, listdir):

468:         yield parent_path

477:     def _select_from(self, parent_path, is_dir, exists, listdir):

478:         if not is_dir(parent_path):

480:         path = parent_path._make_child_relpath(self.name)

481:         if exists(path):

482:             for p in self.successor._select_from(path, is_dir, exists, listdir):

492:     def _select_from(self, parent_path, is_dir, exists, listdir):

493:         if not is_dir(parent_path):

495:         cf = parent_path._flavour.casefold

496:         for name in listdir(parent_path):

499:                 path = parent_path._make_child_relpath(name)

500:                 for p in self.successor._select_from(path, is_dir, exists, listdir):

509:     def _iterate_directories(self, parent_path, is_dir, listdir):

510:         yield parent_path

511:         for name in listdir(parent_path):

512:             path = parent_path._make_child_relpath(name)

513:             if is_dir(path):

514:                 for p in self._iterate_directories(path, is_dir, listdir):

517:     def _select_from(self, parent_path, is_dir, exists, listdir):

518:         if not is_dir(parent_path):

524:                 for starting_point in self._iterate_directories(parent_path, is_dir, listdir):

539:     of a path.  Don't try to construct it yourself."""

542:     def __init__(self, path):

544:         self._pathcls = type(path)

545:         self._drv = path._drv

546:         self._root = path._root

547:         self._parts = path._parts

566:     """PurePath represents a filesystem path and offers operations which

579:         PurePath objects.  The strings and path objects are combined so as

580:         to yield a canonicalized path, which is incorporated into the

588:         # Using the parts tuple helps share interned path parts

604:                     "argument should be a path or str object, not %r"

639:         # Overriden in concrete Path

649:         """Return the string representation of the path, suitable for

659:         """Return the string representation of the path with forward (/)

665:         """Return the bytes representation of the path.  This is only

675:         """Return the path as a 'file' URI."""

677:             raise ValueError("relative path can't be expressed as a file URI")

725:                      doc="""The drive prefix (letter or UNC path), if any.""")

728:                     doc="""The root of the path, if any.""")

738:         """The final path component, if any."""

765:         """The final path component, minus its last suffix."""

774:         """Return a new path with the file name changed."""

781:         """Return a new path with the file suffix changed (or added, if none)."""

801:         """Return the relative path to another path identified by the passed

803:         a subpath of the other path), raise ValueError.

807:         #   Path('c:/').relative_to('c:')  gives Path('/')

808:         #   Path('c:/').relative_to('/')   raise ValueError

835:         components in the filesystem path."""

845:         """Combine this path with one or several arguments, and return a

846:         new path representing either a subpath (if all arguments are relative

847:         paths) or a totally different path (if one of the arguments is

864:         """The logical parent of the path."""

874:         """A sequence of this path's logical parents."""

878:         """True if the path is absolute (has both a root and, if applicable,

885:         """Return True if the path contains one of the special names reserved

889:     def match(self, path_pattern):

891:         Return True if this path matches the given pattern.

894:         path_pattern = cf(path_pattern)

895:         drv, root, pat_parts = self._flavour.parse_parts((path_pattern,))

934:         if cls is Path:

954:         # a single part relative to this path.

964:         Open the file pointed by this path and return a file descriptor,

973:         """Return a new path pointing to the current working directory

984:                 # Yielding a path object for these makes little sense

1013:         """Return an absolute version of this path.  This function works

1014:         even if the path doesn't point to anything.

1017:         Use resolve() to get the canonical path to a file.

1030:         Make the path absolute, resolving all symlinks on the way and also

1037:             # the path doesn't exist or is forbidden

1040:         # Now we have no symlinks in the path, it's safe to normalize it.

1048:         Return the result of the stat() system call on this path, like

1070:         Open the file pointed by this path and return a file object, as

1115:         Change the permissions of the path, like os.chmod().

1121:         Like chmod(), except if the path points to a symlink, the symlink's

1129:         If the path is a directory, use rmdir() instead.

1141:         Like stat(), except if the path points to a symlink, the symlink's

1148:         Rename this path to the given path.

1154:         Rename this path to the given path, clobbering the existing

1164:         Make this path a symlink pointing to the given path.

1173:         Whether this path exists.

1185:         Whether this path is a directory.

1192:             # Path doesn't exist or is a broken symlink

1198:         Whether this path is a regular file (also True for symlinks pointing

1206:             # Path doesn't exist or is a broken symlink

1212:         Whether this path is a symbolic link.

1219:             # Path doesn't exist

1224:         Whether this path is a block device.

1231:             # Path doesn't exist or is a broken symlink

1237:         Whether this path is a character device.

1244:             # Path doesn't exist or is a broken symlink

1250:         Whether this path is a FIFO.

1257:             # Path doesn't exist or is a broken symlink

1263:         Whether this path is a socket.

1270:             # Path doesn't exist or is a broken symlink

4: import ntpath

6: import posixpath

44:     "PurePath", "PurePosixPath", "PureWindowsPath",

111:         Join the two paths represented by the respective

128:     # Reference for Windows paths can be found at

150:     # Interesting findings about extended paths:

153:     # - extended paths are always absolute; "relative" extended paths will

160:             # XXX extended paths should also disable the collapsing of "."

227:         # We err on the side of caution and return True for paths which are

232:             # UNC paths are never reserved

262:             # "A pathname that begins with two successive slashes may be

295:                 if newpath in seen:

302:                     raise RuntimeError("Symlink loop from %r" % newpath)

305:                     target = accessor.readlink(newpath)

312:                     seen[newpath] = None # not resolved symlink

329:         return 'file://' + urlquote_from_bytes(bpath)

338:     accessing paths on the filesystem."""

345:         def wrapped(pathobj, *args):

346:             return strfunc(str(pathobj), *args)

351:         def wrapped(pathobjA, pathobjB, *args):

352:             return strfunc(str(pathobjA), str(pathobjB), *args)

368:         def lchmod(self, pathobj, mode):

540:     __slots__ = ('_pathcls', '_drv', '_root', '_parts')

558:         return self._pathcls._from_parsed_parts(self._drv, self._root,

562:         return "<{0}.parents>".format(self._pathcls.__name__)

568:     instantiating a PurePath will return either a PurePosixPath or a

569:     PureWindowsPath object.  You can also instantiate either of these classes

578:         """Construct a PurePath from one or several strings and or existing

581:         new PurePath object.

583:         if cls is PurePath:

584:             cls = PureWindowsPath if os.name == 'nt' else PurePosixPath

589:         # when pickling related paths.

598:             if isinstance(a, PurePath):

690:         if not isinstance(other, PurePath):

705:         if not isinstance(other, PurePath) or self._flavour is not other._flavour:

710:         if not isinstance(other, PurePath) or self._flavour is not other._flavour:

715:         if not isinstance(other, PurePath) or self._flavour is not other._flavour:

720:         if not isinstance(other, PurePath) or self._flavour is not other._flavour:

875:         return _PathParents(self)

935:             cls = WindowsPath if os.name == 'nt' else PosixPath

980:         result for the special paths '.' and '..'.

986:             yield self._make_child_relpath(name)

1041:         normed = self._flavour.pathmod.normpath(s)

1193:             # (see https://bitbucket.org/pitrou/pathlib/issue/12/)

1207:             # (see https://bitbucket.org/pitrou/pathlib/issue/12/)

1232:             # (see https://bitbucket.org/pitrou/pathlib/issue/12/)

1245:             # (see https://bitbucket.org/pitrou/pathlib/issue/12/)

1258:             # (see https://bitbucket.org/pitrou/pathlib/issue/12/)

1271:             # (see https://bitbucket.org/pitrou/pathlib/issue/12/)

37:         from nt import _getfinalpathname

205:         if _getfinalpathname is not None:

206:             return self._ext_to_normal(_getfinalpathname(s))

1023:         # use nt._getfullpathname())

557:     path: &'a [u8],

1687: impl ToOwned for Path {

1774: pub struct Path {

1787: impl Path {

2678: impl AsRef<OsStr> for Path {

2685: impl fmt::Debug for Path {

2712:     path: &'a Path,

2727: impl cmp::PartialEq for Path {

2734: impl Hash for Path {

2742: impl cmp::Eq for Path {}

2744: impl cmp::PartialOrd for Path {

2751: impl cmp::Ord for Path {

2758: impl AsRef<Path> for Path {

2816: impl<'a> IntoIterator for &'a Path {

650:     pub fn as_path(&self) -> &'a Path {

792:     pub fn as_path(&self) -> &'a Path {

1143:     pub fn as_path(&self) -> &Path {

1392:     pub fn into_boxed_path(self) -> Box<Path> {

1081: pub struct PathBuf {

1085: impl PathBuf {

1448: impl Clone for PathBuf {

1484: impl From<Box<Path>> for PathBuf {

1512: impl<T: ?Sized + AsRef<OsStr>> From<&T> for PathBuf {

1522: impl From<OsString> for PathBuf {

1542: impl From<String> for PathBuf {

1552: impl FromStr for PathBuf {

1561: impl<P: AsRef<Path>> iter::FromIterator<P> for PathBuf {

1569: impl<P: AsRef<Path>> iter::Extend<P> for PathBuf {

1580: impl fmt::Debug for PathBuf {

1586: impl ops::Deref for PathBuf {

1594: impl Borrow<Path> for PathBuf {

1601: impl Default for PathBuf {

1641: impl<'a> From<Cow<'a, Path>> for PathBuf {

1699: impl cmp::PartialEq for PathBuf {

1706: impl Hash for PathBuf {

1712: impl cmp::Eq for PathBuf {}

1714: impl cmp::PartialOrd for PathBuf {

1721: impl cmp::Ord for PathBuf {

1728: impl AsRef<OsStr> for PathBuf {

2800: impl AsRef<Path> for PathBuf {

2807: impl<'a> IntoIterator for &'a PathBuf {

1903:     pub fn to_path_buf(&self) -> PathBuf {

2671:     pub fn into_path_buf(self: Box<Path>) -> PathBuf {

18: //! Cross-platform path manipulation.

20: //! This module provides two types, [`PathBuf`] and [`Path`] (akin to [`String`]

23: //! on strings according to the local platform's path syntax.

26: //! returned by the [`components`] method on [`Path`]. [`Component`]s roughly

27: //! correspond to the substrings between path separators (`/` or `\`). You can

28: //! reconstruct an equivalent path from components with the [`push`] method on

34: //! Path manipulation includes both parsing components from slices and building

37: //! To parse a path, you can create a [`Path`] slice from a [`str`]

41: //! use std::path::Path;

44: //! let path = Path::new("/tmp/foo/bar.txt");

46: //! let parent = path.parent();

47: //! assert_eq!(parent, Some(Path::new("/tmp/foo")));

49: //! let file_stem = path.file_stem();

52: //! let extension = path.extension();

59: //! use std::path::PathBuf;

62: //! let mut path = PathBuf::from("c:\\");

64: //! path.push("windows");

65: //! path.push("system32");

67: //! path.set_extension("dll");

71: //! let path: PathBuf = ["c:\\", "windows", "system32.dll"].iter().collect();

74: //! [`components`]: Path::components

96: use crate::sys::path::{is_sep_byte, is_verbatim_sep, parse_prefix, MAIN_SEP_STR};

112: /// Windows path prefixes, e.g., `C:` or `\\server\share`.

114: /// Windows uses a variety of path prefix styles, including references to drive

116: /// others. In addition, some path prefixes are "verbatim" (i.e., prefixed with

123: /// use std::path::{Component, Path, Prefix};

124: /// use std::path::Prefix::*;

127: /// fn get_path_prefix(s: &str) -> Prefix {

128: ///     let path = Path::new(s);

129: ///     match path.components().next().unwrap() {

197:     /// use std::path::Prefix::*;

229: /// Determines whether the character is one of the permitted path

235: /// use std::path;

237: /// assert!(path::is_separator('/')); // '/' works for both Unix and Windows

238: /// assert!(!path::is_separator('❤'));

245: /// The primary separator of path components for the current platform.

248: pub const MAIN_SEPARATOR: char = crate::sys::path::MAIN_SEP;

297:     let path = if let Some(p) = prefix { &s[p.len()..] } else { s };

298:     !path.is_empty() && is_sep_byte(path[0])

345: /// front and back of the path each keep track of what parts of the path have

348: /// Going front to back, a path is made up of a prefix, a starting

358: /// A structure wrapping a Windows path prefix as well as its unparsed string

374: /// use std::path::{Component, Path, Prefix};

377: /// let path = Path::new(r"c:\you\later\");

378: /// match path.components().next().unwrap() {

446: /// A single component of a path.

448: /// A `Component` roughly corresponds to a substring between path separators

452: /// created by the [`components`](Path::components) method on [`Path`].

457: /// use std::path::{Component, Path};

459: /// let path = Path::new("/tmp/foo/bar.txt");

460: /// let components = path.components().collect::<Vec<_>>();

471:     /// A Windows path prefix, e.g., `C:` or `\\server\share`.

481:     /// It represents a separator that designates that a path starts from root.

503:     /// use std::path::Path;

505:     /// let path = Path::new("./tmp/foo/bar.txt");

506:     /// let components: Vec<_> = path.components().map(|comp| comp.as_os_str()).collect();

516:             Component::Normal(path) => path,

528: impl AsRef<Path> for Component<'_> {

530:     fn as_ref(&self) -> &Path {

535: /// An iterator over the [`Component`]s of a [`Path`].

537: /// This `struct` is created by the [`components`] method on [`Path`].

543: /// use std::path::Path;

545: /// let path = Path::new("/tmp/foo/bar.txt");

547: /// for component in path.components() {

552: /// [`components`]: Path::components

556:     // The path left to parse components from

562:     // true if path *physically* has a root separator; for most Windows

573: /// An iterator over the [`Component`]s of a [`Path`], as [`OsStr`] slices.

575: /// This `struct` is created by the [`iter`] method on [`Path`].

578: /// [`iter`]: Path::iter

587:         struct DebugHelper<'a>(&'a Path);

595:         f.debug_tuple("Components").field(&DebugHelper(self.as_path())).finish()

617:     // Given the iteration so far, how much of the pre-State::Body path is left?

636:     /// Extracts a slice corresponding to the portion of the path remaining for iteration.

641:     /// use std::path::Path;

643:     /// let mut components = Path::new("/tmp/foo/bar.txt").components();

647:     /// assert_eq!(Path::new("foo/bar.txt"), components.as_path());

658:         unsafe { Path::from_u8_slice(comps.path) }

661:     /// Is the *original* path rooted?

674:     /// Should the normalized path include a leading . ?

679:         let mut iter = self.path[self.prefix_len()..].iter();

687:     // parse a given byte sequence into the corresponding path component

692:             // the beginning of a path, which is treated

704:         let (extra, comp) = match self.path.iter().position(|b| self.is_sep_byte(*b)) {

705:             None => (0, self.path),

706:             Some(i) => (1, &self.path[..i]),

716:         let (extra, comp) = match self.path[start..].iter().rposition(|b| self.is_sep_byte(*b)) {

717:             None => (0, &self.path[start..]),

718:             Some(i) => (1, &self.path[start + i + 1..]),

725:         while !self.path.is_empty() {

730:                 self.path = &self.path[size..];

737:         while self.path.len() > self.len_before_body() {

742:                 self.path = &self.path[..self.path.len() - size];

748: impl AsRef<Path> for Components<'_> {

750:     fn as_ref(&self) -> &Path {

751:         self.as_path()

758:         self.as_path().as_os_str()

764:         struct DebugHelper<'a>(&'a Path);

772:         f.debug_tuple("Iter").field(&DebugHelper(self.as_path())).finish()

777:     /// Extracts a slice corresponding to the portion of the path remaining for iteration.

782:     /// use std::path::Path;

784:     /// let mut iter = Path::new("/tmp/foo/bar.txt").iter();

788:     /// assert_eq!(Path::new("foo/bar.txt"), iter.as_path());

793:         self.inner.as_path()

797: impl AsRef<Path> for Iter<'_> {

799:     fn as_ref(&self) -> &Path {

800:         self.as_path()

807:         self.as_path().as_os_str()

837:                     debug_assert!(self.prefix_len() <= self.path.len());

838:                     let raw = &self.path[..self.prefix_len()];

839:                     self.path = &self.path[self.prefix_len()..];

851:                         debug_assert!(!self.path.is_empty());

852:                         self.path = &self.path[1..];

859:                         debug_assert!(!self.path.is_empty());

860:                         self.path = &self.path[1..];

864:                 State::Body if !self.path.is_empty() => {

866:                     self.path = &self.path[size..];

885:                 State::Body if self.path.len() > self.len_before_body() => {

887:                     self.path = &self.path[..self.path.len() - size];

898:                         self.path = &self.path[..self.path.len() - 1];

905:                         self.path = &self.path[..self.path.len() - 1];

912:                         raw: unsafe { u8_slice_as_os_str(self.path) },

953:     // Fast path for long shared prefixes

958:     //   otherwise do it on the full path

960:     // The fast path isn't taken for paths with a PrefixComponent to avoid backtracking into

965:             match left.path.iter().zip(right.path.iter()).position(|(&a, &b)| a != b) {

966:                 None if left.path.len() == right.path.len() => return cmp::Ordering::Equal,

967:                 None => left.path.len().min(right.path.len()),

972:             left.path[..first_difference].iter().rposition(|&b| left.is_sep_byte(b))

975:             left.path = &left.path[mismatched_component_start..];

977:             right.path = &right.path[mismatched_component_start..];

985: /// An iterator over [`Path`] and its ancestors.

987: /// This `struct` is created by the [`ancestors`] method on [`Path`].

993: /// use std::path::Path;

995: /// let path = Path::new("/foo/bar");

997: /// for ancestor in path.ancestors() {

1002: /// [`ancestors`]: Path::ancestors

1006:     next: Option<&'a Path>,

1010:     type Item = &'a Path;

1015:         self.next = next.and_then(Path::parent);

1026: /// An owned, mutable path (akin to [`String`]).

1029: /// the path in place. It also implements [`Deref`] to [`Path`], meaning that

1030: /// all methods on [`Path`] slices are available on `PathBuf` values as well.

1044: /// use std::path::PathBuf;

1046: /// let mut path = PathBuf::new();

1048: /// path.push(r"C:\");

1049: /// path.push("windows");

1050: /// path.push("system32");

1052: /// path.set_extension("dll");

1059: /// use std::path::PathBuf;

1061: /// let path: PathBuf = [r"C:\", "windows", "system32.dll"].iter().collect();

1068: /// use std::path::PathBuf;

1070: /// let path = PathBuf::from(r"C:\windows\system32.dll");

1096:     /// use std::path::PathBuf;

1098:     /// let path = PathBuf::new();

1112:     /// use std::path::PathBuf;

1114:     /// let mut path = PathBuf::with_capacity(10);

1115:     /// let capacity = path.capacity();

1118:     /// path.push(r"C:\");

1120:     /// assert_eq!(capacity, path.capacity());

1130:     /// Coerces to a [`Path`] slice.

1135:     /// use std::path::{Path, PathBuf};

1138:     /// assert_eq!(Path::new("/test"), p.as_path());

1147:     /// Extends `self` with `path`.

1149:     /// If `path` is absolute, it replaces the current path.

1153:     /// * if `path` has a root but no prefix (e.g., `\windows`), it

1155:     /// * if `path` has a prefix but no root, it replaces `self`.

1157:     ///   and `path` is not empty, the new path is normalized: all references

1162:     /// Pushing a relative path extends the existing path:

1165:     /// use std::path::PathBuf;

1167:     /// let mut path = PathBuf::from("/tmp");

1168:     /// path.push("file.bk");

1169:     /// assert_eq!(path, PathBuf::from("/tmp/file.bk"));

1172:     /// Pushing an absolute path replaces the existing path:

1175:     /// use std::path::PathBuf;

1177:     /// let mut path = PathBuf::from("/tmp");

1178:     /// path.push("/etc");

1179:     /// assert_eq!(path, PathBuf::from("/etc"));

1181:     pub fn push<P: AsRef<Path>>(&mut self, path: P) {

1182:         self._push(path.as_ref())

1185:     fn _push(&mut self, path: &Path) {

1193:             && comps.prefix_len() == comps.path.len()

1199:         // absolute `path` replaces `self`

1200:         if path.is_absolute() || path.prefix().is_some() {

1204:         } else if comps.prefix_verbatim() && !path.inner.is_empty() {

1206:             for c in path.components() {

1243:         // `path` has a root but no prefix, e.g., `\windows` (Windows only)

1244:         } else if path.has_root() {

1248:         // `path` is a pure relative path

1253:         self.inner.push(path);

1261:     /// [`self.parent`]: Path::parent

1266:     /// use std::path::{Path, PathBuf};

1271:     /// assert_eq!(Path::new("/spirited"), p);

1273:     /// assert_eq!(Path::new("/"), p);

1291:     /// `file_name`. The new path will be a sibling of the original path.

1294:     /// [`self.file_name`]: Path::file_name

1300:     /// use std::path::PathBuf;

1330:     /// [`self.file_name`]: Path::file_name

1331:     /// [`self.extension`]: Path::extension

1336:     /// use std::path::{Path, PathBuf};

1341:     /// assert_eq!(Path::new("/feel/the.force"), p.as_path());

1344:     /// assert_eq!(Path::new("/feel/the.dark_side"), p.as_path());

1378:     /// use std::path::PathBuf;

1389:     /// Converts this `PathBuf` into a [boxed](Box) [`Path`].

1393:         let rw = Box::into_raw(self.inner.into_boxed_os_str()) as *mut Path;

1460: impl From<&Path> for Box<Path> {

1461:     /// Creates a boxed [`Path`] from a reference.

1463:     /// This will allocate and clone `path` to it.

1464:     fn from(path: &Path) -> Box<Path> {

1465:         let boxed: Box<OsStr> = path.inner.into();

1466:         let rw = Box::into_raw(boxed) as *mut Path;

1471: impl From<Cow<'_, Path>> for Box<Path> {

1472:     /// Creates a boxed [`Path`] from a clone-on-write pointer.

1476:     fn from(cow: Cow<'_, Path>) -> Box<Path> {

1478:             Cow::Borrowed(path) => Box::from(path),

1479:             Cow::Owned(path) => Box::from(path),

1485:     /// Converts a `Box<Path>` into a `PathBuf`

1489:     fn from(boxed: Box<Path>) -> PathBuf {

1490:         boxed.into_path_buf()

1494: impl From<PathBuf> for Box<Path> {

1495:     /// Converts a `PathBuf` into a `Box<Path>`

1500:     fn from(p: PathBuf) -> Box<Path> {

1501:         p.into_boxed_path()

1505: impl Clone for Box<Path> {

1508:         self.to_path_buf().into_boxed_path()

1537:     fn from(path_buf: PathBuf) -> OsString {

1538:         path_buf.inner

1587:     type Target = Path;

1589:     fn deref(&self) -> &Path {

1590:         Path::new(&self.inner)

1596:     fn borrow(&self) -> &Path {

1608: impl<'a> From<&'a Path> for Cow<'a, Path> {

1610:     /// [`Path`].

1614:     fn from(s: &'a Path) -> Cow<'a, Path> {

1619: impl<'a> From<PathBuf> for Cow<'a, Path> {

1625:     fn from(s: PathBuf) -> Cow<'a, Path> {

1630: impl<'a> From<&'a PathBuf> for Cow<'a, Path> {

1636:     fn from(p: &'a PathBuf) -> Cow<'a, Path> {

1637:         Cow::Borrowed(p.as_path())

1642:     /// Converts a clone-on-write pointer to an owned path.

1646:     fn from(p: Cow<'a, Path>) -> Self {

1651: impl From<PathBuf> for Arc<Path> {

1654:     fn from(s: PathBuf) -> Arc<Path> {

1656:         unsafe { Arc::from_raw(Arc::into_raw(arc) as *const Path) }

1660: impl From<&Path> for Arc<Path> {

1661:     /// Converts a [`Path`] into an [`Arc`] by copying the [`Path`] data into a new [`Arc`] buffer.

1663:     fn from(s: &Path) -> Arc<Path> {

1665:         unsafe { Arc::from_raw(Arc::into_raw(arc) as *const Path) }

1669: impl From<PathBuf> for Rc<Path> {

1672:     fn from(s: PathBuf) -> Rc<Path> {

1674:         unsafe { Rc::from_raw(Rc::into_raw(rc) as *const Path) }

1678: impl From<&Path> for Rc<Path> {

1679:     /// Converts a [`Path`] into an [`Rc`] by copying the [`Path`] data into a new `Rc` buffer.

1681:     fn from(s: &Path) -> Rc<Path> {

1683:         unsafe { Rc::from_raw(Rc::into_raw(rc) as *const Path) }

1691:         self.to_path_buf()

1708:         self.as_path().hash(h)

1735: /// A slice of a path (akin to [`str`]).

1737: /// This type supports a number of operations for inspecting a path, including

1738: /// breaking the path into its components (separated by `/` on Unix and by either

1739: /// `/` or `\` on Windows), extracting the file name, determining whether the path

1752: /// use std::path::Path;

1756: /// let path = Path::new("./foo/bar.txt");

1758: /// let parent = path.parent();

1759: /// assert_eq!(parent, Some(Path::new("./foo")));

1761: /// let file_stem = path.file_stem();

1764: /// let extension = path.extension();

1767: #[cfg_attr(not(test), rustc_diagnostic_item = "Path")]

1769: // `Path::new` current implementation relies

1770: // on `Path` being layout-compatible with `OsStr`.

1771: // When attribute privacy is implemented, `Path` should be annotated as `#[repr(transparent)]`.

1772: // Anyway, `Path` representation and layout are considered implementation detail, are

1778: /// An error returned from [`Path::strip_prefix`] if the prefix was not found.

1780: /// This `struct` is created by the [`strip_prefix`] method on [`Path`].

1783: /// [`strip_prefix`]: Path::strip_prefix

1788:     // The following (private!) function allows construction of a path from a u8

1790:     unsafe fn from_u8_slice(s: &[u8]) -> &Path {

1791:         Path::new(u8_slice_as_os_str(s))

1798:     /// Directly wraps a string slice as a `Path` slice.

1805:     /// use std::path::Path;

1807:     /// Path::new("foo.txt");

1810:     /// You can create `Path`s from `String`s, or even other `Path`s:

1813:     /// use std::path::Path;

1816:     /// let from_string = Path::new(&string);

1817:     /// let from_path = Path::new(&from_string);

1818:     /// assert_eq!(from_string, from_path);

1820:     pub fn new<S: AsRef<OsStr> + ?Sized>(s: &S) -> &Path {

1821:         unsafe { &*(s.as_ref() as *const OsStr as *const Path) }

1829:     /// use std::path::Path;

1831:     /// let os_str = Path::new("foo.txt").as_os_str();

1840:     /// Yields a [`&str`] slice if the `Path` is valid unicode.

1851:     /// use std::path::Path;

1853:     /// let path = Path::new("foo.txt");

1854:     /// assert_eq!(path.to_str(), Some("foo.txt"));

1863:     /// Converts a `Path` to a [`Cow<str>`].

1872:     /// Calling `to_string_lossy` on a `Path` with valid unicode:

1875:     /// use std::path::Path;

1877:     /// let path = Path::new("foo.txt");

1878:     /// assert_eq!(path.to_string_lossy(), "foo.txt");

1881:     /// Had `path` contained invalid unicode, the `to_string_lossy` call might

1890:     /// Converts a `Path` to an owned [`PathBuf`].

1895:     /// use std::path::Path;

1897:     /// let path_buf = Path::new("foo.txt").to_path_buf();

1898:     /// assert_eq!(path_buf, std::path::PathBuf::from("foo.txt"));

1907:     /// Returns `true` if the `Path` is absolute, i.e., if it is independent of

1910:     /// * On Unix, a path is absolute if it starts with the root, so

1913:     /// * On Windows, a path is absolute if it has a prefix and starts with the

1919:     /// use std::path::Path;

1921:     /// assert!(!Path::new("foo.txt").is_absolute());

1924:     /// [`has_root`]: Path::has_root

1931:     /// Returns `true` if the `Path` is relative, i.e., not absolute.

1938:     /// use std::path::Path;

1940:     /// assert!(Path::new("foo.txt").is_relative());

1943:     /// [`is_absolute`]: Path::is_absolute

1954:     /// Returns `true` if the `Path` has a root.

1956:     /// * On Unix, a path has a root if it begins with `/`.

1958:     /// * On Windows, a path has a root if it:

1966:     /// use std::path::Path;

1968:     /// assert!(Path::new("/etc/passwd").has_root());

1976:     /// Returns the `Path` without its final component, if there is one.

1978:     /// Returns [`None`] if the path terminates in a root or prefix.

1983:     /// use std::path::Path;

1985:     /// let path = Path::new("/foo/bar");

1986:     /// let parent = path.parent().unwrap();

1987:     /// assert_eq!(parent, Path::new("/foo"));

1990:     /// assert_eq!(grand_parent, Path::new("/"));

1994:     pub fn parent(&self) -> Option<&Path> {

1999:                 Some(comps.as_path())

2005:     /// Produces an iterator over `Path` and its ancestors.

2007:     /// The iterator will yield the `Path` that is returned if the [`parent`] method is used zero

2016:     /// use std::path::Path;

2018:     /// let mut ancestors = Path::new("/foo/bar").ancestors();

2019:     /// assert_eq!(ancestors.next(), Some(Path::new("/foo/bar")));

2020:     /// assert_eq!(ancestors.next(), Some(Path::new("/foo")));

2021:     /// assert_eq!(ancestors.next(), Some(Path::new("/")));

2024:     /// let mut ancestors = Path::new("../foo/bar").ancestors();

2025:     /// assert_eq!(ancestors.next(), Some(Path::new("../foo/bar")));

2026:     /// assert_eq!(ancestors.next(), Some(Path::new("../foo")));

2027:     /// assert_eq!(ancestors.next(), Some(Path::new("..")));

2028:     /// assert_eq!(ancestors.next(), Some(Path::new("")));

2032:     /// [`parent`]: Path::parent

2038:     /// Returns the final component of the `Path`, if there is one.

2040:     /// If the path is a normal file, this is the file name. If it's the path of a directory, this

2043:     /// Returns [`None`] if the path terminates in `..`.

2048:     /// use std::path::Path;

2051:     /// assert_eq!(Some(OsStr::new("bin")), Path::new("/usr/bin/").file_name());

2052:     /// assert_eq!(Some(OsStr::new("foo.txt")), Path::new("tmp/foo.txt").file_name());

2053:     /// assert_eq!(Some(OsStr::new("foo.txt")), Path::new("foo.txt/.").file_name());

2054:     /// assert_eq!(Some(OsStr::new("foo.txt")), Path::new("foo.txt/.//").file_name());

2055:     /// assert_eq!(None, Path::new("foo.txt/..").file_name());

2056:     /// assert_eq!(None, Path::new("/").file_name());

2066:     /// Returns a path that, when joined onto `base`, yields `self`.

2073:     /// [`starts_with`]: Path::starts_with

2078:     /// use std::path::{Path, PathBuf};

2080:     /// let path = Path::new("/test/haha/foo.txt");

2082:     /// assert_eq!(path.strip_prefix("/"), Ok(Path::new("test/haha/foo.txt")));

2083:     /// assert_eq!(path.strip_prefix("/test"), Ok(Path::new("haha/foo.txt")));

2084:     /// assert_eq!(path.strip_prefix("/test/"), Ok(Path::new("haha/foo.txt")));

2085:     /// assert_eq!(path.strip_prefix("/test/haha/foo.txt"), Ok(Path::new("")));

2086:     /// assert_eq!(path.strip_prefix("/test/haha/foo.txt/"), Ok(Path::new("")));

2088:     /// assert!(path.strip_prefix("test").is_err());

2089:     /// assert!(path.strip_prefix("/haha").is_err());

2092:     /// assert_eq!(path.strip_prefix(prefix), Ok(Path::new("haha/foo.txt")));

2094:     pub fn strip_prefix<P>(&self, base: P) -> Result<&Path, StripPrefixError>

2096:         P: AsRef<Path>,

2101:     fn _strip_prefix(&self, base: &Path) -> Result<&Path, StripPrefixError> {

2103:             .map(|c| c.as_path())

2109:     /// Only considers whole path components to match.

2114:     /// use std::path::Path;

2116:     /// let path = Path::new("/etc/passwd");

2118:     /// assert!(path.starts_with("/etc"));

2119:     /// assert!(path.starts_with("/etc/"));

2120:     /// assert!(path.starts_with("/etc/passwd"));

2121:     /// assert!(path.starts_with("/etc/passwd/")); // extra slash is okay

2122:     /// assert!(path.starts_with("/etc/passwd///")); // multiple extra slashes are okay

2124:     /// assert!(!path.starts_with("/e"));

2125:     /// assert!(!path.starts_with("/etc/passwd.txt"));

2127:     /// assert!(!Path::new("/etc/foo.rs").starts_with("/etc/foo"));

2130:     pub fn starts_with<P: AsRef<Path>>(&self, base: P) -> bool {

2134:     fn _starts_with(&self, base: &Path) -> bool {

2140:     /// Only considers whole path components to match.

2145:     /// use std::path::Path;

2147:     /// let path = Path::new("/etc/resolv.conf");

2149:     /// assert!(path.ends_with("resolv.conf"));

2150:     /// assert!(path.ends_with("etc/resolv.conf"));

2151:     /// assert!(path.ends_with("/etc/resolv.conf"));

2153:     /// assert!(!path.ends_with("/resolv.conf"));

2154:     /// assert!(!path.ends_with("conf")); // use .extension() instead

2157:     pub fn ends_with<P: AsRef<Path>>(&self, child: P) -> bool {

2161:     fn _ends_with(&self, child: &Path) -> bool {

2167:     /// [`self.file_name`]: Path::file_name

2179:     /// use std::path::Path;

2181:     /// assert_eq!("foo", Path::new("foo.rs").file_stem().unwrap());

2182:     /// assert_eq!("foo.tar", Path::new("foo.tar.gz").file_stem().unwrap());

2186:     /// This method is similar to [`Path::file_prefix`], which extracts the portion of the file name

2189:     /// [`Path::file_prefix`]: Path::file_prefix

2206:     /// [`self.file_name`]: Path::file_name

2211:     /// # #![feature(path_file_prefix)]

2212:     /// use std::path::Path;

2214:     /// assert_eq!("foo", Path::new("foo.rs").file_prefix().unwrap());

2215:     /// assert_eq!("foo", Path::new("foo.tar.gz").file_prefix().unwrap());

2219:     /// This method is similar to [`Path::file_stem`], which extracts the portion of the file name

2222:     /// [`Path::file_stem`]: Path::file_stem

2238:     /// [`self.file_name`]: Path::file_name

2243:     /// use std::path::Path;

2245:     /// assert_eq!("rs", Path::new("foo.rs").extension().unwrap());

2246:     /// assert_eq!("gz", Path::new("foo.tar.gz").extension().unwrap());

2253:     /// Creates an owned [`PathBuf`] with `path` adjoined to `self`.

2255:     /// See [`PathBuf::push`] for more details on what it means to adjoin a path.

2260:     /// use std::path::{Path, PathBuf};

2262:     /// assert_eq!(Path::new("/etc").join("passwd"), PathBuf::from("/etc/passwd"));

2265:     pub fn join<P: AsRef<Path>>(&self, path: P) -> PathBuf {

2266:         self._join(path.as_ref())

2269:     fn _join(&self, path: &Path) -> PathBuf {

2270:         let mut buf = self.to_path_buf();

2271:         buf.push(path);

2282:     /// use std::path::{Path, PathBuf};

2284:     /// let path = Path::new("/tmp/foo.txt");

2285:     /// assert_eq!(path.with_file_name("bar.txt"), PathBuf::from("/tmp/bar.txt"));

2287:     /// let path = Path::new("/tmp");

2288:     /// assert_eq!(path.with_file_name("var"), PathBuf::from("/var"));

2296:         let mut buf = self.to_path_buf();

2308:     /// use std::path::{Path, PathBuf};

2310:     /// let path = Path::new("foo.rs");

2311:     /// assert_eq!(path.with_extension("txt"), PathBuf::from("foo.txt"));

2313:     /// let path = Path::new("foo.tar.gz");

2314:     /// assert_eq!(path.with_extension(""), PathBuf::from("foo.tar"));

2315:     /// assert_eq!(path.with_extension("xz"), PathBuf::from("foo.tar.xz"));

2316:     /// assert_eq!(path.with_extension("").with_extension("txt"), PathBuf::from("foo.txt"));

2323:         let mut buf = self.to_path_buf();

2328:     /// Produces an iterator over the [`Component`]s of the path.

2330:     /// When parsing the path, there is a small amount of normalization:

2336:     ///   beginning of the path. For example, `a/./b`, `a/b/`, `a/b/.` and

2349:     /// use std::path::{Path, Component};

2352:     /// let mut components = Path::new("/tmp/foo.txt").components();

2364:             path: self.as_u8_slice(),

2372:     /// Produces an iterator over the path's components viewed as [`OsStr`]

2375:     /// For more information about the particulars of how the path is separated

2378:     /// [`components`]: Path::components

2383:     /// use std::path::{self, Path};

2386:     /// let mut it = Path::new("/tmp/foo.txt").iter();

2387:     /// assert_eq!(it.next(), Some(OsStr::new(&path::MAIN_SEPARATOR.to_string())));

2400:     /// escapes the path please use [`Debug`] instead.

2407:     /// use std::path::Path;

2409:     /// let path = Path::new("/tmp/foo.rs");

2411:     /// println!("{}", path.display());

2413:     #[must_use = "this does not display the path, \

2417:         Display { path: self }

2430:     /// use std::path::Path;

2432:     /// let path = Path::new("/Minas/tirith");

2433:     /// let metadata = path.metadata().expect("metadata call failed");

2449:     /// use std::path::Path;

2451:     /// let path = Path::new("/Minas/tirith");

2452:     /// let metadata = path.symlink_metadata().expect("symlink_metadata call failed");

2461:     /// Returns the canonical, absolute form of the path with all intermediate

2469:     /// use std::path::{Path, PathBuf};

2471:     /// let path = Path::new("/foo/test/../test/bar.rs");

2472:     /// assert_eq!(path.canonicalize().unwrap(), PathBuf::from("/foo/test/bar.rs"));

2487:     /// use std::path::Path;

2489:     /// let path = Path::new("/laputa/sky_castle.rs");

2490:     /// let path_link = path.read_link().expect("read_link call failed");

2508:     /// use std::path::Path;

2510:     /// let path = Path::new("/laputa");

2511:     /// for entry in path.read_dir().expect("read_dir call failed") {

2513:     ///         println!("{:?}", entry.path());

2523:     /// Returns `true` if the path points at an existing entity.

2534:     /// use std::path::Path;

2535:     /// assert!(!Path::new("does_not_exist.txt").exists());

2549:     /// Returns `Ok(true)` if the path points at an existing entity.

2555:     /// unrelated to the path not existing. (E.g. it will return `Err(_)` in case of permission

2561:     /// #![feature(path_try_exists)]

2563:     /// use std::path::Path;

2564:     /// assert!(!Path::new("does_not_exist.txt").try_exists().expect("Can't check existence of file does_not_exist.txt"))...(1 bytes skipped)...

2565:     /// assert!(Path::new("/root/secret_file.txt").try_exists().is_err());

2575:     /// Returns `true` if the path exists on disk and is pointing at a regular file.

2586:     /// use std::path::Path;

2587:     /// assert_eq!(Path::new("./is_a_directory/").is_file(), false);

2588:     /// assert_eq!(Path::new("a_file.txt").is_file(), true);

2608:     /// Returns `true` if the path exists on disk and is pointing at a directory.

2619:     /// use std::path::Path;

2620:     /// assert_eq!(Path::new("./is_a_directory/").is_dir(), true);

2621:     /// assert_eq!(Path::new("a_file.txt").is_dir(), false);

2635:     /// Returns `true` if the path exists on disk and is pointing at a symbolic link.

2648:     /// use std::path::Path;

2651:     /// let link_path = Path::new("link");

2652:     /// symlink("/origin_does_not_exists/", link_path).unwrap();

2653:     /// assert_eq!(link_path.is_symlink(), true);

2654:     /// assert_eq!(link_path.exists(), false);

2668:     /// Converts a [`Box<Path>`](Box) into a [`PathBuf`] without copying or

2693: /// A [`Path`] might contain non-Unicode data. This `struct` implements the

2695: /// [`display`](Path::display) method on [`Path`]. This may perform lossy

2697: /// which escapes the path please use [`Debug`] instead.

2702: /// use std::path::Path;

2704: /// let path = Path::new("/tmp/foo.rs");

2706: /// println!("{}", path.display());

2717:         fmt::Debug::fmt(&self.path, f)

2723:         self.path.inner.display(f)

2729:     fn eq(&self, other: &Path) -> bool {

2746:     fn partial_cmp(&self, other: &Path) -> Option<cmp::Ordering> {

2753:     fn cmp(&self, other: &Path) -> cmp::Ordering {

2760:     fn as_ref(&self) -> &Path {

2765: impl AsRef<Path> for OsStr {

2767:     fn as_ref(&self) -> &Path {

2768:         Path::new(self)

2772: impl AsRef<Path> for Cow<'_, OsStr> {

2774:     fn as_ref(&self) -> &Path {

2775:         Path::new(self)

2779: impl AsRef<Path> for OsString {

2781:     fn as_ref(&self) -> &Path {

2782:         Path::new(self)

2786: impl AsRef<Path> for str {

2788:     fn as_ref(&self) -> &Path {

2789:         Path::new(self)

2793: impl AsRef<Path> for String {

2795:     fn as_ref(&self) -> &Path {

2796:         Path::new(self)

2802:     fn as_ref(&self) -> &Path {

2830:                 <Path as PartialEq>::eq(self, other)

2837:                 <Path as PartialEq>::eq(self, other)

2844:                 <Path as PartialOrd>::partial_cmp(self, other)

2851:                 <Path as PartialOrd>::partial_cmp(self, other)

2857: impl_cmp!(PathBuf, Path);

2858: impl_cmp!(PathBuf, &'a Path);

2859: impl_cmp!(Cow<'a, Path>, Path);

2860: impl_cmp!(Cow<'a, Path>, &'b Path);

2861: impl_cmp!(Cow<'a, Path>, PathBuf);

2868:                 <Path as PartialEq>::eq(self, other.as_ref())

2875:                 <Path as PartialEq>::eq(self.as_ref(), other)

2882:                 <Path as PartialOrd>::partial_cmp(self, other.as_ref())

2889:                 <Path as PartialOrd>::partial_cmp(self.as_ref(), other)

2899: impl_cmp_os_str!(Path, OsStr);

2900: impl_cmp_os_str!(Path, &'a OsStr);

2901: impl_cmp_os_str!(Path, Cow<'a, OsStr>);

2902: impl_cmp_os_str!(Path, OsString);

2903: impl_cmp_os_str!(&'a Path, OsStr);

2904: impl_cmp_os_str!(&'a Path, Cow<'b, OsStr>);

2905: impl_cmp_os_str!(&'a Path, OsString);

2906: impl_cmp_os_str!(Cow<'a, Path>, OsStr);

2907: impl_cmp_os_str!(Cow<'a, Path>, &'b OsStr);

2908: impl_cmp_os_str!(Cow<'a, Path>, OsString);

21: //! and [`str`]), for working with paths abstractly. These types are thin wrappers

25: //! Paths can be parsed into [`Component`]s by iterating over the structure

29: //! [`PathBuf`]; note that the paths may differ syntactically by the

35: //! new owned paths.

56: //! To build or modify paths, use [`PathBuf`]:

75: //! [`push`]: PathBuf::push

1032: /// [`push`]: PathBuf::push

1033: /// [`set_extension`]: PathBuf::set_extension

1040: /// You can use [`push`] to build up a `PathBuf` from

1074: #[cfg_attr(not(test), rustc_diagnostic_item = "PathBuf")]

1076: // `PathBuf::as_mut_vec` current implementation relies

1077: // on `PathBuf` being layout-compatible with `Vec<u8>`.

1078: // When attribute privacy is implemented, `PathBuf` should be annotated as `#[repr(transparent)]`.

1079: // Anyway, `PathBuf` representation and layout are considered implementation detail, are

1088:         unsafe { &mut *(self as *mut PathBuf as *mut Vec<u8>) }

1091:     /// Allocates an empty `PathBuf`.

1102:     pub fn new() -> PathBuf {

1103:         PathBuf { inner: OsString::new() }

1106:     /// Creates a new `PathBuf` with a given capacity used to create the

1126:     pub fn with_capacity(capacity: usize) -> PathBuf {

1127:         PathBuf { inner: OsString::with_capacity(capacity) }

1137:     /// let p = PathBuf::from("/test");

1203:         // verbatim paths need . and .. removed

1268:     /// let mut p = PathBuf::from("/spirited/away.rs");

1295:     /// [`pop`]: PathBuf::pop

1302:     /// let mut buf = PathBuf::from("/");

1305:     /// assert!(buf == PathBuf::from("/bar"));

1308:     /// assert!(buf == PathBuf::from("/baz.txt"));

1338:     /// let mut p = PathBuf::from("/feel/the");

1373:     /// Consumes the `PathBuf`, yielding its internal [`OsString`] storage.

1380:     /// let p = PathBuf::from("/the/head");

1451:         PathBuf { inner: self.inner.clone() }

1513:     /// Converts a borrowed `OsStr` to a `PathBuf`.

1515:     /// Allocates a [`PathBuf`] and copies the data into it.

1517:     fn from(s: &T) -> PathBuf {

1518:         PathBuf::from(s.as_ref().to_os_string())

1523:     /// Converts an [`OsString`] into a [`PathBuf`]

1527:     fn from(s: OsString) -> PathBuf {

1528:         PathBuf { inner: s }

1532: impl From<PathBuf> for OsString {

1533:     /// Converts a [`PathBuf`] into an [`OsString`]

1543:     /// Converts a [`String`] into a [`PathBuf`]

1547:     fn from(s: String) -> PathBuf {

1548:         PathBuf::from(OsString::from(s))

1557:         Ok(PathBuf::from(s))

1562:     fn from_iter<I: IntoIterator<Item = P>>(iter: I) -> PathBuf {

1563:         let mut buf = PathBuf::new();

1604:         PathBuf::new()

1621:     /// instance of [`PathBuf`].

1632:     /// [`PathBuf`].

1652:     /// Converts a [`PathBuf`] into an [`Arc`] by moving the [`PathBuf`] data into a new [`Arc`] buffer.

1670:     /// Converts a [`PathBuf`] into an [`Rc`] by moving the [`PathBuf`] data into a new `Rc` buffer.

1688:     type Owned = PathBuf;

1690:     fn to_owned(&self) -> PathBuf {

1694:     fn clone_into(&self, target: &mut PathBuf) {

1701:     fn eq(&self, other: &PathBuf) -> bool {

1716:     fn partial_cmp(&self, other: &PathBuf) -> Option<cmp::Ordering> {

1723:     fn cmp(&self, other: &PathBuf) -> cmp::Ordering {

1744: /// see [`PathBuf`].

1904:         PathBuf::from(self.inner.to_os_string())

2091:     /// let prefix = PathBuf::from("/test/");

2275:     /// Creates an owned [`PathBuf`] like `self` but with the given file name.

2277:     /// See [`PathBuf::set_file_name`] for more details.

2291:     pub fn with_file_name<S: AsRef<OsStr>>(&self, file_name: S) -> PathBuf {

2295:     fn _with_file_name(&self, file_name: &OsStr) -> PathBuf {

2301:     /// Creates an owned [`PathBuf`] like `self` but with the given extension.

2303:     /// See [`PathBuf::set_extension`] for more details.

2318:     pub fn with_extension<S: AsRef<OsStr>>(&self, extension: S) -> PathBuf {

2322:     fn _with_extension(&self, extension: &OsStr) -> PathBuf {

2397:     /// Returns an object that implements [`Display`] for safely printing paths

2476:     pub fn canonicalize(&self) -> io::Result<PathBuf> {

2494:     pub fn read_link(&self) -> io::Result<PathBuf> {

2674:         PathBuf { inner: OsString::from(inner) }

2691: /// Helper struct for safely printing paths with [`format!`] and `{}`.

2895: impl_cmp_os_str!(PathBuf, OsStr);

2896: impl_cmp_os_str!(PathBuf, &'a OsStr);

2897: impl_cmp_os_str!(PathBuf, Cow<'a, OsStr>);

2898: impl_cmp_os_str!(PathBuf, OsString);

18: package path

392:     path: &'a [u8],

1202: impl ToOwned for Path {

1262: pub struct Path {

1277: impl Path {

1730: impl AsRef<OsStr> for Path {

1736: impl fmt::Debug for Path {

1749:     path: &'a Path,

1764: impl cmp::PartialEq for Path {

1770: impl Hash for Path {

1778: impl cmp::Eq for Path {}

1780: impl cmp::PartialOrd for Path {

1786: impl cmp::Ord for Path {

1792: impl AsRef<Path> for Path {

1844: impl<'a> IntoIterator for &'a Path {

475:     pub fn as_path(&self) -> &'a Path {

602:     pub fn as_path(&self) -> &'a Path {

823:     pub fn as_path(&self) -> &Path {

968:     pub fn into_boxed_path(self) -> Box<Path> {

797: pub struct PathBuf {

801: impl PathBuf {

1030: impl From<Box<Path>> for PathBuf {

1056: impl<T: ?Sized + AsRef<OsStr>> From<&T> for PathBuf {

1062: impl From<OsString> for PathBuf {

1081: impl From<String> for PathBuf {

1090: impl FromStr for PathBuf {

1098: impl<P: AsRef<Path>> iter::FromIterator<P> for PathBuf {

1106: impl<P: AsRef<Path>> iter::Extend<P> for PathBuf {

1112: impl fmt::Debug for PathBuf {

1118: impl ops::Deref for PathBuf {

1126: impl Borrow<Path> for PathBuf {

1132: impl Default for PathBuf {

1159: impl<'a> From<Cow<'a, Path>> for PathBuf {

1212: impl cmp::PartialEq for PathBuf {

1218: impl Hash for PathBuf {

1224: impl cmp::Eq for PathBuf {}

1226: impl cmp::PartialOrd for PathBuf {

1232: impl cmp::Ord for PathBuf {

1238: impl AsRef<OsStr> for PathBuf {

1829: impl AsRef<Path> for PathBuf {

1836: impl<'a> IntoIterator for &'a PathBuf {

1333:     pub fn to_path_buf(&self) -> PathBuf {

1723:     pub fn into_path_buf(self: Box<Path>) -> PathBuf {

18: //! Cross-platform path manipulation.

20: //! This module provides two types, [`PathBuf`] and [`Path`] (akin to [`String`]

23: //! on strings according to the local platform's path syntax.

26: //! returned by the [`components`] method on [`Path`]. [`Component`]s roughly

27: //! correspond to the substrings between path separators (`/` or `\`). You can

28: //! reconstruct an equivalent path from components with the [`push`] method on

39: use crate::sys::path::{is_sep_byte, is_verbatim_sep, parse_prefix, MAIN_SEP_STR};

65: /// Windows path prefixes, e.g., `C:` or `\\server\share`.

67: /// Windows uses a variety of path prefix styles, including references to drive

69: /// others. In addition, some path prefixes are "verbatim" (i.e., prefixed with

152: /// Determines whether the character is one of the permitted path

159: /// The primary separator of path components for the current platform.

162: pub const MAIN_SEPARATOR: char = crate::sys::path::MAIN_SEP;

210:     let path = if let Some(p) = prefix { &s[p.len()..] } else { s };

211:     !path.is_empty() && is_sep_byte(path[0])

242: /// front and back of the path each keep track of what parts of the path have

245: /// Going front to back, a path is made up of a prefix, a starting

255: /// A structure wrapping a Windows path prefix as well as its unparsed string

319: /// A single component of a path.

321: /// A `Component` roughly corresponds to a substring between path separators

325: /// created by the [`components`][`Path::components`] method on [`Path`].

330:     /// A Windows path prefix, e.g., `C:` or `\\server\share`.

342:     /// It represents a separator that designates that a path starts from root.

367:             Component::Normal(path) => path,

378: impl AsRef<Path> for Component<'_> {

379:     fn as_ref(&self) -> &Path {

384: /// An iterator over the [`Component`]s of a [`Path`].

386: /// This `struct` is created by the [`components`] method on [`Path`].

391:     // The path left to parse components from

397:     // true if path *physically* has a root separator; for most Windows

408: /// An iterator over the [`Component`]s of a [`Path`], as [`OsStr`] slices.

410: /// This `struct` is created by the [`iter`] method on [`Path`].

414: /// [`iter`]: struct.Path.html#method.iter

416: /// [`Path`]: struct.Path.html

424:         struct DebugHelper<'a>(&'a Path);

432:         f.debug_tuple("Components").field(&DebugHelper(self.as_path())).finish()

454:     // Given the iteration so far, how much of the pre-State::Body path is left?

473:     /// Extracts a slice corresponding to the portion of the path remaining for iteration.

483:         unsafe { Path::from_u8_slice(comps.path) }

486:     /// Is the *original* path rooted?

499:     /// Should the normalized path include a leading . ?

504:         let mut iter = self.path[self.prefix_len()..].iter();

512:     // parse a given byte sequence into the corresponding path component

517:             // the beginning of a path, which is treated

529:         let (extra, comp) = match self.path.iter().position(|b| self.is_sep_byte(*b)) {

530:             None => (0, self.path),

531:             Some(i) => (1, &self.path[..i]),

541:         let (extra, comp) = match self.path[start..].iter().rposition(|b| self.is_sep_byte(*b)) {

542:             None => (0, &self.path[start..]),

543:             Some(i) => (1, &self.path[start + i + 1..]),

550:         while !self.path.is_empty() {

555:                 self.path = &self.path[size..];

562:         while self.path.len() > self.len_before_body() {

567:                 self.path = &self.path[..self.path.len() - size];

573: impl AsRef<Path> for Components<'_> {

574:     fn as_ref(&self) -> &Path {

575:         self.as_path()

581:         self.as_path().as_os_str()

587:         struct DebugHelper<'a>(&'a Path);

595:         f.debug_tuple("Iter").field(&DebugHelper(self.as_path())).finish()

600:     /// Extracts a slice corresponding to the portion of the path remaining for iteration.

603:         self.inner.as_path()

607: impl AsRef<Path> for Iter<'_> {

608:     fn as_ref(&self) -> &Path {

609:         self.as_path()

615:         self.as_path().as_os_str()

643:                     debug_assert!(self.prefix_len() <= self.path.len());

644:                     let raw = &self.path[..self.prefix_len()];

645:                     self.path = &self.path[self.prefix_len()..];

657:                         debug_assert!(!self.path.is_empty());

658:                         self.path = &self.path[1..];

665:                         debug_assert!(!self.path.is_empty());

666:                         self.path = &self.path[1..];

670:                 State::Body if !self.path.is_empty() => {

672:                     self.path = &self.path[size..];

691:                 State::Body if self.path.len() > self.len_before_body() => {

693:                     self.path = &self.path[..self.path.len() - size];

704:                         self.path = &self.path[..self.path.len() - 1];

711:                         self.path = &self.path[..self.path.len() - 1];

718:                         raw: unsafe { u8_slice_as_os_str(self.path) },

755: /// An iterator over [`Path`] and its ancestors.

757: /// This `struct` is created by the [`ancestors`] method on [`Path`].

762:     next: Option<&'a Path>,

766:     type Item = &'a Path;

770:         self.next = next.and_then(Path::parent);

781: /// An owned, mutable path (akin to [`String`]).

784: /// the path in place. It also implements [`Deref`] to [`Path`], meaning that

785: /// all methods on [`Path`] slices are available on `PathBuf` values as well.

788: /// [`Path`]: struct.Path.html

819:     /// Coerces to a [`Path`] slice.

821:     /// [`Path`]: struct.Path.html

827:     /// Extends `self` with `path`.

829:     /// If `path` is absolute, it replaces the current path.

833:     /// * if `path` has a root but no prefix (e.g., `\windows`), it

835:     /// * if `path` has a prefix but no root, it replaces `self`.

837:     pub fn push<P: AsRef<Path>>(&mut self, path: P) {

838:         self._push(path.as_ref())

841:     fn _push(&mut self, path: &Path) {

849:                 && comps.prefix_len() == comps.path.len()

856:         // absolute `path` replaces `self`

857:         if path.is_absolute() || path.prefix().is_some() {

860:         // `path` has a root but no prefix, e.g., `\windows` (Windows only)

861:         } else if path.has_root() {

865:         // `path` is a pure relative path

870:         self.inner.push(path);

898:     /// `file_name`. The new path will be a sibling of the original path.

964:     /// Converts this `PathBuf` into a [boxed][`Box`] [`Path`].

967:     /// [`Path`]: struct.Path.html

969:         let rw = Box::into_raw(self.inner.into_boxed_os_str()) as *mut Path;

1022: impl From<&Path> for Box<Path> {

1023:     fn from(path: &Path) -> Box<Path> {

1024:         let boxed: Box<OsStr> = path.inner.into();

1025:         let rw = Box::into_raw(boxed) as *mut Path;

1031:     /// Converts a `Box<Path>` into a `PathBuf`

1034:     fn from(boxed: Box<Path>) -> PathBuf {

1035:         boxed.into_path_buf()

1039: impl From<PathBuf> for Box<Path> {

1040:     /// Converts a `PathBuf` into a `Box<Path>`

1044:     fn from(p: PathBuf) -> Box<Path> {

1045:         p.into_boxed_path()

1049: impl Clone for Box<Path> {

1052:         self.to_path_buf().into_boxed_path()

1076:     fn from(path_buf: PathBuf) -> OsString {

1077:         path_buf.inner

1119:     type Target = Path;

1121:     fn deref(&self) -> &Path {

1122:         Path::new(&self.inner)

1127:     fn borrow(&self) -> &Path {

1138: impl<'a> From<&'a Path> for Cow<'a, Path> {

1140:     fn from(s: &'a Path) -> Cow<'a, Path> {

1145: impl<'a> From<PathBuf> for Cow<'a, Path> {

1147:     fn from(s: PathBuf) -> Cow<'a, Path> {

1152: impl<'a> From<&'a PathBuf> for Cow<'a, Path> {

1154:     fn from(p: &'a PathBuf) -> Cow<'a, Path> {

1155:         Cow::Borrowed(p.as_path())

1161:     fn from(p: Cow<'a, Path>) -> Self {

1166: impl From<PathBuf> for Arc<Path> {

1169:     fn from(s: PathBuf) -> Arc<Path> {

1171:         unsafe { Arc::from_raw(Arc::into_raw(arc) as *const Path) }

1175: impl From<&Path> for Arc<Path> {

1176:     /// Converts a `Path` into an `Arc` by copying the `Path` data into a new `Arc` buffer.

1178:     fn from(s: &Path) -> Arc<Path> {

1180:         unsafe { Arc::from_raw(Arc::into_raw(arc) as *const Path) }

1184: impl From<PathBuf> for Rc<Path> {

1187:     fn from(s: PathBuf) -> Rc<Path> {

1189:         unsafe { Rc::from_raw(Rc::into_raw(rc) as *const Path) }

1193: impl From<&Path> for Rc<Path> {

1194:     /// Converts a `Path` into an `Rc` by copying the `Path` data into a new `Rc` buffer.

1196:     fn from(s: &Path) -> Rc<Path> {

1198:         unsafe { Rc::from_raw(Rc::into_raw(rc) as *const Path) }

1205:         self.to_path_buf()

1220:         self.as_path().hash(h)

1244: /// A slice of a path (akin to [`str`]).

1246: /// This type supports a number of operations for inspecting a path, including

1247: /// breaking the path into its components (separated by `/` on Unix and by either

1248: /// `/` or `\` on Windows), extracting the file name, determining whether the path

1266: /// An error returned from [`Path::strip_prefix`][`strip_prefix`] if the prefix

1269: /// This `struct` is created by the [`strip_prefix`] method on [`Path`].

1272: /// [`strip_prefix`]: struct.Path.html#method.strip_prefix

1273: /// [`Path`]: struct.Path.html

1278:     // The following (private!) function allows construction of a path from a u8

1280:     unsafe fn from_u8_slice(s: &[u8]) -> &Path {

1281:         Path::new(u8_slice_as_os_str(s))

1288:     /// Directly wraps a string slice as a `Path` slice.

1292:     pub fn new<S: AsRef<OsStr> + ?Sized>(s: &S) -> &Path {

1293:         unsafe { &*(s.as_ref() as *const OsStr as *const Path) }

1304:     /// Yields a [`&str`] slice if the `Path` is valid unicode.

1316:     /// Converts a `Path` to a [`Cow<str>`].

1328:     /// Converts a `Path` to an owned [`PathBuf`].

1337:     /// Returns `true` if the `Path` is absolute, i.e., if it is independent of