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 //! Filesystem manipulation operations
13 //! This module contains basic methods to manipulate the contents of the local
14 //! filesystem. All methods in this module represent cross-platform filesystem
15 //! operations. Extra platform-specific functionality can be found in the
16 //! extension traits of `std::os::$platform`.
18 #![stable(feature = "rust1", since = "1.0.0")]
22 use io::{self, SeekFrom, Seek, Read, Write};
23 use path::{Path, PathBuf};
24 use sys::fs as fs_imp;
25 use sys_common::io::read_to_end_uninitialized;
26 use sys_common::{AsInnerMut, FromInner, AsInner, IntoInner};
29 /// A reference to an open file on the filesystem.
31 /// An instance of a `File` can be read and/or written depending on what options
32 /// it was opened with. Files also implement `Seek` to alter the logical cursor
33 /// that the file contains internally.
38 /// use std::io::prelude::*;
39 /// use std::fs::File;
41 /// # fn foo() -> std::io::Result<()> {
42 /// let mut f = try!(File::create("foo.txt"));
43 /// try!(f.write_all(b"Hello, world!"));
45 /// let mut f = try!(File::open("foo.txt"));
46 /// let mut s = String::new();
47 /// try!(f.read_to_string(&mut s));
48 /// assert_eq!(s, "Hello, world!");
52 #[stable(feature = "rust1", since = "1.0.0")]
57 /// Metadata information about a file.
59 /// This structure is returned from the `metadata` function or method and
60 /// represents known metadata about a file such as its permissions, size,
61 /// modification times, etc.
62 #[stable(feature = "rust1", since = "1.0.0")]
64 pub struct Metadata(fs_imp::FileAttr);
66 /// Iterator over the entries in a directory.
68 /// This iterator is returned from the `read_dir` function of this module and
69 /// will yield instances of `io::Result<DirEntry>`. Through a `DirEntry`
70 /// information like the entry's path and possibly other metadata can be
75 /// This `io::Result` will be an `Err` if there's some sort of intermittent
76 /// IO error during iteration.
77 #[stable(feature = "rust1", since = "1.0.0")]
78 pub struct ReadDir(fs_imp::ReadDir);
80 /// Entries returned by the `ReadDir` iterator.
82 /// An instance of `DirEntry` represents an entry inside of a directory on the
83 /// filesystem. Each entry can be inspected via methods to learn about the full
84 /// path or possibly other metadata through per-platform extension traits.
85 #[stable(feature = "rust1", since = "1.0.0")]
86 pub struct DirEntry(fs_imp::DirEntry);
88 /// An iterator that recursively walks over the contents of a directory.
89 #[unstable(feature = "fs_walk",
90 reason = "the precise semantics and defaults for a recursive walk \
91 may change and this may end up accounting for files such \
92 as symlinks differently",
96 stack: Vec<io::Result<ReadDir>>,
99 /// Options and flags which can be used to configure how a file is opened.
101 /// This builder exposes the ability to configure how a `File` is opened and
102 /// what operations are permitted on the open file. The `File::open` and
103 /// `File::create` methods are aliases for commonly used options using this
106 /// Generally speaking, when using `OpenOptions`, you'll first call `new()`,
107 /// then chain calls to methods to set each option, then call `open()`, passing
108 /// the path of the file you're trying to open. This will give you a
109 /// [`io::Result`][result] with a [`File`][file] inside that you can further
112 /// [result]: ../io/type.Result.html
113 /// [file]: struct.File.html
117 /// Opening a file to read:
120 /// use std::fs::OpenOptions;
122 /// let file = OpenOptions::new().read(true).open("foo.txt");
125 /// Opening a file for both reading and writing, as well as creating it if it
129 /// use std::fs::OpenOptions;
131 /// let file = OpenOptions::new()
135 /// .open("foo.txt");
138 #[stable(feature = "rust1", since = "1.0.0")]
139 pub struct OpenOptions(fs_imp::OpenOptions);
141 /// Representation of the various permissions on a file.
143 /// This module only currently provides one bit of information, `readonly`,
144 /// which is exposed on all currently supported platforms. Unix-specific
145 /// functionality, such as mode bits, is available through the
146 /// `os::unix::PermissionsExt` trait.
147 #[derive(Clone, PartialEq, Eq, Debug)]
148 #[stable(feature = "rust1", since = "1.0.0")]
149 pub struct Permissions(fs_imp::FilePermissions);
151 /// An structure representing a type of file with accessors for each file type.
152 #[stable(feature = "file_type", since = "1.1.0")]
153 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
154 pub struct FileType(fs_imp::FileType);
156 /// A builder used to create directories in various manners.
158 /// This builder also supports platform-specific options.
159 #[unstable(feature = "dir_builder", reason = "recently added API",
161 pub struct DirBuilder {
162 inner: fs_imp::DirBuilder,
167 /// Attempts to open a file in read-only mode.
169 /// See the `OpenOptions::open` method for more details.
173 /// This function will return an error if `path` does not already exist.
174 /// Other errors may also be returned according to `OpenOptions::open`.
179 /// use std::fs::File;
181 /// # fn foo() -> std::io::Result<()> {
182 /// let mut f = try!(File::open("foo.txt"));
186 #[stable(feature = "rust1", since = "1.0.0")]
187 pub fn open<P: AsRef<Path>>(path: P) -> io::Result<File> {
188 OpenOptions::new().read(true).open(path.as_ref())
191 /// Opens a file in write-only mode.
193 /// This function will create a file if it does not exist,
194 /// and will truncate it if it does.
196 /// See the `OpenOptions::open` function for more details.
201 /// use std::fs::File;
203 /// # fn foo() -> std::io::Result<()> {
204 /// let mut f = try!(File::create("foo.txt"));
208 #[stable(feature = "rust1", since = "1.0.0")]
209 pub fn create<P: AsRef<Path>>(path: P) -> io::Result<File> {
210 OpenOptions::new().write(true).create(true).truncate(true).open(path.as_ref())
213 /// Attempts to sync all OS-internal metadata to disk.
215 /// This function will attempt to ensure that all in-core data reaches the
216 /// filesystem before returning.
221 /// use std::fs::File;
222 /// use std::io::prelude::*;
224 /// # fn foo() -> std::io::Result<()> {
225 /// let mut f = try!(File::create("foo.txt"));
226 /// try!(f.write_all(b"Hello, world!"));
228 /// try!(f.sync_all());
232 #[stable(feature = "rust1", since = "1.0.0")]
233 pub fn sync_all(&self) -> io::Result<()> {
237 /// This function is similar to `sync_all`, except that it may not
238 /// synchronize file metadata to the filesystem.
240 /// This is intended for use cases that must synchronize content, but don't
241 /// need the metadata on disk. The goal of this method is to reduce disk
244 /// Note that some platforms may simply implement this in terms of
250 /// use std::fs::File;
251 /// use std::io::prelude::*;
253 /// # fn foo() -> std::io::Result<()> {
254 /// let mut f = try!(File::create("foo.txt"));
255 /// try!(f.write_all(b"Hello, world!"));
257 /// try!(f.sync_data());
261 #[stable(feature = "rust1", since = "1.0.0")]
262 pub fn sync_data(&self) -> io::Result<()> {
263 self.inner.datasync()
266 /// Truncates or extends the underlying file, updating the size of
267 /// this file to become `size`.
269 /// If the `size` is less than the current file's size, then the file will
270 /// be shrunk. If it is greater than the current file's size, then the file
271 /// will be extended to `size` and have all of the intermediate data filled
276 /// This function will return an error if the file is not opened for writing.
281 /// use std::fs::File;
283 /// # fn foo() -> std::io::Result<()> {
284 /// let mut f = try!(File::create("foo.txt"));
285 /// try!(f.set_len(10));
289 #[stable(feature = "rust1", since = "1.0.0")]
290 pub fn set_len(&self, size: u64) -> io::Result<()> {
291 self.inner.truncate(size)
294 /// Queries metadata about the underlying file.
299 /// use std::fs::File;
301 /// # fn foo() -> std::io::Result<()> {
302 /// let mut f = try!(File::open("foo.txt"));
303 /// let metadata = try!(f.metadata());
307 #[stable(feature = "rust1", since = "1.0.0")]
308 pub fn metadata(&self) -> io::Result<Metadata> {
309 self.inner.file_attr().map(Metadata)
313 impl AsInner<fs_imp::File> for File {
314 fn as_inner(&self) -> &fs_imp::File { &self.inner }
316 impl FromInner<fs_imp::File> for File {
317 fn from_inner(f: fs_imp::File) -> File {
321 impl IntoInner<fs_imp::File> for File {
322 fn into_inner(self) -> fs_imp::File {
327 #[stable(feature = "rust1", since = "1.0.0")]
328 impl fmt::Debug for File {
329 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
334 #[stable(feature = "rust1", since = "1.0.0")]
336 fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
339 fn read_to_end(&mut self, buf: &mut Vec<u8>) -> io::Result<usize> {
340 unsafe { read_to_end_uninitialized(self, buf) }
343 #[stable(feature = "rust1", since = "1.0.0")]
344 impl Write for File {
345 fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
346 self.inner.write(buf)
348 fn flush(&mut self) -> io::Result<()> { self.inner.flush() }
350 #[stable(feature = "rust1", since = "1.0.0")]
352 fn seek(&mut self, pos: SeekFrom) -> io::Result<u64> {
356 #[stable(feature = "rust1", since = "1.0.0")]
357 impl<'a> Read for &'a File {
358 fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
362 #[stable(feature = "rust1", since = "1.0.0")]
363 impl<'a> Write for &'a File {
364 fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
365 self.inner.write(buf)
367 fn flush(&mut self) -> io::Result<()> { self.inner.flush() }
369 #[stable(feature = "rust1", since = "1.0.0")]
370 impl<'a> Seek for &'a File {
371 fn seek(&mut self, pos: SeekFrom) -> io::Result<u64> {
377 /// Creates a blank net set of options ready for configuration.
379 /// All options are initially set to `false`.
384 /// use std::fs::OpenOptions;
386 /// let file = OpenOptions::new().open("foo.txt");
388 #[stable(feature = "rust1", since = "1.0.0")]
389 pub fn new() -> OpenOptions {
390 OpenOptions(fs_imp::OpenOptions::new())
393 /// Sets the option for read access.
395 /// This option, when true, will indicate that the file should be
396 /// `read`-able if opened.
401 /// use std::fs::OpenOptions;
403 /// let file = OpenOptions::new().read(true).open("foo.txt");
405 #[stable(feature = "rust1", since = "1.0.0")]
406 pub fn read(&mut self, read: bool) -> &mut OpenOptions {
407 self.0.read(read); self
410 /// Sets the option for write access.
412 /// This option, when true, will indicate that the file should be
413 /// `write`-able if opened.
418 /// use std::fs::OpenOptions;
420 /// let file = OpenOptions::new().write(true).open("foo.txt");
422 #[stable(feature = "rust1", since = "1.0.0")]
423 pub fn write(&mut self, write: bool) -> &mut OpenOptions {
424 self.0.write(write); self
427 /// Sets the option for the append mode.
429 /// This option, when true, means that writes will append to a file instead
430 /// of overwriting previous contents.
435 /// use std::fs::OpenOptions;
437 /// let file = OpenOptions::new().write(true).append(true).open("foo.txt");
439 #[stable(feature = "rust1", since = "1.0.0")]
440 pub fn append(&mut self, append: bool) -> &mut OpenOptions {
441 self.0.append(append); self
444 /// Sets the option for truncating a previous file.
446 /// If a file is successfully opened with this option set it will truncate
447 /// the file to 0 length if it already exists.
452 /// use std::fs::OpenOptions;
454 /// let file = OpenOptions::new().write(true).truncate(true).open("foo.txt");
456 #[stable(feature = "rust1", since = "1.0.0")]
457 pub fn truncate(&mut self, truncate: bool) -> &mut OpenOptions {
458 self.0.truncate(truncate); self
461 /// Sets the option for creating a new file.
463 /// This option indicates whether a new file will be created if the file
464 /// does not yet already exist.
469 /// use std::fs::OpenOptions;
471 /// let file = OpenOptions::new().create(true).open("foo.txt");
473 #[stable(feature = "rust1", since = "1.0.0")]
474 pub fn create(&mut self, create: bool) -> &mut OpenOptions {
475 self.0.create(create); self
478 /// Opens a file at `path` with the options specified by `self`.
482 /// This function will return an error under a number of different
483 /// circumstances, to include but not limited to:
485 /// * Opening a file that does not exist with read access.
486 /// * Attempting to open a file with access that the user lacks
488 /// * Filesystem-level errors (full disk, etc)
493 /// use std::fs::OpenOptions;
495 /// let file = OpenOptions::new().open("foo.txt");
497 #[stable(feature = "rust1", since = "1.0.0")]
498 pub fn open<P: AsRef<Path>>(&self, path: P) -> io::Result<File> {
499 self._open(path.as_ref())
502 fn _open(&self, path: &Path) -> io::Result<File> {
503 let inner = try!(fs_imp::File::open(path, &self.0));
504 Ok(File { inner: inner })
508 impl AsInnerMut<fs_imp::OpenOptions> for OpenOptions {
509 fn as_inner_mut(&mut self) -> &mut fs_imp::OpenOptions { &mut self.0 }
513 /// Returns the file type for this metadata.
514 #[stable(feature = "file_type", since = "1.1.0")]
515 pub fn file_type(&self) -> FileType {
516 FileType(self.0.file_type())
519 /// Returns whether this metadata is for a directory.
524 /// # fn foo() -> std::io::Result<()> {
527 /// let metadata = try!(fs::metadata("foo.txt"));
529 /// assert!(!metadata.is_dir());
533 #[stable(feature = "rust1", since = "1.0.0")]
534 pub fn is_dir(&self) -> bool { self.file_type().is_dir() }
536 /// Returns whether this metadata is for a regular file.
541 /// # fn foo() -> std::io::Result<()> {
544 /// let metadata = try!(fs::metadata("foo.txt"));
546 /// assert!(metadata.is_file());
550 #[stable(feature = "rust1", since = "1.0.0")]
551 pub fn is_file(&self) -> bool { self.file_type().is_file() }
553 /// Returns the size of the file, in bytes, this metadata is for.
558 /// # fn foo() -> std::io::Result<()> {
561 /// let metadata = try!(fs::metadata("foo.txt"));
563 /// assert_eq!(0, metadata.len());
567 #[stable(feature = "rust1", since = "1.0.0")]
568 pub fn len(&self) -> u64 { self.0.size() }
570 /// Returns the permissions of the file this metadata is for.
575 /// # fn foo() -> std::io::Result<()> {
578 /// let metadata = try!(fs::metadata("foo.txt"));
580 /// assert!(!metadata.permissions().readonly());
584 #[stable(feature = "rust1", since = "1.0.0")]
585 pub fn permissions(&self) -> Permissions {
586 Permissions(self.0.perm())
590 impl AsInner<fs_imp::FileAttr> for Metadata {
591 fn as_inner(&self) -> &fs_imp::FileAttr { &self.0 }
595 /// Returns whether these permissions describe a readonly file.
600 /// use std::fs::File;
602 /// # fn foo() -> std::io::Result<()> {
603 /// let mut f = try!(File::create("foo.txt"));
604 /// let metadata = try!(f.metadata());
606 /// assert_eq!(false, metadata.permissions().readonly());
610 #[stable(feature = "rust1", since = "1.0.0")]
611 pub fn readonly(&self) -> bool { self.0.readonly() }
613 /// Modifies the readonly flag for this set of permissions.
615 /// This operation does **not** modify the filesystem. To modify the
616 /// filesystem use the `fs::set_permissions` function.
621 /// use std::fs::File;
623 /// # fn foo() -> std::io::Result<()> {
624 /// let f = try!(File::create("foo.txt"));
625 /// let metadata = try!(f.metadata());
626 /// let mut permissions = metadata.permissions();
628 /// permissions.set_readonly(true);
630 /// // filesystem doesn't change
631 /// assert_eq!(false, metadata.permissions().readonly());
633 /// // just this particular `permissions`.
634 /// assert_eq!(true, permissions.readonly());
638 #[stable(feature = "rust1", since = "1.0.0")]
639 pub fn set_readonly(&mut self, readonly: bool) {
640 self.0.set_readonly(readonly)
645 /// Test whether this file type represents a directory.
646 #[stable(feature = "file_type", since = "1.1.0")]
647 pub fn is_dir(&self) -> bool { self.0.is_dir() }
649 /// Test whether this file type represents a regular file.
650 #[stable(feature = "file_type", since = "1.1.0")]
651 pub fn is_file(&self) -> bool { self.0.is_file() }
653 /// Test whether this file type represents a symbolic link.
654 #[stable(feature = "file_type", since = "1.1.0")]
655 pub fn is_symlink(&self) -> bool { self.0.is_symlink() }
658 impl AsInner<fs_imp::FileType> for FileType {
659 fn as_inner(&self) -> &fs_imp::FileType { &self.0 }
662 impl FromInner<fs_imp::FilePermissions> for Permissions {
663 fn from_inner(f: fs_imp::FilePermissions) -> Permissions {
668 impl AsInner<fs_imp::FilePermissions> for Permissions {
669 fn as_inner(&self) -> &fs_imp::FilePermissions { &self.0 }
672 #[stable(feature = "rust1", since = "1.0.0")]
673 impl Iterator for ReadDir {
674 type Item = io::Result<DirEntry>;
676 fn next(&mut self) -> Option<io::Result<DirEntry>> {
677 self.0.next().map(|entry| entry.map(DirEntry))
682 /// Returns the full path to the file that this entry represents.
684 /// The full path is created by joining the original path to `read_dir` or
685 /// `walk_dir` with the filename of this entry.
691 /// # fn foo() -> std::io::Result<()> {
692 /// for entry in try!(fs::read_dir(".")) {
693 /// let dir = try!(entry);
694 /// println!("{:?}", dir.path());
700 /// This prints output like:
705 /// "./hello_world.rs"
708 /// The exact text, of course, depends on what files you have in `.`.
709 #[stable(feature = "rust1", since = "1.0.0")]
710 pub fn path(&self) -> PathBuf { self.0.path() }
712 /// Return the metadata for the file that this entry points at.
714 /// This function will not traverse symlinks if this entry points at a
717 /// # Platform behavior
719 /// On Windows this function is cheap to call (no extra system calls
720 /// needed), but on Unix platforms this function is the equivalent of
721 /// calling `symlink_metadata` on the path.
722 #[stable(feature = "dir_entry_ext", since = "1.1.0")]
723 pub fn metadata(&self) -> io::Result<Metadata> {
724 self.0.metadata().map(Metadata)
727 /// Return the file type for the file that this entry points at.
729 /// This function will not traverse symlinks if this entry points at a
732 /// # Platform behavior
734 /// On Windows and most Unix platforms this function is free (no extra
735 /// system calls needed), but some Unix platforms may require the equivalent
736 /// call to `symlink_metadata` to learn about the target file type.
737 #[stable(feature = "dir_entry_ext", since = "1.1.0")]
738 pub fn file_type(&self) -> io::Result<FileType> {
739 self.0.file_type().map(FileType)
742 /// Returns the bare file name of this directory entry without any other
743 /// leading path component.
744 #[stable(feature = "dir_entry_ext", since = "1.1.0")]
745 pub fn file_name(&self) -> OsString {
750 impl AsInner<fs_imp::DirEntry> for DirEntry {
751 fn as_inner(&self) -> &fs_imp::DirEntry { &self.0 }
754 /// Removes a file from the filesystem.
756 /// Note that there is no
757 /// guarantee that the file is immediately deleted (e.g. depending on
758 /// platform, other open file descriptors may prevent immediate removal).
762 /// This function will return an error if `path` points to a directory, if the
763 /// user lacks permissions to remove the file, or if some other filesystem-level
771 /// # fn foo() -> std::io::Result<()> {
772 /// try!(fs::remove_file("a.txt"));
776 #[stable(feature = "rust1", since = "1.0.0")]
777 pub fn remove_file<P: AsRef<Path>>(path: P) -> io::Result<()> {
778 fs_imp::unlink(path.as_ref())
781 /// Given a path, query the file system to get information about a file,
784 /// This function will traverse symbolic links to query information about the
785 /// destination file.
790 /// # fn foo() -> std::io::Result<()> {
793 /// let attr = try!(fs::metadata("/some/file/path.txt"));
794 /// // inspect attr ...
801 /// This function will return an error if the user lacks the requisite
802 /// permissions to perform a `metadata` call on the given `path` or if there
803 /// is no entry in the filesystem at the provided path.
804 #[stable(feature = "rust1", since = "1.0.0")]
805 pub fn metadata<P: AsRef<Path>>(path: P) -> io::Result<Metadata> {
806 fs_imp::stat(path.as_ref()).map(Metadata)
809 /// Query the metadata about a file without following symlinks.
814 /// # fn foo() -> std::io::Result<()> {
817 /// let attr = try!(fs::symlink_metadata("/some/file/path.txt"));
818 /// // inspect attr ...
822 #[stable(feature = "symlink_metadata", since = "1.1.0")]
823 pub fn symlink_metadata<P: AsRef<Path>>(path: P) -> io::Result<Metadata> {
824 fs_imp::lstat(path.as_ref()).map(Metadata)
827 /// Rename a file or directory to a new name.
829 /// This will not work if the new name is on a different mount point.
833 /// This function will return an error if the provided `from` doesn't exist, if
834 /// the process lacks permissions to view the contents, if `from` and `to`
835 /// reside on separate filesystems, or if some other intermittent I/O error
843 /// # fn foo() -> std::io::Result<()> {
844 /// try!(fs::rename("a.txt", "b.txt"));
848 #[stable(feature = "rust1", since = "1.0.0")]
849 pub fn rename<P: AsRef<Path>, Q: AsRef<Path>>(from: P, to: Q) -> io::Result<()> {
850 fs_imp::rename(from.as_ref(), to.as_ref())
853 /// Copies the contents of one file to another. This function will also
854 /// copy the permission bits of the original file to the destination file.
856 /// This function will **overwrite** the contents of `to`.
858 /// Note that if `from` and `to` both point to the same file, then the file
859 /// will likely get truncated by this operation.
861 /// On success, the total number of bytes copied is returned.
865 /// This function will return an error in the following situations, but is not
866 /// limited to just these cases:
868 /// * The `from` path is not a file
869 /// * The `from` file does not exist
870 /// * The current process does not have the permission rights to access
871 /// `from` or write `to`
878 /// # fn foo() -> std::io::Result<()> {
879 /// try!(fs::copy("foo.txt", "bar.txt"));
882 #[stable(feature = "rust1", since = "1.0.0")]
883 pub fn copy<P: AsRef<Path>, Q: AsRef<Path>>(from: P, to: Q) -> io::Result<u64> {
884 fs_imp::copy(from.as_ref(), to.as_ref())
887 /// Creates a new hard link on the filesystem.
889 /// The `dst` path will be a link pointing to the `src` path. Note that systems
890 /// often require these two paths to both be located on the same filesystem.
897 /// # fn foo() -> std::io::Result<()> {
898 /// try!(fs::hard_link("a.txt", "b.txt"));
902 #[stable(feature = "rust1", since = "1.0.0")]
903 pub fn hard_link<P: AsRef<Path>, Q: AsRef<Path>>(src: P, dst: Q) -> io::Result<()> {
904 fs_imp::link(src.as_ref(), dst.as_ref())
907 /// Creates a new symbolic link on the filesystem.
909 /// The `dst` path will be a symbolic link pointing to the `src` path.
910 /// On Windows, this will be a file symlink, not a directory symlink;
911 /// for this reason, the platform-specific `std::os::unix::fs::symlink`
912 /// and `std::os::windows::fs::{symlink_file, symlink_dir}` should be
913 /// used instead to make the intent explicit.
920 /// # fn foo() -> std::io::Result<()> {
921 /// try!(fs::soft_link("a.txt", "b.txt"));
925 #[rustc_deprecated(since = "1.1.0",
926 reason = "replaced with std::os::unix::fs::symlink and \
927 std::os::windows::fs::{symlink_file, symlink_dir}")]
928 #[stable(feature = "rust1", since = "1.0.0")]
929 pub fn soft_link<P: AsRef<Path>, Q: AsRef<Path>>(src: P, dst: Q) -> io::Result<()> {
930 fs_imp::symlink(src.as_ref(), dst.as_ref())
933 /// Reads a symbolic link, returning the file that the link points to.
937 /// This function will return an error on failure. Failure conditions include
938 /// reading a file that does not exist or reading a file that is not a symbolic
946 /// # fn foo() -> std::io::Result<()> {
947 /// let path = try!(fs::read_link("a.txt"));
951 #[stable(feature = "rust1", since = "1.0.0")]
952 pub fn read_link<P: AsRef<Path>>(path: P) -> io::Result<PathBuf> {
953 fs_imp::readlink(path.as_ref())
956 /// Returns the canonical form of a path with all intermediate components
957 /// normalized and symbolic links resolved.
959 /// This function may return an error in situations like where the path does not
960 /// exist, a component in the path is not a directory, or an I/O error happens.
967 /// # fn foo() -> std::io::Result<()> {
968 /// let path = try!(fs::canonicalize("../a/../foo.txt"));
972 #[stable(feature = "fs_canonicalize", since = "1.5.0")]
973 pub fn canonicalize<P: AsRef<Path>>(path: P) -> io::Result<PathBuf> {
974 fs_imp::canonicalize(path.as_ref())
977 /// Creates a new, empty directory at the provided path
981 /// This function will return an error if the user lacks permissions to make a
982 /// new directory at the provided `path`, or if the directory already exists.
989 /// # fn foo() -> std::io::Result<()> {
990 /// try!(fs::create_dir("/some/dir"));
994 #[stable(feature = "rust1", since = "1.0.0")]
995 pub fn create_dir<P: AsRef<Path>>(path: P) -> io::Result<()> {
996 DirBuilder::new().create(path.as_ref())
999 /// Recursively create a directory and all of its parent components if they
1004 /// This function will fail if any directory in the path specified by `path`
1005 /// does not already exist and it could not be created otherwise. The specific
1006 /// error conditions for when a directory is being created (after it is
1007 /// determined to not exist) are outlined by `fs::create_dir`.
1014 /// # fn foo() -> std::io::Result<()> {
1015 /// try!(fs::create_dir_all("/some/dir"));
1019 #[stable(feature = "rust1", since = "1.0.0")]
1020 pub fn create_dir_all<P: AsRef<Path>>(path: P) -> io::Result<()> {
1021 DirBuilder::new().recursive(true).create(path.as_ref())
1024 /// Removes an existing, empty directory.
1028 /// This function will return an error if the user lacks permissions to remove
1029 /// the directory at the provided `path`, or if the directory isn't empty.
1036 /// # fn foo() -> std::io::Result<()> {
1037 /// try!(fs::remove_dir("/some/dir"));
1041 #[stable(feature = "rust1", since = "1.0.0")]
1042 pub fn remove_dir<P: AsRef<Path>>(path: P) -> io::Result<()> {
1043 fs_imp::rmdir(path.as_ref())
1046 /// Removes a directory at this path, after removing all its contents. Use
1049 /// This function does **not** follow symbolic links and it will simply remove the
1050 /// symbolic link itself.
1054 /// See `file::remove_file` and `fs::remove_dir`.
1061 /// # fn foo() -> std::io::Result<()> {
1062 /// try!(fs::remove_dir_all("/some/dir"));
1066 #[stable(feature = "rust1", since = "1.0.0")]
1067 pub fn remove_dir_all<P: AsRef<Path>>(path: P) -> io::Result<()> {
1068 _remove_dir_all(path.as_ref())
1071 fn _remove_dir_all(path: &Path) -> io::Result<()> {
1072 for child in try!(read_dir(path)) {
1073 let child = try!(child).path();
1074 let stat = try!(symlink_metadata(&*child));
1076 try!(remove_dir_all(&*child));
1078 try!(remove_file(&*child));
1084 /// Returns an iterator over the entries within a directory.
1086 /// The iterator will yield instances of `io::Result<DirEntry>`. New errors may
1087 /// be encountered after an iterator is initially constructed.
1093 /// use std::fs::{self, DirEntry};
1094 /// use std::path::Path;
1096 /// // one possible implementation of fs::walk_dir only visiting files
1097 /// fn visit_dirs(dir: &Path, cb: &Fn(&DirEntry)) -> io::Result<()> {
1098 /// if try!(fs::metadata(dir)).is_dir() {
1099 /// for entry in try!(fs::read_dir(dir)) {
1100 /// let entry = try!(entry);
1101 /// if try!(fs::metadata(entry.path())).is_dir() {
1102 /// try!(visit_dirs(&entry.path(), cb));
1114 /// This function will return an error if the provided `path` doesn't exist, if
1115 /// the process lacks permissions to view the contents or if the `path` points
1116 /// at a non-directory file
1117 #[stable(feature = "rust1", since = "1.0.0")]
1118 pub fn read_dir<P: AsRef<Path>>(path: P) -> io::Result<ReadDir> {
1119 fs_imp::readdir(path.as_ref()).map(ReadDir)
1122 /// Returns an iterator that will recursively walk the directory structure
1123 /// rooted at `path`.
1125 /// The path given will not be iterated over, and this will perform iteration in
1126 /// some top-down order. The contents of unreadable subdirectories are ignored.
1128 /// The iterator will yield instances of `io::Result<DirEntry>`. New errors may
1129 /// be encountered after an iterator is initially constructed.
1130 #[unstable(feature = "fs_walk",
1131 reason = "the precise semantics and defaults for a recursive walk \
1132 may change and this may end up accounting for files such \
1133 as symlinks differently",
1135 pub fn walk_dir<P: AsRef<Path>>(path: P) -> io::Result<WalkDir> {
1136 _walk_dir(path.as_ref())
1139 fn _walk_dir(path: &Path) -> io::Result<WalkDir> {
1140 let start = try!(read_dir(path));
1141 Ok(WalkDir { cur: Some(start), stack: Vec::new() })
1144 #[unstable(feature = "fs_walk", issue = "27707")]
1145 impl Iterator for WalkDir {
1146 type Item = io::Result<DirEntry>;
1148 fn next(&mut self) -> Option<io::Result<DirEntry>> {
1150 if let Some(ref mut cur) = self.cur {
1152 Some(Err(e)) => return Some(Err(e)),
1154 let path = next.path();
1156 self.stack.push(read_dir(&*path));
1158 return Some(Ok(next))
1164 match self.stack.pop() {
1165 Some(Err(e)) => return Some(Err(e)),
1166 Some(Ok(next)) => self.cur = Some(next),
1167 None => return None,
1173 /// Utility methods for paths.
1174 #[unstable(feature = "path_ext_deprecated",
1175 reason = "The precise set of methods exposed on this trait may \
1176 change and some methods may be removed. For stable code, \
1177 see the std::fs::metadata function.",
1179 #[rustc_deprecated(since = "1.5.0", reason = "replaced with inherent methods")]
1181 /// Gets information on the file, directory, etc at this path.
1183 /// Consult the `fs::metadata` documentation for more info.
1185 /// This call preserves identical runtime/error semantics with
1187 fn metadata(&self) -> io::Result<Metadata>;
1189 /// Gets information on the file, directory, etc at this path.
1191 /// Consult the `fs::symlink_metadata` documentation for more info.
1193 /// This call preserves identical runtime/error semantics with
1194 /// `fs::symlink_metadata`.
1195 fn symlink_metadata(&self) -> io::Result<Metadata>;
1197 /// Returns the canonical form of a path, normalizing all components and
1198 /// eliminate all symlinks.
1200 /// This call preserves identical runtime/error semantics with
1201 /// `fs::canonicalize`.
1202 fn canonicalize(&self) -> io::Result<PathBuf>;
1204 /// Reads the symlink at this path.
1206 /// For more information see `fs::read_link`.
1207 fn read_link(&self) -> io::Result<PathBuf>;
1209 /// Reads the directory at this path.
1211 /// For more information see `fs::read_dir`.
1212 fn read_dir(&self) -> io::Result<ReadDir>;
1214 /// Boolean value indicator whether the underlying file exists on the local
1215 /// filesystem. Returns false in exactly the cases where `fs::metadata`
1217 fn exists(&self) -> bool;
1219 /// Whether the underlying implementation (be it a file path, or something
1220 /// else) points at a "regular file" on the FS. Will return false for paths
1221 /// to non-existent locations or directories or other non-regular files
1222 /// (named pipes, etc). Follows links when making this determination.
1223 fn is_file(&self) -> bool;
1225 /// Whether the underlying implementation (be it a file path, or something
1226 /// else) is pointing at a directory in the underlying FS. Will return
1227 /// false for paths to non-existent locations or if the item is not a
1228 /// directory (eg files, named pipes, etc). Follows links when making this
1230 fn is_dir(&self) -> bool;
1233 #[allow(deprecated)]
1234 #[unstable(feature = "path_ext_deprecated", issue = "27725")]
1235 impl PathExt for Path {
1236 fn metadata(&self) -> io::Result<Metadata> { metadata(self) }
1237 fn symlink_metadata(&self) -> io::Result<Metadata> { symlink_metadata(self) }
1238 fn canonicalize(&self) -> io::Result<PathBuf> { canonicalize(self) }
1239 fn read_link(&self) -> io::Result<PathBuf> { read_link(self) }
1240 fn read_dir(&self) -> io::Result<ReadDir> { read_dir(self) }
1241 fn exists(&self) -> bool { metadata(self).is_ok() }
1243 fn is_file(&self) -> bool {
1244 metadata(self).map(|s| s.is_file()).unwrap_or(false)
1247 fn is_dir(&self) -> bool {
1248 metadata(self).map(|s| s.is_dir()).unwrap_or(false)
1252 /// Changes the permissions found on a file or a directory.
1257 /// # fn foo() -> std::io::Result<()> {
1260 /// let mut perms = try!(fs::metadata("foo.txt")).permissions();
1261 /// perms.set_readonly(true);
1262 /// try!(fs::set_permissions("foo.txt", perms));
1269 /// This function will return an error if the provided `path` doesn't exist, if
1270 /// the process lacks permissions to change the attributes of the file, or if
1271 /// some other I/O error is encountered.
1272 #[stable(feature = "set_permissions", since = "1.1.0")]
1273 pub fn set_permissions<P: AsRef<Path>>(path: P, perm: Permissions)
1275 fs_imp::set_perm(path.as_ref(), perm.0)
1278 #[unstable(feature = "dir_builder", reason = "recently added API",
1281 /// Creates a new set of options with default mode/security settings for all
1282 /// platforms and also non-recursive.
1283 pub fn new() -> DirBuilder {
1285 inner: fs_imp::DirBuilder::new(),
1290 /// Indicate that directories create should be created recursively, creating
1291 /// all parent directories if they do not exist with the same security and
1292 /// permissions settings.
1294 /// This option defaults to `false`
1295 pub fn recursive(&mut self, recursive: bool) -> &mut Self {
1296 self.recursive = recursive;
1300 /// Create the specified directory with the options configured in this
1302 pub fn create<P: AsRef<Path>>(&self, path: P) -> io::Result<()> {
1303 self._create(path.as_ref())
1306 fn _create(&self, path: &Path) -> io::Result<()> {
1308 self.create_dir_all(path)
1310 self.inner.mkdir(path)
1314 fn create_dir_all(&self, path: &Path) -> io::Result<()> {
1315 if path == Path::new("") || path.is_dir() { return Ok(()) }
1316 if let Some(p) = path.parent() {
1317 try!(self.create_dir_all(p))
1319 self.inner.mkdir(path)
1323 impl AsInnerMut<fs_imp::DirBuilder> for DirBuilder {
1324 fn as_inner_mut(&mut self) -> &mut fs_imp::DirBuilder {
1331 #![allow(deprecated)] //rand
1337 use fs::{self, File, OpenOptions};
1338 use io::{ErrorKind, SeekFrom};
1340 use path::Path as Path2;
1342 use rand::{self, StdRng, Rng};
1345 macro_rules! check { ($e:expr) => (
1348 Err(e) => panic!("{} failed with: {}", stringify!($e), e),
1352 macro_rules! error { ($e:expr, $s:expr) => (
1354 Ok(_) => panic!("Unexpected success. Should've been: {:?}", $s),
1355 Err(ref err) => assert!(err.to_string().contains($s),
1356 format!("`{}` did not contain `{}`", err, $s))
1360 pub struct TempDir(PathBuf);
1363 fn join(&self, path: &str) -> PathBuf {
1364 let TempDir(ref p) = *self;
1368 fn path<'a>(&'a self) -> &'a Path2 {
1369 let TempDir(ref p) = *self;
1374 impl Drop for TempDir {
1375 fn drop(&mut self) {
1376 // Gee, seeing how we're testing the fs module I sure hope that we
1377 // at least implement this correctly!
1378 let TempDir(ref p) = *self;
1379 check!(fs::remove_dir_all(p));
1383 pub fn tmpdir() -> TempDir {
1384 let p = env::temp_dir();
1385 let mut r = rand::thread_rng();
1386 let ret = p.join(&format!("rust-{}", r.next_u32()));
1387 check!(fs::create_dir(&ret));
1392 fn file_test_io_smoke_test() {
1393 let message = "it's alright. have a good time";
1394 let tmpdir = tmpdir();
1395 let filename = &tmpdir.join("file_rt_io_file_test.txt");
1397 let mut write_stream = check!(File::create(filename));
1398 check!(write_stream.write(message.as_bytes()));
1401 let mut read_stream = check!(File::open(filename));
1402 let mut read_buf = [0; 1028];
1403 let read_str = match check!(read_stream.read(&mut read_buf)) {
1404 0 => panic!("shouldn't happen"),
1405 n => str::from_utf8(&read_buf[..n]).unwrap().to_string()
1407 assert_eq!(read_str, message);
1409 check!(fs::remove_file(filename));
1413 fn invalid_path_raises() {
1414 let tmpdir = tmpdir();
1415 let filename = &tmpdir.join("file_that_does_not_exist.txt");
1416 let result = File::open(filename);
1419 error!(result, "o such file or directory");
1421 // error!(result, "couldn't open path as file");
1422 // error!(result, format!("path={}; mode=open; access=read", filename.display()));
1426 fn file_test_iounlinking_invalid_path_should_raise_condition() {
1427 let tmpdir = tmpdir();
1428 let filename = &tmpdir.join("file_another_file_that_does_not_exist.txt");
1430 let result = fs::remove_file(filename);
1433 error!(result, "o such file or directory");
1435 // error!(result, "couldn't unlink path");
1436 // error!(result, format!("path={}", filename.display()));
1440 fn file_test_io_non_positional_read() {
1441 let message: &str = "ten-four";
1442 let mut read_mem = [0; 8];
1443 let tmpdir = tmpdir();
1444 let filename = &tmpdir.join("file_rt_io_file_test_positional.txt");
1446 let mut rw_stream = check!(File::create(filename));
1447 check!(rw_stream.write(message.as_bytes()));
1450 let mut read_stream = check!(File::open(filename));
1452 let read_buf = &mut read_mem[0..4];
1453 check!(read_stream.read(read_buf));
1456 let read_buf = &mut read_mem[4..8];
1457 check!(read_stream.read(read_buf));
1460 check!(fs::remove_file(filename));
1461 let read_str = str::from_utf8(&read_mem).unwrap();
1462 assert_eq!(read_str, message);
1466 fn file_test_io_seek_and_tell_smoke_test() {
1467 let message = "ten-four";
1468 let mut read_mem = [0; 4];
1469 let set_cursor = 4 as u64;
1470 let mut tell_pos_pre_read;
1471 let mut tell_pos_post_read;
1472 let tmpdir = tmpdir();
1473 let filename = &tmpdir.join("file_rt_io_file_test_seeking.txt");
1475 let mut rw_stream = check!(File::create(filename));
1476 check!(rw_stream.write(message.as_bytes()));
1479 let mut read_stream = check!(File::open(filename));
1480 check!(read_stream.seek(SeekFrom::Start(set_cursor)));
1481 tell_pos_pre_read = check!(read_stream.seek(SeekFrom::Current(0)));
1482 check!(read_stream.read(&mut read_mem));
1483 tell_pos_post_read = check!(read_stream.seek(SeekFrom::Current(0)));
1485 check!(fs::remove_file(filename));
1486 let read_str = str::from_utf8(&read_mem).unwrap();
1487 assert_eq!(read_str, &message[4..8]);
1488 assert_eq!(tell_pos_pre_read, set_cursor);
1489 assert_eq!(tell_pos_post_read, message.len() as u64);
1493 fn file_test_io_seek_and_write() {
1494 let initial_msg = "food-is-yummy";
1495 let overwrite_msg = "-the-bar!!";
1496 let final_msg = "foo-the-bar!!";
1498 let mut read_mem = [0; 13];
1499 let tmpdir = tmpdir();
1500 let filename = &tmpdir.join("file_rt_io_file_test_seek_and_write.txt");
1502 let mut rw_stream = check!(File::create(filename));
1503 check!(rw_stream.write(initial_msg.as_bytes()));
1504 check!(rw_stream.seek(SeekFrom::Start(seek_idx)));
1505 check!(rw_stream.write(overwrite_msg.as_bytes()));
1508 let mut read_stream = check!(File::open(filename));
1509 check!(read_stream.read(&mut read_mem));
1511 check!(fs::remove_file(filename));
1512 let read_str = str::from_utf8(&read_mem).unwrap();
1513 assert!(read_str == final_msg);
1517 fn file_test_io_seek_shakedown() {
1519 let initial_msg = "qwer-asdf-zxcv";
1520 let chunk_one: &str = "qwer";
1521 let chunk_two: &str = "asdf";
1522 let chunk_three: &str = "zxcv";
1523 let mut read_mem = [0; 4];
1524 let tmpdir = tmpdir();
1525 let filename = &tmpdir.join("file_rt_io_file_test_seek_shakedown.txt");
1527 let mut rw_stream = check!(File::create(filename));
1528 check!(rw_stream.write(initial_msg.as_bytes()));
1531 let mut read_stream = check!(File::open(filename));
1533 check!(read_stream.seek(SeekFrom::End(-4)));
1534 check!(read_stream.read(&mut read_mem));
1535 assert_eq!(str::from_utf8(&read_mem).unwrap(), chunk_three);
1537 check!(read_stream.seek(SeekFrom::Current(-9)));
1538 check!(read_stream.read(&mut read_mem));
1539 assert_eq!(str::from_utf8(&read_mem).unwrap(), chunk_two);
1541 check!(read_stream.seek(SeekFrom::Start(0)));
1542 check!(read_stream.read(&mut read_mem));
1543 assert_eq!(str::from_utf8(&read_mem).unwrap(), chunk_one);
1545 check!(fs::remove_file(filename));
1549 fn file_test_stat_is_correct_on_is_file() {
1550 let tmpdir = tmpdir();
1551 let filename = &tmpdir.join("file_stat_correct_on_is_file.txt");
1553 let mut opts = OpenOptions::new();
1554 let mut fs = check!(opts.read(true).write(true)
1555 .create(true).open(filename));
1557 fs.write(msg.as_bytes()).unwrap();
1559 let fstat_res = check!(fs.metadata());
1560 assert!(fstat_res.is_file());
1562 let stat_res_fn = check!(fs::metadata(filename));
1563 assert!(stat_res_fn.is_file());
1564 let stat_res_meth = check!(filename.metadata());
1565 assert!(stat_res_meth.is_file());
1566 check!(fs::remove_file(filename));
1570 fn file_test_stat_is_correct_on_is_dir() {
1571 let tmpdir = tmpdir();
1572 let filename = &tmpdir.join("file_stat_correct_on_is_dir");
1573 check!(fs::create_dir(filename));
1574 let stat_res_fn = check!(fs::metadata(filename));
1575 assert!(stat_res_fn.is_dir());
1576 let stat_res_meth = check!(filename.metadata());
1577 assert!(stat_res_meth.is_dir());
1578 check!(fs::remove_dir(filename));
1582 fn file_test_fileinfo_false_when_checking_is_file_on_a_directory() {
1583 let tmpdir = tmpdir();
1584 let dir = &tmpdir.join("fileinfo_false_on_dir");
1585 check!(fs::create_dir(dir));
1586 assert!(dir.is_file() == false);
1587 check!(fs::remove_dir(dir));
1591 fn file_test_fileinfo_check_exists_before_and_after_file_creation() {
1592 let tmpdir = tmpdir();
1593 let file = &tmpdir.join("fileinfo_check_exists_b_and_a.txt");
1594 check!(check!(File::create(file)).write(b"foo"));
1595 assert!(file.exists());
1596 check!(fs::remove_file(file));
1597 assert!(!file.exists());
1601 fn file_test_directoryinfo_check_exists_before_and_after_mkdir() {
1602 let tmpdir = tmpdir();
1603 let dir = &tmpdir.join("before_and_after_dir");
1604 assert!(!dir.exists());
1605 check!(fs::create_dir(dir));
1606 assert!(dir.exists());
1607 assert!(dir.is_dir());
1608 check!(fs::remove_dir(dir));
1609 assert!(!dir.exists());
1613 fn file_test_directoryinfo_readdir() {
1614 let tmpdir = tmpdir();
1615 let dir = &tmpdir.join("di_readdir");
1616 check!(fs::create_dir(dir));
1619 let f = dir.join(&format!("{}.txt", n));
1620 let mut w = check!(File::create(&f));
1621 let msg_str = format!("{}{}", prefix, n.to_string());
1622 let msg = msg_str.as_bytes();
1623 check!(w.write(msg));
1625 let files = check!(fs::read_dir(dir));
1626 let mut mem = [0; 4];
1628 let f = f.unwrap().path();
1630 let n = f.file_stem().unwrap();
1631 check!(check!(File::open(&f)).read(&mut mem));
1632 let read_str = str::from_utf8(&mem).unwrap();
1633 let expected = format!("{}{}", prefix, n.to_str().unwrap());
1634 assert_eq!(expected, read_str);
1636 check!(fs::remove_file(&f));
1638 check!(fs::remove_dir(dir));
1642 fn file_test_walk_dir() {
1643 let tmpdir = tmpdir();
1644 let dir = &tmpdir.join("walk_dir");
1645 check!(fs::create_dir(dir));
1647 let dir1 = &dir.join("01/02/03");
1648 check!(fs::create_dir_all(dir1));
1649 check!(File::create(&dir1.join("04")));
1651 let dir2 = &dir.join("11/12/13");
1652 check!(fs::create_dir_all(dir2));
1653 check!(File::create(&dir2.join("14")));
1655 let files = check!(fs::walk_dir(dir));
1656 let mut cur = [0; 2];
1658 let f = f.unwrap().path();
1659 let stem = f.file_stem().unwrap().to_str().unwrap();
1660 let root = stem.as_bytes()[0] - b'0';
1661 let name = stem.as_bytes()[1] - b'0';
1662 assert!(cur[root as usize] < name);
1663 cur[root as usize] = name;
1666 check!(fs::remove_dir_all(dir));
1670 fn mkdir_path_already_exists_error() {
1671 let tmpdir = tmpdir();
1672 let dir = &tmpdir.join("mkdir_error_twice");
1673 check!(fs::create_dir(dir));
1674 let e = fs::create_dir(dir).err().unwrap();
1675 assert_eq!(e.kind(), ErrorKind::AlreadyExists);
1679 fn recursive_mkdir() {
1680 let tmpdir = tmpdir();
1681 let dir = tmpdir.join("d1/d2");
1682 check!(fs::create_dir_all(&dir));
1683 assert!(dir.is_dir())
1687 fn recursive_mkdir_failure() {
1688 let tmpdir = tmpdir();
1689 let dir = tmpdir.join("d1");
1690 let file = dir.join("f1");
1692 check!(fs::create_dir_all(&dir));
1693 check!(File::create(&file));
1695 let result = fs::create_dir_all(&file);
1697 assert!(result.is_err());
1698 // error!(result, "couldn't recursively mkdir");
1699 // error!(result, "couldn't create directory");
1700 // error!(result, "mode=0700");
1701 // error!(result, format!("path={}", file.display()));
1705 fn recursive_mkdir_slash() {
1706 check!(fs::create_dir_all(&Path2::new("/")));
1709 // FIXME(#12795) depends on lstat to work on windows
1710 #[cfg(not(windows))]
1712 fn recursive_rmdir() {
1713 let tmpdir = tmpdir();
1714 let d1 = tmpdir.join("d1");
1715 let dt = d1.join("t");
1716 let dtt = dt.join("t");
1717 let d2 = tmpdir.join("d2");
1718 let canary = d2.join("do_not_delete");
1719 check!(fs::create_dir_all(&dtt));
1720 check!(fs::create_dir_all(&d2));
1721 check!(check!(File::create(&canary)).write(b"foo"));
1722 check!(fs::soft_link(&d2, &dt.join("d2")));
1723 check!(fs::remove_dir_all(&d1));
1725 assert!(!d1.is_dir());
1726 assert!(canary.exists());
1730 fn unicode_path_is_dir() {
1731 assert!(Path2::new(".").is_dir());
1732 assert!(!Path2::new("test/stdtest/fs.rs").is_dir());
1734 let tmpdir = tmpdir();
1736 let mut dirpath = tmpdir.path().to_path_buf();
1737 dirpath.push("test-가一ー你好");
1738 check!(fs::create_dir(&dirpath));
1739 assert!(dirpath.is_dir());
1741 let mut filepath = dirpath;
1742 filepath.push("unicode-file-\u{ac00}\u{4e00}\u{30fc}\u{4f60}\u{597d}.rs");
1743 check!(File::create(&filepath)); // ignore return; touch only
1744 assert!(!filepath.is_dir());
1745 assert!(filepath.exists());
1749 fn unicode_path_exists() {
1750 assert!(Path2::new(".").exists());
1751 assert!(!Path2::new("test/nonexistent-bogus-path").exists());
1753 let tmpdir = tmpdir();
1754 let unicode = tmpdir.path();
1755 let unicode = unicode.join(&format!("test-각丁ー再见"));
1756 check!(fs::create_dir(&unicode));
1757 assert!(unicode.exists());
1758 assert!(!Path2::new("test/unicode-bogus-path-각丁ー再见").exists());
1762 fn copy_file_does_not_exist() {
1763 let from = Path2::new("test/nonexistent-bogus-path");
1764 let to = Path2::new("test/other-bogus-path");
1766 match fs::copy(&from, &to) {
1769 assert!(!from.exists());
1770 assert!(!to.exists());
1776 fn copy_src_does_not_exist() {
1777 let tmpdir = tmpdir();
1778 let from = Path2::new("test/nonexistent-bogus-path");
1779 let to = tmpdir.join("out.txt");
1780 check!(check!(File::create(&to)).write(b"hello"));
1781 assert!(fs::copy(&from, &to).is_err());
1782 assert!(!from.exists());
1783 let mut v = Vec::new();
1784 check!(check!(File::open(&to)).read_to_end(&mut v));
1785 assert_eq!(v, b"hello");
1790 let tmpdir = tmpdir();
1791 let input = tmpdir.join("in.txt");
1792 let out = tmpdir.join("out.txt");
1794 check!(check!(File::create(&input)).write(b"hello"));
1795 check!(fs::copy(&input, &out));
1796 let mut v = Vec::new();
1797 check!(check!(File::open(&out)).read_to_end(&mut v));
1798 assert_eq!(v, b"hello");
1800 assert_eq!(check!(input.metadata()).permissions(),
1801 check!(out.metadata()).permissions());
1805 fn copy_file_dst_dir() {
1806 let tmpdir = tmpdir();
1807 let out = tmpdir.join("out");
1809 check!(File::create(&out));
1810 match fs::copy(&*out, tmpdir.path()) {
1811 Ok(..) => panic!(), Err(..) => {}
1816 fn copy_file_dst_exists() {
1817 let tmpdir = tmpdir();
1818 let input = tmpdir.join("in");
1819 let output = tmpdir.join("out");
1821 check!(check!(File::create(&input)).write("foo".as_bytes()));
1822 check!(check!(File::create(&output)).write("bar".as_bytes()));
1823 check!(fs::copy(&input, &output));
1825 let mut v = Vec::new();
1826 check!(check!(File::open(&output)).read_to_end(&mut v));
1827 assert_eq!(v, b"foo".to_vec());
1831 fn copy_file_src_dir() {
1832 let tmpdir = tmpdir();
1833 let out = tmpdir.join("out");
1835 match fs::copy(tmpdir.path(), &out) {
1836 Ok(..) => panic!(), Err(..) => {}
1838 assert!(!out.exists());
1842 fn copy_file_preserves_perm_bits() {
1843 let tmpdir = tmpdir();
1844 let input = tmpdir.join("in.txt");
1845 let out = tmpdir.join("out.txt");
1847 let attr = check!(check!(File::create(&input)).metadata());
1848 let mut p = attr.permissions();
1849 p.set_readonly(true);
1850 check!(fs::set_permissions(&input, p));
1851 check!(fs::copy(&input, &out));
1852 assert!(check!(out.metadata()).permissions().readonly());
1853 check!(fs::set_permissions(&input, attr.permissions()));
1854 check!(fs::set_permissions(&out, attr.permissions()));
1859 fn copy_file_preserves_streams() {
1861 check!(check!(File::create(tmp.join("in.txt:bunny"))).write("carrot".as_bytes()));
1862 assert_eq!(check!(fs::copy(tmp.join("in.txt"), tmp.join("out.txt"))), 6);
1863 assert_eq!(check!(tmp.join("out.txt").metadata()).len(), 0);
1864 let mut v = Vec::new();
1865 check!(check!(File::open(tmp.join("out.txt:bunny"))).read_to_end(&mut v));
1866 assert_eq!(v, b"carrot".to_vec());
1869 #[cfg(not(windows))] // FIXME(#10264) operation not permitted?
1871 fn symlinks_work() {
1872 let tmpdir = tmpdir();
1873 let input = tmpdir.join("in.txt");
1874 let out = tmpdir.join("out.txt");
1876 check!(check!(File::create(&input)).write("foobar".as_bytes()));
1877 check!(fs::soft_link(&input, &out));
1878 // if cfg!(not(windows)) {
1879 // assert_eq!(check!(lstat(&out)).kind, FileType::Symlink);
1880 // assert_eq!(check!(out.lstat()).kind, FileType::Symlink);
1882 assert_eq!(check!(fs::metadata(&out)).len(),
1883 check!(fs::metadata(&input)).len());
1884 let mut v = Vec::new();
1885 check!(check!(File::open(&out)).read_to_end(&mut v));
1886 assert_eq!(v, b"foobar".to_vec());
1889 #[cfg(not(windows))] // apparently windows doesn't like symlinks
1891 fn symlink_noexist() {
1892 let tmpdir = tmpdir();
1893 // symlinks can point to things that don't exist
1894 check!(fs::soft_link(&tmpdir.join("foo"), &tmpdir.join("bar")));
1895 assert_eq!(check!(fs::read_link(&tmpdir.join("bar"))),
1896 tmpdir.join("foo"));
1900 fn readlink_not_symlink() {
1901 let tmpdir = tmpdir();
1902 match fs::read_link(tmpdir.path()) {
1903 Ok(..) => panic!("wanted a failure"),
1910 let tmpdir = tmpdir();
1911 let input = tmpdir.join("in.txt");
1912 let out = tmpdir.join("out.txt");
1914 check!(check!(File::create(&input)).write("foobar".as_bytes()));
1915 check!(fs::hard_link(&input, &out));
1916 assert_eq!(check!(fs::metadata(&out)).len(),
1917 check!(fs::metadata(&input)).len());
1918 assert_eq!(check!(fs::metadata(&out)).len(),
1919 check!(input.metadata()).len());
1920 let mut v = Vec::new();
1921 check!(check!(File::open(&out)).read_to_end(&mut v));
1922 assert_eq!(v, b"foobar".to_vec());
1924 // can't link to yourself
1925 match fs::hard_link(&input, &input) {
1926 Ok(..) => panic!("wanted a failure"),
1929 // can't link to something that doesn't exist
1930 match fs::hard_link(&tmpdir.join("foo"), &tmpdir.join("bar")) {
1931 Ok(..) => panic!("wanted a failure"),
1938 let tmpdir = tmpdir();
1939 let file = tmpdir.join("in.txt");
1941 check!(File::create(&file));
1942 let attr = check!(fs::metadata(&file));
1943 assert!(!attr.permissions().readonly());
1944 let mut p = attr.permissions();
1945 p.set_readonly(true);
1946 check!(fs::set_permissions(&file, p.clone()));
1947 let attr = check!(fs::metadata(&file));
1948 assert!(attr.permissions().readonly());
1950 match fs::set_permissions(&tmpdir.join("foo"), p.clone()) {
1951 Ok(..) => panic!("wanted an error"),
1955 p.set_readonly(false);
1956 check!(fs::set_permissions(&file, p));
1960 fn sync_doesnt_kill_anything() {
1961 let tmpdir = tmpdir();
1962 let path = tmpdir.join("in.txt");
1964 let mut file = check!(File::create(&path));
1965 check!(file.sync_all());
1966 check!(file.sync_data());
1967 check!(file.write(b"foo"));
1968 check!(file.sync_all());
1969 check!(file.sync_data());
1973 fn truncate_works() {
1974 let tmpdir = tmpdir();
1975 let path = tmpdir.join("in.txt");
1977 let mut file = check!(File::create(&path));
1978 check!(file.write(b"foo"));
1979 check!(file.sync_all());
1981 // Do some simple things with truncation
1982 assert_eq!(check!(file.metadata()).len(), 3);
1983 check!(file.set_len(10));
1984 assert_eq!(check!(file.metadata()).len(), 10);
1985 check!(file.write(b"bar"));
1986 check!(file.sync_all());
1987 assert_eq!(check!(file.metadata()).len(), 10);
1989 let mut v = Vec::new();
1990 check!(check!(File::open(&path)).read_to_end(&mut v));
1991 assert_eq!(v, b"foobar\0\0\0\0".to_vec());
1993 // Truncate to a smaller length, don't seek, and then write something.
1994 // Ensure that the intermediate zeroes are all filled in (we have `seek`ed
1995 // past the end of the file).
1996 check!(file.set_len(2));
1997 assert_eq!(check!(file.metadata()).len(), 2);
1998 check!(file.write(b"wut"));
1999 check!(file.sync_all());
2000 assert_eq!(check!(file.metadata()).len(), 9);
2001 let mut v = Vec::new();
2002 check!(check!(File::open(&path)).read_to_end(&mut v));
2003 assert_eq!(v, b"fo\0\0\0\0wut".to_vec());
2008 use fs::OpenOptions as OO;
2009 fn c<T: Clone>(t: &T) -> T { t.clone() }
2011 let tmpdir = tmpdir();
2013 let mut r = OO::new(); r.read(true);
2014 let mut w = OO::new(); w.write(true);
2015 let mut rw = OO::new(); rw.write(true).read(true);
2017 match r.open(&tmpdir.join("a")) {
2018 Ok(..) => panic!(), Err(..) => {}
2021 // Perform each one twice to make sure that it succeeds the second time
2022 // (where the file exists)
2023 check!(c(&w).create(true).open(&tmpdir.join("b")));
2024 assert!(tmpdir.join("b").exists());
2025 check!(c(&w).create(true).open(&tmpdir.join("b")));
2026 check!(w.open(&tmpdir.join("b")));
2028 check!(c(&rw).create(true).open(&tmpdir.join("c")));
2029 assert!(tmpdir.join("c").exists());
2030 check!(c(&rw).create(true).open(&tmpdir.join("c")));
2031 check!(rw.open(&tmpdir.join("c")));
2033 check!(c(&w).append(true).create(true).open(&tmpdir.join("d")));
2034 assert!(tmpdir.join("d").exists());
2035 check!(c(&w).append(true).create(true).open(&tmpdir.join("d")));
2036 check!(c(&w).append(true).open(&tmpdir.join("d")));
2038 check!(c(&rw).append(true).create(true).open(&tmpdir.join("e")));
2039 assert!(tmpdir.join("e").exists());
2040 check!(c(&rw).append(true).create(true).open(&tmpdir.join("e")));
2041 check!(c(&rw).append(true).open(&tmpdir.join("e")));
2043 check!(c(&w).truncate(true).create(true).open(&tmpdir.join("f")));
2044 assert!(tmpdir.join("f").exists());
2045 check!(c(&w).truncate(true).create(true).open(&tmpdir.join("f")));
2046 check!(c(&w).truncate(true).open(&tmpdir.join("f")));
2048 check!(c(&rw).truncate(true).create(true).open(&tmpdir.join("g")));
2049 assert!(tmpdir.join("g").exists());
2050 check!(c(&rw).truncate(true).create(true).open(&tmpdir.join("g")));
2051 check!(c(&rw).truncate(true).open(&tmpdir.join("g")));
2053 check!(check!(File::create(&tmpdir.join("h"))).write("foo".as_bytes()));
2054 check!(r.open(&tmpdir.join("h")));
2056 let mut f = check!(r.open(&tmpdir.join("h")));
2057 assert!(f.write("wut".as_bytes()).is_err());
2059 assert_eq!(check!(fs::metadata(&tmpdir.join("h"))).len(), 3);
2061 let mut f = check!(c(&w).append(true).open(&tmpdir.join("h")));
2062 check!(f.write("bar".as_bytes()));
2064 assert_eq!(check!(fs::metadata(&tmpdir.join("h"))).len(), 6);
2066 let mut f = check!(c(&w).truncate(true).open(&tmpdir.join("h")));
2067 check!(f.write("bar".as_bytes()));
2069 assert_eq!(check!(fs::metadata(&tmpdir.join("h"))).len(), 3);
2074 let mut bytes = [0; 1024];
2075 StdRng::new().unwrap().fill_bytes(&mut bytes);
2077 let tmpdir = tmpdir();
2079 check!(check!(File::create(&tmpdir.join("test"))).write(&bytes));
2080 let mut v = Vec::new();
2081 check!(check!(File::open(&tmpdir.join("test"))).read_to_end(&mut v));
2082 assert!(v == &bytes[..]);
2086 #[cfg(not(windows))]
2087 fn unlink_readonly() {
2088 let tmpdir = tmpdir();
2089 let path = tmpdir.join("file");
2090 check!(File::create(&path));
2091 let mut perm = check!(fs::metadata(&path)).permissions();
2092 perm.set_readonly(true);
2093 check!(fs::set_permissions(&path, perm));
2094 check!(fs::remove_file(&path));
2098 fn mkdir_trailing_slash() {
2099 let tmpdir = tmpdir();
2100 let path = tmpdir.join("file");
2101 check!(fs::create_dir_all(&path.join("a/")));
2105 fn canonicalize_works_simple() {
2106 let tmpdir = tmpdir();
2107 let tmpdir = fs::canonicalize(tmpdir.path()).unwrap();
2108 let file = tmpdir.join("test");
2109 File::create(&file).unwrap();
2110 assert_eq!(fs::canonicalize(&file).unwrap(), file);
2114 #[cfg(not(windows))]
2115 fn realpath_works() {
2116 let tmpdir = tmpdir();
2117 let tmpdir = fs::canonicalize(tmpdir.path()).unwrap();
2118 let file = tmpdir.join("test");
2119 let dir = tmpdir.join("test2");
2120 let link = dir.join("link");
2121 let linkdir = tmpdir.join("test3");
2123 File::create(&file).unwrap();
2124 fs::create_dir(&dir).unwrap();
2125 fs::soft_link(&file, &link).unwrap();
2126 fs::soft_link(&dir, &linkdir).unwrap();
2128 assert!(link.symlink_metadata().unwrap().file_type().is_symlink());
2130 assert_eq!(fs::canonicalize(&tmpdir).unwrap(), tmpdir);
2131 assert_eq!(fs::canonicalize(&file).unwrap(), file);
2132 assert_eq!(fs::canonicalize(&link).unwrap(), file);
2133 assert_eq!(fs::canonicalize(&linkdir).unwrap(), dir);
2134 assert_eq!(fs::canonicalize(&linkdir.join("link")).unwrap(), file);
2138 #[cfg(not(windows))]
2139 fn realpath_works_tricky() {
2140 let tmpdir = tmpdir();
2141 let tmpdir = fs::canonicalize(tmpdir.path()).unwrap();
2143 let a = tmpdir.join("a");
2144 let b = a.join("b");
2145 let c = b.join("c");
2146 let d = a.join("d");
2147 let e = d.join("e");
2148 let f = a.join("f");
2150 fs::create_dir_all(&b).unwrap();
2151 fs::create_dir_all(&d).unwrap();
2152 File::create(&f).unwrap();
2153 fs::soft_link("../d/e", &c).unwrap();
2154 fs::soft_link("../f", &e).unwrap();
2156 assert_eq!(fs::canonicalize(&c).unwrap(), f);
2157 assert_eq!(fs::canonicalize(&e).unwrap(), f);
2161 fn dir_entry_methods() {
2162 let tmpdir = tmpdir();
2164 fs::create_dir_all(&tmpdir.join("a")).unwrap();
2165 File::create(&tmpdir.join("b")).unwrap();
2167 for file in tmpdir.path().read_dir().unwrap().map(|f| f.unwrap()) {
2168 let fname = file.file_name();
2169 match fname.to_str() {
2171 assert!(file.file_type().unwrap().is_dir());
2172 assert!(file.metadata().unwrap().is_dir());
2175 assert!(file.file_type().unwrap().is_file());
2176 assert!(file.metadata().unwrap().is_file());
2178 f => panic!("unknown file name: {:?}", f),
2184 fn read_dir_not_found() {
2185 let res = fs::read_dir("/path/that/does/not/exist");
2186 assert_eq!(res.err().unwrap().kind(), ErrorKind::NotFound);