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, Initializer, Write};
23 use path::{Path, PathBuf};
24 use sys::fs as fs_imp;
25 use sys_common::{AsInnerMut, FromInner, AsInner, IntoInner};
28 /// A reference to an open file on the filesystem.
30 /// An instance of a `File` can be read and/or written depending on what options
31 /// it was opened with. Files also implement `Seek` to alter the logical cursor
32 /// that the file contains internally.
34 /// Files are automatically closed when they go out of scope.
38 /// Create a new file and write bytes to it:
41 /// use std::fs::File;
42 /// use std::io::prelude::*;
44 /// # fn foo() -> std::io::Result<()> {
45 /// let mut file = File::create("foo.txt")?;
46 /// file.write_all(b"Hello, world!")?;
51 /// Read the contents of a file into a `String`:
54 /// use std::fs::File;
55 /// use std::io::prelude::*;
57 /// # fn foo() -> std::io::Result<()> {
58 /// let mut file = File::open("foo.txt")?;
59 /// let mut contents = String::new();
60 /// file.read_to_string(&mut contents)?;
61 /// assert_eq!(contents, "Hello, world!");
66 /// It can be more efficient to read the contents of a file with a buffered
67 /// [`Read`]er. This can be accomplished with [`BufReader<R>`]:
70 /// use std::fs::File;
71 /// use std::io::BufReader;
72 /// use std::io::prelude::*;
74 /// # fn foo() -> std::io::Result<()> {
75 /// let file = File::open("foo.txt")?;
76 /// let mut buf_reader = BufReader::new(file);
77 /// let mut contents = String::new();
78 /// buf_reader.read_to_string(&mut contents)?;
79 /// assert_eq!(contents, "Hello, world!");
84 /// [`Read`]: ../io/trait.Read.html
85 /// [`BufReader<R>`]: ../io/struct.BufReader.html
86 #[stable(feature = "rust1", since = "1.0.0")]
91 /// Metadata information about a file.
93 /// This structure is returned from the [`metadata`] or
94 /// [`symlink_metadata`] function or method and represents known
95 /// metadata about a file such as its permissions, size, modification
98 /// [`metadata`]: fn.metadata.html
99 /// [`symlink_metadata`]: fn.symlink_metadata.html
100 #[stable(feature = "rust1", since = "1.0.0")]
102 pub struct Metadata(fs_imp::FileAttr);
104 /// Iterator over the entries in a directory.
106 /// This iterator is returned from the [`read_dir`] function of this module and
107 /// will yield instances of `io::Result<DirEntry>`. Through a [`DirEntry`]
108 /// information like the entry's path and possibly other metadata can be
111 /// [`read_dir`]: fn.read_dir.html
112 /// [`DirEntry`]: struct.DirEntry.html
116 /// This [`io::Result`] will be an `Err` if there's some sort of intermittent
117 /// IO error during iteration.
119 /// [`io::Result`]: ../io/type.Result.html
120 #[stable(feature = "rust1", since = "1.0.0")]
122 pub struct ReadDir(fs_imp::ReadDir);
124 /// Entries returned by the [`ReadDir`] iterator.
126 /// [`ReadDir`]: struct.ReadDir.html
128 /// An instance of `DirEntry` represents an entry inside of a directory on the
129 /// filesystem. Each entry can be inspected via methods to learn about the full
130 /// path or possibly other metadata through per-platform extension traits.
131 #[stable(feature = "rust1", since = "1.0.0")]
132 pub struct DirEntry(fs_imp::DirEntry);
134 /// Options and flags which can be used to configure how a file is opened.
136 /// This builder exposes the ability to configure how a [`File`] is opened and
137 /// what operations are permitted on the open file. The [`File::open`] and
138 /// [`File::create`] methods are aliases for commonly used options using this
141 /// [`File`]: struct.File.html
142 /// [`File::open`]: struct.File.html#method.open
143 /// [`File::create`]: struct.File.html#method.create
145 /// Generally speaking, when using `OpenOptions`, you'll first call [`new`],
146 /// then chain calls to methods to set each option, then call [`open`],
147 /// passing the path of the file you're trying to open. This will give you a
148 /// [`io::Result`][result] with a [`File`][file] inside that you can further
151 /// [`new`]: struct.OpenOptions.html#method.new
152 /// [`open`]: struct.OpenOptions.html#method.open
153 /// [result]: ../io/type.Result.html
154 /// [file]: struct.File.html
158 /// Opening a file to read:
161 /// use std::fs::OpenOptions;
163 /// let file = OpenOptions::new().read(true).open("foo.txt");
166 /// Opening a file for both reading and writing, as well as creating it if it
170 /// use std::fs::OpenOptions;
172 /// let file = OpenOptions::new()
176 /// .open("foo.txt");
178 #[derive(Clone, Debug)]
179 #[stable(feature = "rust1", since = "1.0.0")]
180 pub struct OpenOptions(fs_imp::OpenOptions);
182 /// Representation of the various permissions on a file.
184 /// This module only currently provides one bit of information, [`readonly`],
185 /// which is exposed on all currently supported platforms. Unix-specific
186 /// functionality, such as mode bits, is available through the
187 /// `os::unix::PermissionsExt` trait.
189 /// [`readonly`]: struct.Permissions.html#method.readonly
190 #[derive(Clone, PartialEq, Eq, Debug)]
191 #[stable(feature = "rust1", since = "1.0.0")]
192 pub struct Permissions(fs_imp::FilePermissions);
194 /// A structure representing a type of file with accessors for each file type.
195 /// It is returned by [`Metadata::file_type`] method.
197 /// [`Metadata::file_type`]: struct.Metadata.html#method.file_type
198 #[stable(feature = "file_type", since = "1.1.0")]
199 #[derive(Copy, Clone, PartialEq, Eq, Hash, Debug)]
200 pub struct FileType(fs_imp::FileType);
202 /// A builder used to create directories in various manners.
204 /// This builder also supports platform-specific options.
205 #[stable(feature = "dir_builder", since = "1.6.0")]
207 pub struct DirBuilder {
208 inner: fs_imp::DirBuilder,
213 /// Attempts to open a file in read-only mode.
215 /// See the [`OpenOptions::open`] method for more details.
219 /// This function will return an error if `path` does not already exist.
220 /// Other errors may also be returned according to [`OpenOptions::open`].
222 /// [`OpenOptions::open`]: struct.OpenOptions.html#method.open
227 /// use std::fs::File;
229 /// # fn foo() -> std::io::Result<()> {
230 /// let mut f = File::open("foo.txt")?;
234 #[stable(feature = "rust1", since = "1.0.0")]
235 pub fn open<P: AsRef<Path>>(path: P) -> io::Result<File> {
236 OpenOptions::new().read(true).open(path.as_ref())
239 /// Opens a file in write-only mode.
241 /// This function will create a file if it does not exist,
242 /// and will truncate it if it does.
244 /// See the [`OpenOptions::open`] function for more details.
246 /// [`OpenOptions::open`]: struct.OpenOptions.html#method.open
251 /// use std::fs::File;
253 /// # fn foo() -> std::io::Result<()> {
254 /// let mut f = File::create("foo.txt")?;
258 #[stable(feature = "rust1", since = "1.0.0")]
259 pub fn create<P: AsRef<Path>>(path: P) -> io::Result<File> {
260 OpenOptions::new().write(true).create(true).truncate(true).open(path.as_ref())
263 /// Attempts to sync all OS-internal metadata to disk.
265 /// This function will attempt to ensure that all in-core data reaches the
266 /// filesystem before returning.
271 /// use std::fs::File;
272 /// use std::io::prelude::*;
274 /// # fn foo() -> std::io::Result<()> {
275 /// let mut f = File::create("foo.txt")?;
276 /// f.write_all(b"Hello, world!")?;
282 #[stable(feature = "rust1", since = "1.0.0")]
283 pub fn sync_all(&self) -> io::Result<()> {
287 /// This function is similar to [`sync_all`], except that it may not
288 /// synchronize file metadata to the filesystem.
290 /// This is intended for use cases that must synchronize content, but don't
291 /// need the metadata on disk. The goal of this method is to reduce disk
294 /// Note that some platforms may simply implement this in terms of
297 /// [`sync_all`]: struct.File.html#method.sync_all
302 /// use std::fs::File;
303 /// use std::io::prelude::*;
305 /// # fn foo() -> std::io::Result<()> {
306 /// let mut f = File::create("foo.txt")?;
307 /// f.write_all(b"Hello, world!")?;
313 #[stable(feature = "rust1", since = "1.0.0")]
314 pub fn sync_data(&self) -> io::Result<()> {
315 self.inner.datasync()
318 /// Truncates or extends the underlying file, updating the size of
319 /// this file to become `size`.
321 /// If the `size` is less than the current file's size, then the file will
322 /// be shrunk. If it is greater than the current file's size, then the file
323 /// will be extended to `size` and have all of the intermediate data filled
328 /// This function will return an error if the file is not opened for writing.
333 /// use std::fs::File;
335 /// # fn foo() -> std::io::Result<()> {
336 /// let mut f = File::create("foo.txt")?;
341 #[stable(feature = "rust1", since = "1.0.0")]
342 pub fn set_len(&self, size: u64) -> io::Result<()> {
343 self.inner.truncate(size)
346 /// Queries metadata about the underlying file.
351 /// use std::fs::File;
353 /// # fn foo() -> std::io::Result<()> {
354 /// let mut f = File::open("foo.txt")?;
355 /// let metadata = f.metadata()?;
359 #[stable(feature = "rust1", since = "1.0.0")]
360 pub fn metadata(&self) -> io::Result<Metadata> {
361 self.inner.file_attr().map(Metadata)
364 /// Creates a new independently owned handle to the underlying file.
366 /// The returned `File` is a reference to the same state that this object
367 /// references. Both handles will read and write with the same cursor
373 /// use std::fs::File;
375 /// # fn foo() -> std::io::Result<()> {
376 /// let mut f = File::open("foo.txt")?;
377 /// let file_copy = f.try_clone()?;
381 #[stable(feature = "file_try_clone", since = "1.9.0")]
382 pub fn try_clone(&self) -> io::Result<File> {
384 inner: self.inner.duplicate()?
388 /// Changes the permissions on the underlying file.
390 /// # Platform-specific behavior
392 /// This function currently corresponds to the `fchmod` function on Unix and
393 /// the `SetFileInformationByHandle` function on Windows. Note that, this
394 /// [may change in the future][changes].
396 /// [changes]: ../io/index.html#platform-specific-behavior
400 /// This function will return an error if the user lacks permission change
401 /// attributes on the underlying file. It may also return an error in other
402 /// os-specific unspecified cases.
407 /// # fn foo() -> std::io::Result<()> {
408 /// use std::fs::File;
410 /// let file = File::open("foo.txt")?;
411 /// let mut perms = file.metadata()?.permissions();
412 /// perms.set_readonly(true);
413 /// file.set_permissions(perms)?;
417 #[stable(feature = "set_permissions_atomic", since = "1.16.0")]
418 pub fn set_permissions(&self, perm: Permissions) -> io::Result<()> {
419 self.inner.set_permissions(perm.0)
423 impl AsInner<fs_imp::File> for File {
424 fn as_inner(&self) -> &fs_imp::File { &self.inner }
426 impl FromInner<fs_imp::File> for File {
427 fn from_inner(f: fs_imp::File) -> File {
431 impl IntoInner<fs_imp::File> for File {
432 fn into_inner(self) -> fs_imp::File {
437 #[stable(feature = "rust1", since = "1.0.0")]
438 impl fmt::Debug for File {
439 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
444 #[stable(feature = "rust1", since = "1.0.0")]
446 fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
451 unsafe fn initializer(&self) -> Initializer {
455 #[stable(feature = "rust1", since = "1.0.0")]
456 impl Write for File {
457 fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
458 self.inner.write(buf)
460 fn flush(&mut self) -> io::Result<()> { self.inner.flush() }
462 #[stable(feature = "rust1", since = "1.0.0")]
464 fn seek(&mut self, pos: SeekFrom) -> io::Result<u64> {
468 #[stable(feature = "rust1", since = "1.0.0")]
469 impl<'a> Read for &'a File {
470 fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
475 unsafe fn initializer(&self) -> Initializer {
479 #[stable(feature = "rust1", since = "1.0.0")]
480 impl<'a> Write for &'a File {
481 fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
482 self.inner.write(buf)
484 fn flush(&mut self) -> io::Result<()> { self.inner.flush() }
486 #[stable(feature = "rust1", since = "1.0.0")]
487 impl<'a> Seek for &'a File {
488 fn seek(&mut self, pos: SeekFrom) -> io::Result<u64> {
494 /// Creates a blank new set of options ready for configuration.
496 /// All options are initially set to `false`.
501 /// use std::fs::OpenOptions;
503 /// let mut options = OpenOptions::new();
504 /// let file = options.read(true).open("foo.txt");
506 #[stable(feature = "rust1", since = "1.0.0")]
507 pub fn new() -> OpenOptions {
508 OpenOptions(fs_imp::OpenOptions::new())
511 /// Sets the option for read access.
513 /// This option, when true, will indicate that the file should be
514 /// `read`-able if opened.
519 /// use std::fs::OpenOptions;
521 /// let file = OpenOptions::new().read(true).open("foo.txt");
523 #[stable(feature = "rust1", since = "1.0.0")]
524 pub fn read(&mut self, read: bool) -> &mut OpenOptions {
525 self.0.read(read); self
528 /// Sets the option for write access.
530 /// This option, when true, will indicate that the file should be
531 /// `write`-able if opened.
533 /// If the file already exists, any write calls on it will overwrite its
534 /// contents, without truncating it.
539 /// use std::fs::OpenOptions;
541 /// let file = OpenOptions::new().write(true).open("foo.txt");
543 #[stable(feature = "rust1", since = "1.0.0")]
544 pub fn write(&mut self, write: bool) -> &mut OpenOptions {
545 self.0.write(write); self
548 /// Sets the option for the append mode.
550 /// This option, when true, means that writes will append to a file instead
551 /// of overwriting previous contents.
552 /// Note that setting `.write(true).append(true)` has the same effect as
553 /// setting only `.append(true)`.
555 /// For most filesystems, the operating system guarantees that all writes are
556 /// atomic: no writes get mangled because another process writes at the same
559 /// One maybe obvious note when using append-mode: make sure that all data
560 /// that belongs together is written to the file in one operation. This
561 /// can be done by concatenating strings before passing them to `write()`,
562 /// or using a buffered writer (with a buffer of adequate size),
563 /// and calling `flush()` when the message is complete.
565 /// If a file is opened with both read and append access, beware that after
566 /// opening, and after every write, the position for reading may be set at the
567 /// end of the file. So, before writing, save the current position (using
568 /// `seek(SeekFrom::Current(0))`, and restore it before the next read.
573 /// use std::fs::OpenOptions;
575 /// let file = OpenOptions::new().append(true).open("foo.txt");
577 #[stable(feature = "rust1", since = "1.0.0")]
578 pub fn append(&mut self, append: bool) -> &mut OpenOptions {
579 self.0.append(append); self
582 /// Sets the option for truncating a previous file.
584 /// If a file is successfully opened with this option set it will truncate
585 /// the file to 0 length if it already exists.
587 /// The file must be opened with write access for truncate to work.
592 /// use std::fs::OpenOptions;
594 /// let file = OpenOptions::new().write(true).truncate(true).open("foo.txt");
596 #[stable(feature = "rust1", since = "1.0.0")]
597 pub fn truncate(&mut self, truncate: bool) -> &mut OpenOptions {
598 self.0.truncate(truncate); self
601 /// Sets the option for creating a new file.
603 /// This option indicates whether a new file will be created if the file
604 /// does not yet already exist.
606 /// In order for the file to be created, `write` or `append` access must
612 /// use std::fs::OpenOptions;
614 /// let file = OpenOptions::new().write(true).create(true).open("foo.txt");
616 #[stable(feature = "rust1", since = "1.0.0")]
617 pub fn create(&mut self, create: bool) -> &mut OpenOptions {
618 self.0.create(create); self
621 /// Sets the option to always create a new file.
623 /// This option indicates whether a new file will be created.
624 /// No file is allowed to exist at the target location, also no (dangling)
627 /// This option is useful because it is atomic. Otherwise between checking
628 /// whether a file exists and creating a new one, the file may have been
629 /// created by another process (a TOCTOU race condition / attack).
631 /// If `.create_new(true)` is set, `.create()` and `.truncate()` are
634 /// The file must be opened with write or append access in order to create
640 /// use std::fs::OpenOptions;
642 /// let file = OpenOptions::new().write(true)
643 /// .create_new(true)
644 /// .open("foo.txt");
646 #[stable(feature = "expand_open_options2", since = "1.9.0")]
647 pub fn create_new(&mut self, create_new: bool) -> &mut OpenOptions {
648 self.0.create_new(create_new); self
651 /// Opens a file at `path` with the options specified by `self`.
655 /// This function will return an error under a number of different
656 /// circumstances. Some of these error conditions are listed here, together
657 /// with their [`ErrorKind`]. The mapping to `ErrorKind`s is not part of
658 /// the compatiblity contract of the function, especially the `Other` kind
659 /// might change to more specific kinds in the future.
661 /// * `NotFound`: The specified file does not exist and neither `create` or
662 /// `create_new` is set,
663 /// * `NotFound`: One of the directory components of the file path does not
665 /// * `PermissionDenied`: The user lacks permission to get the specified
666 /// access rights for the file.
667 /// * `PermissionDenied`: The user lacks permission to open one of the
668 /// directory components of the specified path.
669 /// * `AlreadyExists`: `create_new` was specified and the file already
671 /// * `InvalidInput`: Invalid combinations of open options (truncate
672 /// without write access, no access mode set, etc.).
673 /// * `Other`: One of the directory components of the specified file path
674 /// was not, in fact, a directory.
675 /// * `Other`: Filesystem-level errors: full disk, write permission
676 /// requested on a read-only file system, exceeded disk quota, too many
677 /// open files, too long filename, too many symbolic links in the
678 /// specified path (Unix-like systems only), etc.
683 /// use std::fs::OpenOptions;
685 /// let file = OpenOptions::new().open("foo.txt");
688 /// [`ErrorKind`]: ../io/enum.ErrorKind.html
689 #[stable(feature = "rust1", since = "1.0.0")]
690 pub fn open<P: AsRef<Path>>(&self, path: P) -> io::Result<File> {
691 self._open(path.as_ref())
694 fn _open(&self, path: &Path) -> io::Result<File> {
695 let inner = fs_imp::File::open(path, &self.0)?;
696 Ok(File { inner: inner })
700 impl AsInnerMut<fs_imp::OpenOptions> for OpenOptions {
701 fn as_inner_mut(&mut self) -> &mut fs_imp::OpenOptions { &mut self.0 }
705 /// Returns the file type for this metadata.
710 /// # fn foo() -> std::io::Result<()> {
713 /// let metadata = fs::metadata("foo.txt")?;
715 /// println!("{:?}", metadata.file_type());
719 #[stable(feature = "file_type", since = "1.1.0")]
720 pub fn file_type(&self) -> FileType {
721 FileType(self.0.file_type())
724 /// Returns whether this metadata is for a directory.
729 /// # fn foo() -> std::io::Result<()> {
732 /// let metadata = fs::metadata("foo.txt")?;
734 /// assert!(!metadata.is_dir());
738 #[stable(feature = "rust1", since = "1.0.0")]
739 pub fn is_dir(&self) -> bool { self.file_type().is_dir() }
741 /// Returns whether this metadata is for a regular file.
746 /// # fn foo() -> std::io::Result<()> {
749 /// let metadata = fs::metadata("foo.txt")?;
751 /// assert!(metadata.is_file());
755 #[stable(feature = "rust1", since = "1.0.0")]
756 pub fn is_file(&self) -> bool { self.file_type().is_file() }
758 /// Returns the size of the file, in bytes, this metadata is for.
763 /// # fn foo() -> std::io::Result<()> {
766 /// let metadata = fs::metadata("foo.txt")?;
768 /// assert_eq!(0, metadata.len());
772 #[stable(feature = "rust1", since = "1.0.0")]
773 pub fn len(&self) -> u64 { self.0.size() }
775 /// Returns the permissions of the file this metadata is for.
780 /// # fn foo() -> std::io::Result<()> {
783 /// let metadata = fs::metadata("foo.txt")?;
785 /// assert!(!metadata.permissions().readonly());
789 #[stable(feature = "rust1", since = "1.0.0")]
790 pub fn permissions(&self) -> Permissions {
791 Permissions(self.0.perm())
794 /// Returns the last modification time listed in this metadata.
796 /// The returned value corresponds to the `mtime` field of `stat` on Unix
797 /// platforms and the `ftLastWriteTime` field on Windows platforms.
801 /// This field may not be available on all platforms, and will return an
802 /// `Err` on platforms where it is not available.
807 /// # fn foo() -> std::io::Result<()> {
810 /// let metadata = fs::metadata("foo.txt")?;
812 /// if let Ok(time) = metadata.modified() {
813 /// println!("{:?}", time);
815 /// println!("Not supported on this platform");
820 #[stable(feature = "fs_time", since = "1.10.0")]
821 pub fn modified(&self) -> io::Result<SystemTime> {
822 self.0.modified().map(FromInner::from_inner)
825 /// Returns the last access time of this metadata.
827 /// The returned value corresponds to the `atime` field of `stat` on Unix
828 /// platforms and the `ftLastAccessTime` field on Windows platforms.
830 /// Note that not all platforms will keep this field update in a file's
831 /// metadata, for example Windows has an option to disable updating this
832 /// time when files are accessed and Linux similarly has `noatime`.
836 /// This field may not be available on all platforms, and will return an
837 /// `Err` on platforms where it is not available.
842 /// # fn foo() -> std::io::Result<()> {
845 /// let metadata = fs::metadata("foo.txt")?;
847 /// if let Ok(time) = metadata.accessed() {
848 /// println!("{:?}", time);
850 /// println!("Not supported on this platform");
855 #[stable(feature = "fs_time", since = "1.10.0")]
856 pub fn accessed(&self) -> io::Result<SystemTime> {
857 self.0.accessed().map(FromInner::from_inner)
860 /// Returns the creation time listed in the this metadata.
862 /// The returned value corresponds to the `birthtime` field of `stat` on
863 /// Unix platforms and the `ftCreationTime` field on Windows platforms.
867 /// This field may not be available on all platforms, and will return an
868 /// `Err` on platforms where it is not available.
873 /// # fn foo() -> std::io::Result<()> {
876 /// let metadata = fs::metadata("foo.txt")?;
878 /// if let Ok(time) = metadata.created() {
879 /// println!("{:?}", time);
881 /// println!("Not supported on this platform");
886 #[stable(feature = "fs_time", since = "1.10.0")]
887 pub fn created(&self) -> io::Result<SystemTime> {
888 self.0.created().map(FromInner::from_inner)
892 #[stable(feature = "std_debug", since = "1.16.0")]
893 impl fmt::Debug for Metadata {
894 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
895 f.debug_struct("Metadata")
896 .field("file_type", &self.file_type())
897 .field("is_dir", &self.is_dir())
898 .field("is_file", &self.is_file())
899 .field("permissions", &self.permissions())
900 .field("modified", &self.modified())
901 .field("accessed", &self.accessed())
902 .field("created", &self.created())
907 impl AsInner<fs_imp::FileAttr> for Metadata {
908 fn as_inner(&self) -> &fs_imp::FileAttr { &self.0 }
912 /// Returns whether these permissions describe a readonly file.
917 /// use std::fs::File;
919 /// # fn foo() -> std::io::Result<()> {
920 /// let mut f = File::create("foo.txt")?;
921 /// let metadata = f.metadata()?;
923 /// assert_eq!(false, metadata.permissions().readonly());
927 #[stable(feature = "rust1", since = "1.0.0")]
928 pub fn readonly(&self) -> bool { self.0.readonly() }
930 /// Modifies the readonly flag for this set of permissions.
932 /// This operation does **not** modify the filesystem. To modify the
933 /// filesystem use the `fs::set_permissions` function.
938 /// use std::fs::File;
940 /// # fn foo() -> std::io::Result<()> {
941 /// let f = File::create("foo.txt")?;
942 /// let metadata = f.metadata()?;
943 /// let mut permissions = metadata.permissions();
945 /// permissions.set_readonly(true);
947 /// // filesystem doesn't change
948 /// assert_eq!(false, metadata.permissions().readonly());
950 /// // just this particular `permissions`.
951 /// assert_eq!(true, permissions.readonly());
955 #[stable(feature = "rust1", since = "1.0.0")]
956 pub fn set_readonly(&mut self, readonly: bool) {
957 self.0.set_readonly(readonly)
962 /// Test whether this file type represents a directory.
967 /// # fn foo() -> std::io::Result<()> {
970 /// let metadata = fs::metadata("foo.txt")?;
971 /// let file_type = metadata.file_type();
973 /// assert_eq!(file_type.is_dir(), false);
977 #[stable(feature = "file_type", since = "1.1.0")]
978 pub fn is_dir(&self) -> bool { self.0.is_dir() }
980 /// Test whether this file type represents a regular file.
985 /// # fn foo() -> std::io::Result<()> {
988 /// let metadata = fs::metadata("foo.txt")?;
989 /// let file_type = metadata.file_type();
991 /// assert_eq!(file_type.is_file(), true);
995 #[stable(feature = "file_type", since = "1.1.0")]
996 pub fn is_file(&self) -> bool { self.0.is_file() }
998 /// Test whether this file type represents a symbolic link.
1000 /// The underlying [`Metadata`] struct needs to be retrieved
1001 /// with the [`fs::symlink_metadata`] function and not the
1002 /// [`fs::metadata`] function. The [`fs::metadata`] function
1003 /// follows symbolic links, so [`is_symlink`] would always
1004 /// return false for the target file.
1006 /// [`Metadata`]: struct.Metadata.html
1007 /// [`fs::metadata`]: fn.metadata.html
1008 /// [`fs::symlink_metadata`]: fn.symlink_metadata.html
1009 /// [`is_symlink`]: struct.FileType.html#method.is_symlink
1014 /// # fn foo() -> std::io::Result<()> {
1017 /// let metadata = fs::symlink_metadata("foo.txt")?;
1018 /// let file_type = metadata.file_type();
1020 /// assert_eq!(file_type.is_symlink(), false);
1024 #[stable(feature = "file_type", since = "1.1.0")]
1025 pub fn is_symlink(&self) -> bool { self.0.is_symlink() }
1028 impl AsInner<fs_imp::FileType> for FileType {
1029 fn as_inner(&self) -> &fs_imp::FileType { &self.0 }
1032 impl FromInner<fs_imp::FilePermissions> for Permissions {
1033 fn from_inner(f: fs_imp::FilePermissions) -> Permissions {
1038 impl AsInner<fs_imp::FilePermissions> for Permissions {
1039 fn as_inner(&self) -> &fs_imp::FilePermissions { &self.0 }
1042 #[stable(feature = "rust1", since = "1.0.0")]
1043 impl Iterator for ReadDir {
1044 type Item = io::Result<DirEntry>;
1046 fn next(&mut self) -> Option<io::Result<DirEntry>> {
1047 self.0.next().map(|entry| entry.map(DirEntry))
1052 /// Returns the full path to the file that this entry represents.
1054 /// The full path is created by joining the original path to `read_dir`
1055 /// with the filename of this entry.
1061 /// # fn foo() -> std::io::Result<()> {
1062 /// for entry in fs::read_dir(".")? {
1063 /// let dir = entry?;
1064 /// println!("{:?}", dir.path());
1070 /// This prints output like:
1073 /// "./whatever.txt"
1075 /// "./hello_world.rs"
1078 /// The exact text, of course, depends on what files you have in `.`.
1079 #[stable(feature = "rust1", since = "1.0.0")]
1080 pub fn path(&self) -> PathBuf { self.0.path() }
1082 /// Return the metadata for the file that this entry points at.
1084 /// This function will not traverse symlinks if this entry points at a
1087 /// # Platform-specific behavior
1089 /// On Windows this function is cheap to call (no extra system calls
1090 /// needed), but on Unix platforms this function is the equivalent of
1091 /// calling `symlink_metadata` on the path.
1098 /// if let Ok(entries) = fs::read_dir(".") {
1099 /// for entry in entries {
1100 /// if let Ok(entry) = entry {
1101 /// // Here, `entry` is a `DirEntry`.
1102 /// if let Ok(metadata) = entry.metadata() {
1103 /// // Now let's show our entry's permissions!
1104 /// println!("{:?}: {:?}", entry.path(), metadata.permissions());
1106 /// println!("Couldn't get metadata for {:?}", entry.path());
1112 #[stable(feature = "dir_entry_ext", since = "1.1.0")]
1113 pub fn metadata(&self) -> io::Result<Metadata> {
1114 self.0.metadata().map(Metadata)
1117 /// Return the file type for the file that this entry points at.
1119 /// This function will not traverse symlinks if this entry points at a
1122 /// # Platform-specific behavior
1124 /// On Windows and most Unix platforms this function is free (no extra
1125 /// system calls needed), but some Unix platforms may require the equivalent
1126 /// call to `symlink_metadata` to learn about the target file type.
1133 /// if let Ok(entries) = fs::read_dir(".") {
1134 /// for entry in entries {
1135 /// if let Ok(entry) = entry {
1136 /// // Here, `entry` is a `DirEntry`.
1137 /// if let Ok(file_type) = entry.file_type() {
1138 /// // Now let's show our entry's file type!
1139 /// println!("{:?}: {:?}", entry.path(), file_type);
1141 /// println!("Couldn't get file type for {:?}", entry.path());
1147 #[stable(feature = "dir_entry_ext", since = "1.1.0")]
1148 pub fn file_type(&self) -> io::Result<FileType> {
1149 self.0.file_type().map(FileType)
1152 /// Returns the bare file name of this directory entry without any other
1153 /// leading path component.
1160 /// if let Ok(entries) = fs::read_dir(".") {
1161 /// for entry in entries {
1162 /// if let Ok(entry) = entry {
1163 /// // Here, `entry` is a `DirEntry`.
1164 /// println!("{:?}", entry.file_name());
1169 #[stable(feature = "dir_entry_ext", since = "1.1.0")]
1170 pub fn file_name(&self) -> OsString {
1175 #[stable(feature = "dir_entry_debug", since = "1.13.0")]
1176 impl fmt::Debug for DirEntry {
1177 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1178 f.debug_tuple("DirEntry")
1179 .field(&self.path())
1184 impl AsInner<fs_imp::DirEntry> for DirEntry {
1185 fn as_inner(&self) -> &fs_imp::DirEntry { &self.0 }
1188 /// Removes a file from the filesystem.
1190 /// Note that there is no
1191 /// guarantee that the file is immediately deleted (e.g. depending on
1192 /// platform, other open file descriptors may prevent immediate removal).
1194 /// # Platform-specific behavior
1196 /// This function currently corresponds to the `unlink` function on Unix
1197 /// and the `DeleteFile` function on Windows.
1198 /// Note that, this [may change in the future][changes].
1200 /// [changes]: ../io/index.html#platform-specific-behavior
1204 /// This function will return an error in the following situations, but is not
1205 /// limited to just these cases:
1207 /// * `path` points to a directory.
1208 /// * The user lacks permissions to remove the file.
1215 /// # fn foo() -> std::io::Result<()> {
1216 /// fs::remove_file("a.txt")?;
1220 #[stable(feature = "rust1", since = "1.0.0")]
1221 pub fn remove_file<P: AsRef<Path>>(path: P) -> io::Result<()> {
1222 fs_imp::unlink(path.as_ref())
1225 /// Given a path, query the file system to get information about a file,
1228 /// This function will traverse symbolic links to query information about the
1229 /// destination file.
1231 /// # Platform-specific behavior
1233 /// This function currently corresponds to the `stat` function on Unix
1234 /// and the `GetFileAttributesEx` function on Windows.
1235 /// Note that, this [may change in the future][changes].
1237 /// [changes]: ../io/index.html#platform-specific-behavior
1241 /// This function will return an error in the following situations, but is not
1242 /// limited to just these cases:
1244 /// * The user lacks permissions to perform `metadata` call on `path`.
1245 /// * `path` does not exist.
1250 /// # fn foo() -> std::io::Result<()> {
1253 /// let attr = fs::metadata("/some/file/path.txt")?;
1254 /// // inspect attr ...
1258 #[stable(feature = "rust1", since = "1.0.0")]
1259 pub fn metadata<P: AsRef<Path>>(path: P) -> io::Result<Metadata> {
1260 fs_imp::stat(path.as_ref()).map(Metadata)
1263 /// Query the metadata about a file without following symlinks.
1265 /// # Platform-specific behavior
1267 /// This function currently corresponds to the `lstat` function on Unix
1268 /// and the `GetFileAttributesEx` function on Windows.
1269 /// Note that, this [may change in the future][changes].
1271 /// [changes]: ../io/index.html#platform-specific-behavior
1275 /// This function will return an error in the following situations, but is not
1276 /// limited to just these cases:
1278 /// * The user lacks permissions to perform `metadata` call on `path`.
1279 /// * `path` does not exist.
1284 /// # fn foo() -> std::io::Result<()> {
1287 /// let attr = fs::symlink_metadata("/some/file/path.txt")?;
1288 /// // inspect attr ...
1292 #[stable(feature = "symlink_metadata", since = "1.1.0")]
1293 pub fn symlink_metadata<P: AsRef<Path>>(path: P) -> io::Result<Metadata> {
1294 fs_imp::lstat(path.as_ref()).map(Metadata)
1297 /// Rename a file or directory to a new name, replacing the original file if
1298 /// `to` already exists.
1300 /// This will not work if the new name is on a different mount point.
1302 /// # Platform-specific behavior
1304 /// This function currently corresponds to the `rename` function on Unix
1305 /// and the `MoveFileEx` function with the `MOVEFILE_REPLACE_EXISTING` flag on Windows.
1307 /// Because of this, the behavior when both `from` and `to` exist differs. On
1308 /// Unix, if `from` is a directory, `to` must also be an (empty) directory. If
1309 /// `from` is not a directory, `to` must also be not a directory. In contrast,
1310 /// on Windows, `from` can be anything, but `to` must *not* be a directory.
1312 /// Note that, this [may change in the future][changes].
1314 /// [changes]: ../io/index.html#platform-specific-behavior
1318 /// This function will return an error in the following situations, but is not
1319 /// limited to just these cases:
1321 /// * `from` does not exist.
1322 /// * The user lacks permissions to view contents.
1323 /// * `from` and `to` are on separate filesystems.
1330 /// # fn foo() -> std::io::Result<()> {
1331 /// fs::rename("a.txt", "b.txt")?; // Rename a.txt to b.txt
1335 #[stable(feature = "rust1", since = "1.0.0")]
1336 pub fn rename<P: AsRef<Path>, Q: AsRef<Path>>(from: P, to: Q) -> io::Result<()> {
1337 fs_imp::rename(from.as_ref(), to.as_ref())
1340 /// Copies the contents of one file to another. This function will also
1341 /// copy the permission bits of the original file to the destination file.
1343 /// This function will **overwrite** the contents of `to`.
1345 /// Note that if `from` and `to` both point to the same file, then the file
1346 /// will likely get truncated by this operation.
1348 /// On success, the total number of bytes copied is returned.
1350 /// # Platform-specific behavior
1352 /// This function currently corresponds to the `open` function in Unix
1353 /// with `O_RDONLY` for `from` and `O_WRONLY`, `O_CREAT`, and `O_TRUNC` for `to`.
1354 /// `O_CLOEXEC` is set for returned file descriptors.
1355 /// On Windows, this function currently corresponds to `CopyFileEx`.
1356 /// Note that, this [may change in the future][changes].
1358 /// [changes]: ../io/index.html#platform-specific-behavior
1362 /// This function will return an error in the following situations, but is not
1363 /// limited to just these cases:
1365 /// * The `from` path is not a file.
1366 /// * The `from` file does not exist.
1367 /// * The current process does not have the permission rights to access
1368 /// `from` or write `to`.
1375 /// # fn foo() -> std::io::Result<()> {
1376 /// fs::copy("foo.txt", "bar.txt")?; // Copy foo.txt to bar.txt
1379 #[stable(feature = "rust1", since = "1.0.0")]
1380 pub fn copy<P: AsRef<Path>, Q: AsRef<Path>>(from: P, to: Q) -> io::Result<u64> {
1381 fs_imp::copy(from.as_ref(), to.as_ref())
1384 /// Creates a new hard link on the filesystem.
1386 /// The `dst` path will be a link pointing to the `src` path. Note that systems
1387 /// often require these two paths to both be located on the same filesystem.
1389 /// # Platform-specific behavior
1391 /// This function currently corresponds to the `link` function on Unix
1392 /// and the `CreateHardLink` function on Windows.
1393 /// Note that, this [may change in the future][changes].
1395 /// [changes]: ../io/index.html#platform-specific-behavior
1399 /// This function will return an error in the following situations, but is not
1400 /// limited to just these cases:
1402 /// * The `src` path is not a file or doesn't exist.
1409 /// # fn foo() -> std::io::Result<()> {
1410 /// fs::hard_link("a.txt", "b.txt")?; // Hard link a.txt to b.txt
1414 #[stable(feature = "rust1", since = "1.0.0")]
1415 pub fn hard_link<P: AsRef<Path>, Q: AsRef<Path>>(src: P, dst: Q) -> io::Result<()> {
1416 fs_imp::link(src.as_ref(), dst.as_ref())
1419 /// Creates a new symbolic link on the filesystem.
1421 /// The `dst` path will be a symbolic link pointing to the `src` path.
1422 /// On Windows, this will be a file symlink, not a directory symlink;
1423 /// for this reason, the platform-specific `std::os::unix::fs::symlink`
1424 /// and `std::os::windows::fs::{symlink_file, symlink_dir}` should be
1425 /// used instead to make the intent explicit.
1432 /// # fn foo() -> std::io::Result<()> {
1433 /// fs::soft_link("a.txt", "b.txt")?;
1437 #[stable(feature = "rust1", since = "1.0.0")]
1438 #[rustc_deprecated(since = "1.1.0",
1439 reason = "replaced with std::os::unix::fs::symlink and \
1440 std::os::windows::fs::{symlink_file, symlink_dir}")]
1441 pub fn soft_link<P: AsRef<Path>, Q: AsRef<Path>>(src: P, dst: Q) -> io::Result<()> {
1442 fs_imp::symlink(src.as_ref(), dst.as_ref())
1445 /// Reads a symbolic link, returning the file that the link points to.
1447 /// # Platform-specific behavior
1449 /// This function currently corresponds to the `readlink` function on Unix
1450 /// and the `CreateFile` function with `FILE_FLAG_OPEN_REPARSE_POINT` and
1451 /// `FILE_FLAG_BACKUP_SEMANTICS` flags on Windows.
1452 /// Note that, this [may change in the future][changes].
1454 /// [changes]: ../io/index.html#platform-specific-behavior
1458 /// This function will return an error in the following situations, but is not
1459 /// limited to just these cases:
1461 /// * `path` is not a symbolic link.
1462 /// * `path` does not exist.
1469 /// # fn foo() -> std::io::Result<()> {
1470 /// let path = fs::read_link("a.txt")?;
1474 #[stable(feature = "rust1", since = "1.0.0")]
1475 pub fn read_link<P: AsRef<Path>>(path: P) -> io::Result<PathBuf> {
1476 fs_imp::readlink(path.as_ref())
1479 /// Returns the canonical form of a path with all intermediate components
1480 /// normalized and symbolic links resolved.
1482 /// # Platform-specific behavior
1484 /// This function currently corresponds to the `realpath` function on Unix
1485 /// and the `CreateFile` and `GetFinalPathNameByHandle` functions on Windows.
1486 /// Note that, this [may change in the future][changes].
1488 /// [changes]: ../io/index.html#platform-specific-behavior
1492 /// This function will return an error in the following situations, but is not
1493 /// limited to just these cases:
1495 /// * `path` does not exist.
1496 /// * A component in path is not a directory.
1503 /// # fn foo() -> std::io::Result<()> {
1504 /// let path = fs::canonicalize("../a/../foo.txt")?;
1508 #[stable(feature = "fs_canonicalize", since = "1.5.0")]
1509 pub fn canonicalize<P: AsRef<Path>>(path: P) -> io::Result<PathBuf> {
1510 fs_imp::canonicalize(path.as_ref())
1513 /// Creates a new, empty directory at the provided path
1515 /// # Platform-specific behavior
1517 /// This function currently corresponds to the `mkdir` function on Unix
1518 /// and the `CreateDirectory` function on Windows.
1519 /// Note that, this [may change in the future][changes].
1521 /// [changes]: ../io/index.html#platform-specific-behavior
1525 /// This function will return an error in the following situations, but is not
1526 /// limited to just these cases:
1528 /// * User lacks permissions to create directory at `path`.
1529 /// * `path` already exists.
1536 /// # fn foo() -> std::io::Result<()> {
1537 /// fs::create_dir("/some/dir")?;
1541 #[stable(feature = "rust1", since = "1.0.0")]
1542 pub fn create_dir<P: AsRef<Path>>(path: P) -> io::Result<()> {
1543 DirBuilder::new().create(path.as_ref())
1546 /// Recursively create a directory and all of its parent components if they
1549 /// # Platform-specific behavior
1551 /// This function currently corresponds to the `mkdir` function on Unix
1552 /// and the `CreateDirectory` function on Windows.
1553 /// Note that, this [may change in the future][changes].
1555 /// [changes]: ../io/index.html#platform-specific-behavior
1559 /// This function will return an error in the following situations, but is not
1560 /// limited to just these cases:
1562 /// * If any directory in the path specified by `path`
1563 /// does not already exist and it could not be created otherwise. The specific
1564 /// error conditions for when a directory is being created (after it is
1565 /// determined to not exist) are outlined by `fs::create_dir`.
1567 /// Notable exception is made for situations where any of the directories
1568 /// specified in the `path` could not be created as it was being created concurrently.
1569 /// Such cases are considered success. In other words: calling `create_dir_all`
1570 /// concurrently from multiple threads or processes is guaranteed to not fail
1571 /// due to race itself.
1578 /// # fn foo() -> std::io::Result<()> {
1579 /// fs::create_dir_all("/some/dir")?;
1583 #[stable(feature = "rust1", since = "1.0.0")]
1584 pub fn create_dir_all<P: AsRef<Path>>(path: P) -> io::Result<()> {
1585 DirBuilder::new().recursive(true).create(path.as_ref())
1588 /// Removes an existing, empty directory.
1590 /// # Platform-specific behavior
1592 /// This function currently corresponds to the `rmdir` function on Unix
1593 /// and the `RemoveDirectory` function on Windows.
1594 /// Note that, this [may change in the future][changes].
1596 /// [changes]: ../io/index.html#platform-specific-behavior
1600 /// This function will return an error in the following situations, but is not
1601 /// limited to just these cases:
1603 /// * The user lacks permissions to remove the directory at the provided `path`.
1604 /// * The directory isn't empty.
1611 /// # fn foo() -> std::io::Result<()> {
1612 /// fs::remove_dir("/some/dir")?;
1616 #[stable(feature = "rust1", since = "1.0.0")]
1617 pub fn remove_dir<P: AsRef<Path>>(path: P) -> io::Result<()> {
1618 fs_imp::rmdir(path.as_ref())
1621 /// Removes a directory at this path, after removing all its contents. Use
1624 /// This function does **not** follow symbolic links and it will simply remove the
1625 /// symbolic link itself.
1627 /// # Platform-specific behavior
1629 /// This function currently corresponds to `opendir`, `lstat`, `rm` and `rmdir` functions on Unix
1630 /// and the `FindFirstFile`, `GetFileAttributesEx`, `DeleteFile`, and `RemoveDirectory` functions
1632 /// Note that, this [may change in the future][changes].
1634 /// [changes]: ../io/index.html#platform-specific-behavior
1638 /// See `file::remove_file` and `fs::remove_dir`.
1645 /// # fn foo() -> std::io::Result<()> {
1646 /// fs::remove_dir_all("/some/dir")?;
1650 #[stable(feature = "rust1", since = "1.0.0")]
1651 pub fn remove_dir_all<P: AsRef<Path>>(path: P) -> io::Result<()> {
1652 fs_imp::remove_dir_all(path.as_ref())
1655 /// Returns an iterator over the entries within a directory.
1657 /// The iterator will yield instances of [`io::Result`]`<`[`DirEntry`]`>`.
1658 /// New errors may be encountered after an iterator is initially constructed.
1660 /// [`io::Result`]: ../io/type.Result.html
1661 /// [`DirEntry`]: struct.DirEntry.html
1663 /// # Platform-specific behavior
1665 /// This function currently corresponds to the `opendir` function on Unix
1666 /// and the `FindFirstFile` function on Windows.
1667 /// Note that, this [may change in the future][changes].
1669 /// [changes]: ../io/index.html#platform-specific-behavior
1673 /// This function will return an error in the following situations, but is not
1674 /// limited to just these cases:
1676 /// * The provided `path` doesn't exist.
1677 /// * The process lacks permissions to view the contents.
1678 /// * The `path` points at a non-directory file.
1684 /// use std::fs::{self, DirEntry};
1685 /// use std::path::Path;
1687 /// // one possible implementation of walking a directory only visiting files
1688 /// fn visit_dirs(dir: &Path, cb: &Fn(&DirEntry)) -> io::Result<()> {
1689 /// if dir.is_dir() {
1690 /// for entry in fs::read_dir(dir)? {
1691 /// let entry = entry?;
1692 /// let path = entry.path();
1693 /// if path.is_dir() {
1694 /// visit_dirs(&path, cb)?;
1703 #[stable(feature = "rust1", since = "1.0.0")]
1704 pub fn read_dir<P: AsRef<Path>>(path: P) -> io::Result<ReadDir> {
1705 fs_imp::readdir(path.as_ref()).map(ReadDir)
1708 /// Changes the permissions found on a file or a directory.
1710 /// # Platform-specific behavior
1712 /// This function currently corresponds to the `chmod` function on Unix
1713 /// and the `SetFileAttributes` function on Windows.
1714 /// Note that, this [may change in the future][changes].
1716 /// [changes]: ../io/index.html#platform-specific-behavior
1720 /// This function will return an error in the following situations, but is not
1721 /// limited to just these cases:
1723 /// * `path` does not exist.
1724 /// * The user lacks the permission to change attributes of the file.
1729 /// # fn foo() -> std::io::Result<()> {
1732 /// let mut perms = fs::metadata("foo.txt")?.permissions();
1733 /// perms.set_readonly(true);
1734 /// fs::set_permissions("foo.txt", perms)?;
1738 #[stable(feature = "set_permissions", since = "1.1.0")]
1739 pub fn set_permissions<P: AsRef<Path>>(path: P, perm: Permissions)
1741 fs_imp::set_perm(path.as_ref(), perm.0)
1745 /// Creates a new set of options with default mode/security settings for all
1746 /// platforms and also non-recursive.
1751 /// use std::fs::DirBuilder;
1753 /// let builder = DirBuilder::new();
1755 #[stable(feature = "dir_builder", since = "1.6.0")]
1756 pub fn new() -> DirBuilder {
1758 inner: fs_imp::DirBuilder::new(),
1763 /// Indicates that directories should be created recursively, creating all
1764 /// parent directories. Parents that do not exist are created with the same
1765 /// security and permissions settings.
1767 /// This option defaults to `false`.
1772 /// use std::fs::DirBuilder;
1774 /// let mut builder = DirBuilder::new();
1775 /// builder.recursive(true);
1777 #[stable(feature = "dir_builder", since = "1.6.0")]
1778 pub fn recursive(&mut self, recursive: bool) -> &mut Self {
1779 self.recursive = recursive;
1783 /// Create the specified directory with the options configured in this
1786 /// It is considered an error if the directory already exists unless
1787 /// recursive mode is enabled.
1792 /// use std::fs::{self, DirBuilder};
1794 /// let path = "/tmp/foo/bar/baz";
1795 /// DirBuilder::new()
1796 /// .recursive(true)
1797 /// .create(path).unwrap();
1799 /// assert!(fs::metadata(path).unwrap().is_dir());
1801 #[stable(feature = "dir_builder", since = "1.6.0")]
1802 pub fn create<P: AsRef<Path>>(&self, path: P) -> io::Result<()> {
1803 self._create(path.as_ref())
1806 fn _create(&self, path: &Path) -> io::Result<()> {
1808 self.create_dir_all(path)
1810 self.inner.mkdir(path)
1814 fn create_dir_all(&self, path: &Path) -> io::Result<()> {
1815 if path == Path::new("") {
1819 match self.inner.mkdir(path) {
1820 Ok(()) => return Ok(()),
1821 Err(ref e) if e.kind() == io::ErrorKind::NotFound => {}
1822 Err(_) if path.is_dir() => return Ok(()),
1823 Err(e) => return Err(e),
1825 match path.parent() {
1826 Some(p) => try!(self.create_dir_all(p)),
1827 None => return Err(io::Error::new(io::ErrorKind::Other, "failed to create whole tree")),
1829 match self.inner.mkdir(path) {
1831 Err(_) if path.is_dir() => Ok(()),
1837 impl AsInnerMut<fs_imp::DirBuilder> for DirBuilder {
1838 fn as_inner_mut(&mut self) -> &mut fs_imp::DirBuilder {
1843 #[cfg(all(test, not(target_os = "emscripten")))]
1847 use fs::{self, File, OpenOptions};
1848 use io::{ErrorKind, SeekFrom};
1850 use rand::{StdRng, Rng};
1852 use sys_common::io::test::{TempDir, tmpdir};
1856 use os::windows::fs::{symlink_dir, symlink_file};
1858 use sys::fs::symlink_junction;
1860 use os::unix::fs::symlink as symlink_dir;
1862 use os::unix::fs::symlink as symlink_file;
1864 use os::unix::fs::symlink as symlink_junction;
1866 macro_rules! check { ($e:expr) => (
1869 Err(e) => panic!("{} failed with: {}", stringify!($e), e),
1874 macro_rules! error { ($e:expr, $s:expr) => (
1876 Ok(_) => panic!("Unexpected success. Should've been: {:?}", $s),
1877 Err(ref err) => assert!(err.raw_os_error() == Some($s),
1878 format!("`{}` did not have a code of `{}`", err, $s))
1883 macro_rules! error { ($e:expr, $s:expr) => (
1885 Ok(_) => panic!("Unexpected success. Should've been: {:?}", $s),
1886 Err(ref err) => assert!(err.to_string().contains($s),
1887 format!("`{}` did not contain `{}`", err, $s))
1891 // Several test fail on windows if the user does not have permission to
1892 // create symlinks (the `SeCreateSymbolicLinkPrivilege`). Instead of
1893 // disabling these test on Windows, use this function to test whether we
1894 // have permission, and return otherwise. This way, we still don't run these
1895 // tests most of the time, but at least we do if the user has the right
1897 pub fn got_symlink_permission(tmpdir: &TempDir) -> bool {
1898 if cfg!(unix) { return true }
1899 let link = tmpdir.join("some_hopefully_unique_link_name");
1901 match symlink_file(r"nonexisting_target", link) {
1903 // ERROR_PRIVILEGE_NOT_HELD = 1314
1904 Err(ref err) if err.raw_os_error() == Some(1314) => false,
1910 fn file_test_io_smoke_test() {
1911 let message = "it's alright. have a good time";
1912 let tmpdir = tmpdir();
1913 let filename = &tmpdir.join("file_rt_io_file_test.txt");
1915 let mut write_stream = check!(File::create(filename));
1916 check!(write_stream.write(message.as_bytes()));
1919 let mut read_stream = check!(File::open(filename));
1920 let mut read_buf = [0; 1028];
1921 let read_str = match check!(read_stream.read(&mut read_buf)) {
1922 0 => panic!("shouldn't happen"),
1923 n => str::from_utf8(&read_buf[..n]).unwrap().to_string()
1925 assert_eq!(read_str, message);
1927 check!(fs::remove_file(filename));
1931 fn invalid_path_raises() {
1932 let tmpdir = tmpdir();
1933 let filename = &tmpdir.join("file_that_does_not_exist.txt");
1934 let result = File::open(filename);
1937 error!(result, "No such file or directory");
1939 error!(result, 2); // ERROR_FILE_NOT_FOUND
1943 fn file_test_iounlinking_invalid_path_should_raise_condition() {
1944 let tmpdir = tmpdir();
1945 let filename = &tmpdir.join("file_another_file_that_does_not_exist.txt");
1947 let result = fs::remove_file(filename);
1950 error!(result, "No such file or directory");
1952 error!(result, 2); // ERROR_FILE_NOT_FOUND
1956 fn file_test_io_non_positional_read() {
1957 let message: &str = "ten-four";
1958 let mut read_mem = [0; 8];
1959 let tmpdir = tmpdir();
1960 let filename = &tmpdir.join("file_rt_io_file_test_positional.txt");
1962 let mut rw_stream = check!(File::create(filename));
1963 check!(rw_stream.write(message.as_bytes()));
1966 let mut read_stream = check!(File::open(filename));
1968 let read_buf = &mut read_mem[0..4];
1969 check!(read_stream.read(read_buf));
1972 let read_buf = &mut read_mem[4..8];
1973 check!(read_stream.read(read_buf));
1976 check!(fs::remove_file(filename));
1977 let read_str = str::from_utf8(&read_mem).unwrap();
1978 assert_eq!(read_str, message);
1982 fn file_test_io_seek_and_tell_smoke_test() {
1983 let message = "ten-four";
1984 let mut read_mem = [0; 4];
1985 let set_cursor = 4 as u64;
1986 let tell_pos_pre_read;
1987 let tell_pos_post_read;
1988 let tmpdir = tmpdir();
1989 let filename = &tmpdir.join("file_rt_io_file_test_seeking.txt");
1991 let mut rw_stream = check!(File::create(filename));
1992 check!(rw_stream.write(message.as_bytes()));
1995 let mut read_stream = check!(File::open(filename));
1996 check!(read_stream.seek(SeekFrom::Start(set_cursor)));
1997 tell_pos_pre_read = check!(read_stream.seek(SeekFrom::Current(0)));
1998 check!(read_stream.read(&mut read_mem));
1999 tell_pos_post_read = check!(read_stream.seek(SeekFrom::Current(0)));
2001 check!(fs::remove_file(filename));
2002 let read_str = str::from_utf8(&read_mem).unwrap();
2003 assert_eq!(read_str, &message[4..8]);
2004 assert_eq!(tell_pos_pre_read, set_cursor);
2005 assert_eq!(tell_pos_post_read, message.len() as u64);
2009 fn file_test_io_seek_and_write() {
2010 let initial_msg = "food-is-yummy";
2011 let overwrite_msg = "-the-bar!!";
2012 let final_msg = "foo-the-bar!!";
2014 let mut read_mem = [0; 13];
2015 let tmpdir = tmpdir();
2016 let filename = &tmpdir.join("file_rt_io_file_test_seek_and_write.txt");
2018 let mut rw_stream = check!(File::create(filename));
2019 check!(rw_stream.write(initial_msg.as_bytes()));
2020 check!(rw_stream.seek(SeekFrom::Start(seek_idx)));
2021 check!(rw_stream.write(overwrite_msg.as_bytes()));
2024 let mut read_stream = check!(File::open(filename));
2025 check!(read_stream.read(&mut read_mem));
2027 check!(fs::remove_file(filename));
2028 let read_str = str::from_utf8(&read_mem).unwrap();
2029 assert!(read_str == final_msg);
2033 fn file_test_io_seek_shakedown() {
2035 let initial_msg = "qwer-asdf-zxcv";
2036 let chunk_one: &str = "qwer";
2037 let chunk_two: &str = "asdf";
2038 let chunk_three: &str = "zxcv";
2039 let mut read_mem = [0; 4];
2040 let tmpdir = tmpdir();
2041 let filename = &tmpdir.join("file_rt_io_file_test_seek_shakedown.txt");
2043 let mut rw_stream = check!(File::create(filename));
2044 check!(rw_stream.write(initial_msg.as_bytes()));
2047 let mut read_stream = check!(File::open(filename));
2049 check!(read_stream.seek(SeekFrom::End(-4)));
2050 check!(read_stream.read(&mut read_mem));
2051 assert_eq!(str::from_utf8(&read_mem).unwrap(), chunk_three);
2053 check!(read_stream.seek(SeekFrom::Current(-9)));
2054 check!(read_stream.read(&mut read_mem));
2055 assert_eq!(str::from_utf8(&read_mem).unwrap(), chunk_two);
2057 check!(read_stream.seek(SeekFrom::Start(0)));
2058 check!(read_stream.read(&mut read_mem));
2059 assert_eq!(str::from_utf8(&read_mem).unwrap(), chunk_one);
2061 check!(fs::remove_file(filename));
2065 fn file_test_io_eof() {
2066 let tmpdir = tmpdir();
2067 let filename = tmpdir.join("file_rt_io_file_test_eof.txt");
2068 let mut buf = [0; 256];
2070 let oo = OpenOptions::new().create_new(true).write(true).read(true).clone();
2071 let mut rw = check!(oo.open(&filename));
2072 assert_eq!(check!(rw.read(&mut buf)), 0);
2073 assert_eq!(check!(rw.read(&mut buf)), 0);
2075 check!(fs::remove_file(&filename));
2080 fn file_test_io_read_write_at() {
2081 use os::unix::fs::FileExt;
2083 let tmpdir = tmpdir();
2084 let filename = tmpdir.join("file_rt_io_file_test_read_write_at.txt");
2085 let mut buf = [0; 256];
2086 let write1 = "asdf";
2087 let write2 = "qwer-";
2088 let write3 = "-zxcv";
2089 let content = "qwer-asdf-zxcv";
2091 let oo = OpenOptions::new().create_new(true).write(true).read(true).clone();
2092 let mut rw = check!(oo.open(&filename));
2093 assert_eq!(check!(rw.write_at(write1.as_bytes(), 5)), write1.len());
2094 assert_eq!(check!(rw.seek(SeekFrom::Current(0))), 0);
2095 assert_eq!(check!(rw.read_at(&mut buf, 5)), write1.len());
2096 assert_eq!(str::from_utf8(&buf[..write1.len()]), Ok(write1));
2097 assert_eq!(check!(rw.seek(SeekFrom::Current(0))), 0);
2098 assert_eq!(check!(rw.read_at(&mut buf[..write2.len()], 0)), write2.len());
2099 assert_eq!(str::from_utf8(&buf[..write2.len()]), Ok("\0\0\0\0\0"));
2100 assert_eq!(check!(rw.seek(SeekFrom::Current(0))), 0);
2101 assert_eq!(check!(rw.write(write2.as_bytes())), write2.len());
2102 assert_eq!(check!(rw.seek(SeekFrom::Current(0))), 5);
2103 assert_eq!(check!(rw.read(&mut buf)), write1.len());
2104 assert_eq!(str::from_utf8(&buf[..write1.len()]), Ok(write1));
2105 assert_eq!(check!(rw.seek(SeekFrom::Current(0))), 9);
2106 assert_eq!(check!(rw.read_at(&mut buf[..write2.len()], 0)), write2.len());
2107 assert_eq!(str::from_utf8(&buf[..write2.len()]), Ok(write2));
2108 assert_eq!(check!(rw.seek(SeekFrom::Current(0))), 9);
2109 assert_eq!(check!(rw.write_at(write3.as_bytes(), 9)), write3.len());
2110 assert_eq!(check!(rw.seek(SeekFrom::Current(0))), 9);
2113 let mut read = check!(File::open(&filename));
2114 assert_eq!(check!(read.read_at(&mut buf, 0)), content.len());
2115 assert_eq!(str::from_utf8(&buf[..content.len()]), Ok(content));
2116 assert_eq!(check!(read.seek(SeekFrom::Current(0))), 0);
2117 assert_eq!(check!(read.seek(SeekFrom::End(-5))), 9);
2118 assert_eq!(check!(read.read_at(&mut buf, 0)), content.len());
2119 assert_eq!(str::from_utf8(&buf[..content.len()]), Ok(content));
2120 assert_eq!(check!(read.seek(SeekFrom::Current(0))), 9);
2121 assert_eq!(check!(read.read(&mut buf)), write3.len());
2122 assert_eq!(str::from_utf8(&buf[..write3.len()]), Ok(write3));
2123 assert_eq!(check!(read.seek(SeekFrom::Current(0))), 14);
2124 assert_eq!(check!(read.read_at(&mut buf, 0)), content.len());
2125 assert_eq!(str::from_utf8(&buf[..content.len()]), Ok(content));
2126 assert_eq!(check!(read.seek(SeekFrom::Current(0))), 14);
2127 assert_eq!(check!(read.read_at(&mut buf, 14)), 0);
2128 assert_eq!(check!(read.read_at(&mut buf, 15)), 0);
2129 assert_eq!(check!(read.seek(SeekFrom::Current(0))), 14);
2131 check!(fs::remove_file(&filename));
2136 fn file_test_io_seek_read_write() {
2137 use os::windows::fs::FileExt;
2139 let tmpdir = tmpdir();
2140 let filename = tmpdir.join("file_rt_io_file_test_seek_read_write.txt");
2141 let mut buf = [0; 256];
2142 let write1 = "asdf";
2143 let write2 = "qwer-";
2144 let write3 = "-zxcv";
2145 let content = "qwer-asdf-zxcv";
2147 let oo = OpenOptions::new().create_new(true).write(true).read(true).clone();
2148 let mut rw = check!(oo.open(&filename));
2149 assert_eq!(check!(rw.seek_write(write1.as_bytes(), 5)), write1.len());
2150 assert_eq!(check!(rw.seek(SeekFrom::Current(0))), 9);
2151 assert_eq!(check!(rw.seek_read(&mut buf, 5)), write1.len());
2152 assert_eq!(str::from_utf8(&buf[..write1.len()]), Ok(write1));
2153 assert_eq!(check!(rw.seek(SeekFrom::Current(0))), 9);
2154 assert_eq!(check!(rw.seek(SeekFrom::Start(0))), 0);
2155 assert_eq!(check!(rw.write(write2.as_bytes())), write2.len());
2156 assert_eq!(check!(rw.seek(SeekFrom::Current(0))), 5);
2157 assert_eq!(check!(rw.read(&mut buf)), write1.len());
2158 assert_eq!(str::from_utf8(&buf[..write1.len()]), Ok(write1));
2159 assert_eq!(check!(rw.seek(SeekFrom::Current(0))), 9);
2160 assert_eq!(check!(rw.seek_read(&mut buf[..write2.len()], 0)), write2.len());
2161 assert_eq!(str::from_utf8(&buf[..write2.len()]), Ok(write2));
2162 assert_eq!(check!(rw.seek(SeekFrom::Current(0))), 5);
2163 assert_eq!(check!(rw.seek_write(write3.as_bytes(), 9)), write3.len());
2164 assert_eq!(check!(rw.seek(SeekFrom::Current(0))), 14);
2167 let mut read = check!(File::open(&filename));
2168 assert_eq!(check!(read.seek_read(&mut buf, 0)), content.len());
2169 assert_eq!(str::from_utf8(&buf[..content.len()]), Ok(content));
2170 assert_eq!(check!(read.seek(SeekFrom::Current(0))), 14);
2171 assert_eq!(check!(read.seek(SeekFrom::End(-5))), 9);
2172 assert_eq!(check!(read.seek_read(&mut buf, 0)), content.len());
2173 assert_eq!(str::from_utf8(&buf[..content.len()]), Ok(content));
2174 assert_eq!(check!(read.seek(SeekFrom::Current(0))), 14);
2175 assert_eq!(check!(read.seek(SeekFrom::End(-5))), 9);
2176 assert_eq!(check!(read.read(&mut buf)), write3.len());
2177 assert_eq!(str::from_utf8(&buf[..write3.len()]), Ok(write3));
2178 assert_eq!(check!(read.seek(SeekFrom::Current(0))), 14);
2179 assert_eq!(check!(read.seek_read(&mut buf, 0)), content.len());
2180 assert_eq!(str::from_utf8(&buf[..content.len()]), Ok(content));
2181 assert_eq!(check!(read.seek(SeekFrom::Current(0))), 14);
2182 assert_eq!(check!(read.seek_read(&mut buf, 14)), 0);
2183 assert_eq!(check!(read.seek_read(&mut buf, 15)), 0);
2185 check!(fs::remove_file(&filename));
2189 fn file_test_stat_is_correct_on_is_file() {
2190 let tmpdir = tmpdir();
2191 let filename = &tmpdir.join("file_stat_correct_on_is_file.txt");
2193 let mut opts = OpenOptions::new();
2194 let mut fs = check!(opts.read(true).write(true)
2195 .create(true).open(filename));
2197 fs.write(msg.as_bytes()).unwrap();
2199 let fstat_res = check!(fs.metadata());
2200 assert!(fstat_res.is_file());
2202 let stat_res_fn = check!(fs::metadata(filename));
2203 assert!(stat_res_fn.is_file());
2204 let stat_res_meth = check!(filename.metadata());
2205 assert!(stat_res_meth.is_file());
2206 check!(fs::remove_file(filename));
2210 fn file_test_stat_is_correct_on_is_dir() {
2211 let tmpdir = tmpdir();
2212 let filename = &tmpdir.join("file_stat_correct_on_is_dir");
2213 check!(fs::create_dir(filename));
2214 let stat_res_fn = check!(fs::metadata(filename));
2215 assert!(stat_res_fn.is_dir());
2216 let stat_res_meth = check!(filename.metadata());
2217 assert!(stat_res_meth.is_dir());
2218 check!(fs::remove_dir(filename));
2222 fn file_test_fileinfo_false_when_checking_is_file_on_a_directory() {
2223 let tmpdir = tmpdir();
2224 let dir = &tmpdir.join("fileinfo_false_on_dir");
2225 check!(fs::create_dir(dir));
2226 assert!(!dir.is_file());
2227 check!(fs::remove_dir(dir));
2231 fn file_test_fileinfo_check_exists_before_and_after_file_creation() {
2232 let tmpdir = tmpdir();
2233 let file = &tmpdir.join("fileinfo_check_exists_b_and_a.txt");
2234 check!(check!(File::create(file)).write(b"foo"));
2235 assert!(file.exists());
2236 check!(fs::remove_file(file));
2237 assert!(!file.exists());
2241 fn file_test_directoryinfo_check_exists_before_and_after_mkdir() {
2242 let tmpdir = tmpdir();
2243 let dir = &tmpdir.join("before_and_after_dir");
2244 assert!(!dir.exists());
2245 check!(fs::create_dir(dir));
2246 assert!(dir.exists());
2247 assert!(dir.is_dir());
2248 check!(fs::remove_dir(dir));
2249 assert!(!dir.exists());
2253 fn file_test_directoryinfo_readdir() {
2254 let tmpdir = tmpdir();
2255 let dir = &tmpdir.join("di_readdir");
2256 check!(fs::create_dir(dir));
2259 let f = dir.join(&format!("{}.txt", n));
2260 let mut w = check!(File::create(&f));
2261 let msg_str = format!("{}{}", prefix, n.to_string());
2262 let msg = msg_str.as_bytes();
2263 check!(w.write(msg));
2265 let files = check!(fs::read_dir(dir));
2266 let mut mem = [0; 4];
2268 let f = f.unwrap().path();
2270 let n = f.file_stem().unwrap();
2271 check!(check!(File::open(&f)).read(&mut mem));
2272 let read_str = str::from_utf8(&mem).unwrap();
2273 let expected = format!("{}{}", prefix, n.to_str().unwrap());
2274 assert_eq!(expected, read_str);
2276 check!(fs::remove_file(&f));
2278 check!(fs::remove_dir(dir));
2282 fn file_create_new_already_exists_error() {
2283 let tmpdir = tmpdir();
2284 let file = &tmpdir.join("file_create_new_error_exists");
2285 check!(fs::File::create(file));
2286 let e = fs::OpenOptions::new().write(true).create_new(true).open(file).unwrap_err();
2287 assert_eq!(e.kind(), ErrorKind::AlreadyExists);
2291 fn mkdir_path_already_exists_error() {
2292 let tmpdir = tmpdir();
2293 let dir = &tmpdir.join("mkdir_error_twice");
2294 check!(fs::create_dir(dir));
2295 let e = fs::create_dir(dir).unwrap_err();
2296 assert_eq!(e.kind(), ErrorKind::AlreadyExists);
2300 fn recursive_mkdir() {
2301 let tmpdir = tmpdir();
2302 let dir = tmpdir.join("d1/d2");
2303 check!(fs::create_dir_all(&dir));
2304 assert!(dir.is_dir())
2308 fn recursive_mkdir_failure() {
2309 let tmpdir = tmpdir();
2310 let dir = tmpdir.join("d1");
2311 let file = dir.join("f1");
2313 check!(fs::create_dir_all(&dir));
2314 check!(File::create(&file));
2316 let result = fs::create_dir_all(&file);
2318 assert!(result.is_err());
2322 fn concurrent_recursive_mkdir() {
2325 let mut dir = dir.join("a");
2327 dir = dir.join("a");
2329 let mut join = vec!();
2331 let dir = dir.clone();
2332 join.push(thread::spawn(move || {
2333 check!(fs::create_dir_all(&dir));
2337 // No `Display` on result of `join()`
2338 join.drain(..).map(|join| join.join().unwrap()).count();
2343 fn recursive_mkdir_slash() {
2344 check!(fs::create_dir_all(&Path::new("/")));
2348 fn recursive_mkdir_dot() {
2349 check!(fs::create_dir_all(&Path::new(".")));
2353 fn recursive_mkdir_empty() {
2354 check!(fs::create_dir_all(&Path::new("")));
2358 fn recursive_rmdir() {
2359 let tmpdir = tmpdir();
2360 let d1 = tmpdir.join("d1");
2361 let dt = d1.join("t");
2362 let dtt = dt.join("t");
2363 let d2 = tmpdir.join("d2");
2364 let canary = d2.join("do_not_delete");
2365 check!(fs::create_dir_all(&dtt));
2366 check!(fs::create_dir_all(&d2));
2367 check!(check!(File::create(&canary)).write(b"foo"));
2368 check!(symlink_junction(&d2, &dt.join("d2")));
2369 let _ = symlink_file(&canary, &d1.join("canary"));
2370 check!(fs::remove_dir_all(&d1));
2372 assert!(!d1.is_dir());
2373 assert!(canary.exists());
2377 fn recursive_rmdir_of_symlink() {
2378 // test we do not recursively delete a symlink but only dirs.
2379 let tmpdir = tmpdir();
2380 let link = tmpdir.join("d1");
2381 let dir = tmpdir.join("d2");
2382 let canary = dir.join("do_not_delete");
2383 check!(fs::create_dir_all(&dir));
2384 check!(check!(File::create(&canary)).write(b"foo"));
2385 check!(symlink_junction(&dir, &link));
2386 check!(fs::remove_dir_all(&link));
2388 assert!(!link.is_dir());
2389 assert!(canary.exists());
2393 // only Windows makes a distinction between file and directory symlinks.
2395 fn recursive_rmdir_of_file_symlink() {
2396 let tmpdir = tmpdir();
2397 if !got_symlink_permission(&tmpdir) { return };
2399 let f1 = tmpdir.join("f1");
2400 let f2 = tmpdir.join("f2");
2401 check!(check!(File::create(&f1)).write(b"foo"));
2402 check!(symlink_file(&f1, &f2));
2403 match fs::remove_dir_all(&f2) {
2404 Ok(..) => panic!("wanted a failure"),
2410 fn unicode_path_is_dir() {
2411 assert!(Path::new(".").is_dir());
2412 assert!(!Path::new("test/stdtest/fs.rs").is_dir());
2414 let tmpdir = tmpdir();
2416 let mut dirpath = tmpdir.path().to_path_buf();
2417 dirpath.push("test-가一ー你好");
2418 check!(fs::create_dir(&dirpath));
2419 assert!(dirpath.is_dir());
2421 let mut filepath = dirpath;
2422 filepath.push("unicode-file-\u{ac00}\u{4e00}\u{30fc}\u{4f60}\u{597d}.rs");
2423 check!(File::create(&filepath)); // ignore return; touch only
2424 assert!(!filepath.is_dir());
2425 assert!(filepath.exists());
2429 fn unicode_path_exists() {
2430 assert!(Path::new(".").exists());
2431 assert!(!Path::new("test/nonexistent-bogus-path").exists());
2433 let tmpdir = tmpdir();
2434 let unicode = tmpdir.path();
2435 let unicode = unicode.join("test-각丁ー再见");
2436 check!(fs::create_dir(&unicode));
2437 assert!(unicode.exists());
2438 assert!(!Path::new("test/unicode-bogus-path-각丁ー再见").exists());
2442 fn copy_file_does_not_exist() {
2443 let from = Path::new("test/nonexistent-bogus-path");
2444 let to = Path::new("test/other-bogus-path");
2446 match fs::copy(&from, &to) {
2449 assert!(!from.exists());
2450 assert!(!to.exists());
2456 fn copy_src_does_not_exist() {
2457 let tmpdir = tmpdir();
2458 let from = Path::new("test/nonexistent-bogus-path");
2459 let to = tmpdir.join("out.txt");
2460 check!(check!(File::create(&to)).write(b"hello"));
2461 assert!(fs::copy(&from, &to).is_err());
2462 assert!(!from.exists());
2463 let mut v = Vec::new();
2464 check!(check!(File::open(&to)).read_to_end(&mut v));
2465 assert_eq!(v, b"hello");
2470 let tmpdir = tmpdir();
2471 let input = tmpdir.join("in.txt");
2472 let out = tmpdir.join("out.txt");
2474 check!(check!(File::create(&input)).write(b"hello"));
2475 check!(fs::copy(&input, &out));
2476 let mut v = Vec::new();
2477 check!(check!(File::open(&out)).read_to_end(&mut v));
2478 assert_eq!(v, b"hello");
2480 assert_eq!(check!(input.metadata()).permissions(),
2481 check!(out.metadata()).permissions());
2485 fn copy_file_dst_dir() {
2486 let tmpdir = tmpdir();
2487 let out = tmpdir.join("out");
2489 check!(File::create(&out));
2490 match fs::copy(&*out, tmpdir.path()) {
2491 Ok(..) => panic!(), Err(..) => {}
2496 fn copy_file_dst_exists() {
2497 let tmpdir = tmpdir();
2498 let input = tmpdir.join("in");
2499 let output = tmpdir.join("out");
2501 check!(check!(File::create(&input)).write("foo".as_bytes()));
2502 check!(check!(File::create(&output)).write("bar".as_bytes()));
2503 check!(fs::copy(&input, &output));
2505 let mut v = Vec::new();
2506 check!(check!(File::open(&output)).read_to_end(&mut v));
2507 assert_eq!(v, b"foo".to_vec());
2511 fn copy_file_src_dir() {
2512 let tmpdir = tmpdir();
2513 let out = tmpdir.join("out");
2515 match fs::copy(tmpdir.path(), &out) {
2516 Ok(..) => panic!(), Err(..) => {}
2518 assert!(!out.exists());
2522 fn copy_file_preserves_perm_bits() {
2523 let tmpdir = tmpdir();
2524 let input = tmpdir.join("in.txt");
2525 let out = tmpdir.join("out.txt");
2527 let attr = check!(check!(File::create(&input)).metadata());
2528 let mut p = attr.permissions();
2529 p.set_readonly(true);
2530 check!(fs::set_permissions(&input, p));
2531 check!(fs::copy(&input, &out));
2532 assert!(check!(out.metadata()).permissions().readonly());
2533 check!(fs::set_permissions(&input, attr.permissions()));
2534 check!(fs::set_permissions(&out, attr.permissions()));
2539 fn copy_file_preserves_streams() {
2541 check!(check!(File::create(tmp.join("in.txt:bunny"))).write("carrot".as_bytes()));
2542 assert_eq!(check!(fs::copy(tmp.join("in.txt"), tmp.join("out.txt"))), 6);
2543 assert_eq!(check!(tmp.join("out.txt").metadata()).len(), 0);
2544 let mut v = Vec::new();
2545 check!(check!(File::open(tmp.join("out.txt:bunny"))).read_to_end(&mut v));
2546 assert_eq!(v, b"carrot".to_vec());
2550 fn symlinks_work() {
2551 let tmpdir = tmpdir();
2552 if !got_symlink_permission(&tmpdir) { return };
2554 let input = tmpdir.join("in.txt");
2555 let out = tmpdir.join("out.txt");
2557 check!(check!(File::create(&input)).write("foobar".as_bytes()));
2558 check!(symlink_file(&input, &out));
2559 assert!(check!(out.symlink_metadata()).file_type().is_symlink());
2560 assert_eq!(check!(fs::metadata(&out)).len(),
2561 check!(fs::metadata(&input)).len());
2562 let mut v = Vec::new();
2563 check!(check!(File::open(&out)).read_to_end(&mut v));
2564 assert_eq!(v, b"foobar".to_vec());
2568 fn symlink_noexist() {
2569 // Symlinks can point to things that don't exist
2570 let tmpdir = tmpdir();
2571 if !got_symlink_permission(&tmpdir) { return };
2573 // Use a relative path for testing. Symlinks get normalized by Windows,
2574 // so we may not get the same path back for absolute paths
2575 check!(symlink_file(&"foo", &tmpdir.join("bar")));
2576 assert_eq!(check!(fs::read_link(&tmpdir.join("bar"))).to_str().unwrap(),
2583 // directory symlink
2584 assert_eq!(check!(fs::read_link(r"C:\Users\All Users")).to_str().unwrap(),
2587 assert_eq!(check!(fs::read_link(r"C:\Users\Default User")).to_str().unwrap(),
2588 r"C:\Users\Default");
2589 // junction with special permissions
2590 assert_eq!(check!(fs::read_link(r"C:\Documents and Settings\")).to_str().unwrap(),
2593 let tmpdir = tmpdir();
2594 let link = tmpdir.join("link");
2595 if !got_symlink_permission(&tmpdir) { return };
2596 check!(symlink_file(&"foo", &link));
2597 assert_eq!(check!(fs::read_link(&link)).to_str().unwrap(), "foo");
2601 fn readlink_not_symlink() {
2602 let tmpdir = tmpdir();
2603 match fs::read_link(tmpdir.path()) {
2604 Ok(..) => panic!("wanted a failure"),
2611 let tmpdir = tmpdir();
2612 let input = tmpdir.join("in.txt");
2613 let out = tmpdir.join("out.txt");
2615 check!(check!(File::create(&input)).write("foobar".as_bytes()));
2616 check!(fs::hard_link(&input, &out));
2617 assert_eq!(check!(fs::metadata(&out)).len(),
2618 check!(fs::metadata(&input)).len());
2619 assert_eq!(check!(fs::metadata(&out)).len(),
2620 check!(input.metadata()).len());
2621 let mut v = Vec::new();
2622 check!(check!(File::open(&out)).read_to_end(&mut v));
2623 assert_eq!(v, b"foobar".to_vec());
2625 // can't link to yourself
2626 match fs::hard_link(&input, &input) {
2627 Ok(..) => panic!("wanted a failure"),
2630 // can't link to something that doesn't exist
2631 match fs::hard_link(&tmpdir.join("foo"), &tmpdir.join("bar")) {
2632 Ok(..) => panic!("wanted a failure"),
2639 let tmpdir = tmpdir();
2640 let file = tmpdir.join("in.txt");
2642 check!(File::create(&file));
2643 let attr = check!(fs::metadata(&file));
2644 assert!(!attr.permissions().readonly());
2645 let mut p = attr.permissions();
2646 p.set_readonly(true);
2647 check!(fs::set_permissions(&file, p.clone()));
2648 let attr = check!(fs::metadata(&file));
2649 assert!(attr.permissions().readonly());
2651 match fs::set_permissions(&tmpdir.join("foo"), p.clone()) {
2652 Ok(..) => panic!("wanted an error"),
2656 p.set_readonly(false);
2657 check!(fs::set_permissions(&file, p));
2662 let tmpdir = tmpdir();
2663 let path = tmpdir.join("in.txt");
2665 let file = check!(File::create(&path));
2666 let attr = check!(fs::metadata(&path));
2667 assert!(!attr.permissions().readonly());
2668 let mut p = attr.permissions();
2669 p.set_readonly(true);
2670 check!(file.set_permissions(p.clone()));
2671 let attr = check!(fs::metadata(&path));
2672 assert!(attr.permissions().readonly());
2674 p.set_readonly(false);
2675 check!(file.set_permissions(p));
2679 fn sync_doesnt_kill_anything() {
2680 let tmpdir = tmpdir();
2681 let path = tmpdir.join("in.txt");
2683 let mut file = check!(File::create(&path));
2684 check!(file.sync_all());
2685 check!(file.sync_data());
2686 check!(file.write(b"foo"));
2687 check!(file.sync_all());
2688 check!(file.sync_data());
2692 fn truncate_works() {
2693 let tmpdir = tmpdir();
2694 let path = tmpdir.join("in.txt");
2696 let mut file = check!(File::create(&path));
2697 check!(file.write(b"foo"));
2698 check!(file.sync_all());
2700 // Do some simple things with truncation
2701 assert_eq!(check!(file.metadata()).len(), 3);
2702 check!(file.set_len(10));
2703 assert_eq!(check!(file.metadata()).len(), 10);
2704 check!(file.write(b"bar"));
2705 check!(file.sync_all());
2706 assert_eq!(check!(file.metadata()).len(), 10);
2708 let mut v = Vec::new();
2709 check!(check!(File::open(&path)).read_to_end(&mut v));
2710 assert_eq!(v, b"foobar\0\0\0\0".to_vec());
2712 // Truncate to a smaller length, don't seek, and then write something.
2713 // Ensure that the intermediate zeroes are all filled in (we have `seek`ed
2714 // past the end of the file).
2715 check!(file.set_len(2));
2716 assert_eq!(check!(file.metadata()).len(), 2);
2717 check!(file.write(b"wut"));
2718 check!(file.sync_all());
2719 assert_eq!(check!(file.metadata()).len(), 9);
2720 let mut v = Vec::new();
2721 check!(check!(File::open(&path)).read_to_end(&mut v));
2722 assert_eq!(v, b"fo\0\0\0\0wut".to_vec());
2727 use fs::OpenOptions as OO;
2728 fn c<T: Clone>(t: &T) -> T { t.clone() }
2730 let tmpdir = tmpdir();
2732 let mut r = OO::new(); r.read(true);
2733 let mut w = OO::new(); w.write(true);
2734 let mut rw = OO::new(); rw.read(true).write(true);
2735 let mut a = OO::new(); a.append(true);
2736 let mut ra = OO::new(); ra.read(true).append(true);
2739 let invalid_options = 87; // ERROR_INVALID_PARAMETER
2741 let invalid_options = "Invalid argument";
2743 // Test various combinations of creation modes and access modes.
2746 // creation mode | read | write | read-write | append | read-append |
2747 // :-----------------------|:-----:|:-----:|:----------:|:------:|:-----------:|
2748 // not set (open existing) | X | X | X | X | X |
2749 // create | | X | X | X | X |
2750 // truncate | | X | X | | |
2751 // create and truncate | | X | X | | |
2752 // create_new | | X | X | X | X |
2754 // tested in reverse order, so 'create_new' creates the file, and 'open existing' opens it.
2757 check!(c(&w).create_new(true).open(&tmpdir.join("a")));
2758 check!(c(&w).create(true).truncate(true).open(&tmpdir.join("a")));
2759 check!(c(&w).truncate(true).open(&tmpdir.join("a")));
2760 check!(c(&w).create(true).open(&tmpdir.join("a")));
2761 check!(c(&w).open(&tmpdir.join("a")));
2764 error!(c(&r).create_new(true).open(&tmpdir.join("b")), invalid_options);
2765 error!(c(&r).create(true).truncate(true).open(&tmpdir.join("b")), invalid_options);
2766 error!(c(&r).truncate(true).open(&tmpdir.join("b")), invalid_options);
2767 error!(c(&r).create(true).open(&tmpdir.join("b")), invalid_options);
2768 check!(c(&r).open(&tmpdir.join("a"))); // try opening the file created with write_only
2771 check!(c(&rw).create_new(true).open(&tmpdir.join("c")));
2772 check!(c(&rw).create(true).truncate(true).open(&tmpdir.join("c")));
2773 check!(c(&rw).truncate(true).open(&tmpdir.join("c")));
2774 check!(c(&rw).create(true).open(&tmpdir.join("c")));
2775 check!(c(&rw).open(&tmpdir.join("c")));
2778 check!(c(&a).create_new(true).open(&tmpdir.join("d")));
2779 error!(c(&a).create(true).truncate(true).open(&tmpdir.join("d")), invalid_options);
2780 error!(c(&a).truncate(true).open(&tmpdir.join("d")), invalid_options);
2781 check!(c(&a).create(true).open(&tmpdir.join("d")));
2782 check!(c(&a).open(&tmpdir.join("d")));
2785 check!(c(&ra).create_new(true).open(&tmpdir.join("e")));
2786 error!(c(&ra).create(true).truncate(true).open(&tmpdir.join("e")), invalid_options);
2787 error!(c(&ra).truncate(true).open(&tmpdir.join("e")), invalid_options);
2788 check!(c(&ra).create(true).open(&tmpdir.join("e")));
2789 check!(c(&ra).open(&tmpdir.join("e")));
2791 // Test opening a file without setting an access mode
2792 let mut blank = OO::new();
2793 error!(blank.create(true).open(&tmpdir.join("f")), invalid_options);
2796 check!(check!(File::create(&tmpdir.join("h"))).write("foobar".as_bytes()));
2798 // Test write fails for read-only
2799 check!(r.open(&tmpdir.join("h")));
2801 let mut f = check!(r.open(&tmpdir.join("h")));
2802 assert!(f.write("wut".as_bytes()).is_err());
2805 // Test write overwrites
2807 let mut f = check!(c(&w).open(&tmpdir.join("h")));
2808 check!(f.write("baz".as_bytes()));
2811 let mut f = check!(c(&r).open(&tmpdir.join("h")));
2812 let mut b = vec![0; 6];
2813 check!(f.read(&mut b));
2814 assert_eq!(b, "bazbar".as_bytes());
2817 // Test truncate works
2819 let mut f = check!(c(&w).truncate(true).open(&tmpdir.join("h")));
2820 check!(f.write("foo".as_bytes()));
2822 assert_eq!(check!(fs::metadata(&tmpdir.join("h"))).len(), 3);
2824 // Test append works
2825 assert_eq!(check!(fs::metadata(&tmpdir.join("h"))).len(), 3);
2827 let mut f = check!(c(&a).open(&tmpdir.join("h")));
2828 check!(f.write("bar".as_bytes()));
2830 assert_eq!(check!(fs::metadata(&tmpdir.join("h"))).len(), 6);
2832 // Test .append(true) equals .write(true).append(true)
2834 let mut f = check!(c(&w).append(true).open(&tmpdir.join("h")));
2835 check!(f.write("baz".as_bytes()));
2837 assert_eq!(check!(fs::metadata(&tmpdir.join("h"))).len(), 9);
2841 fn _assert_send_sync() {
2842 fn _assert_send_sync<T: Send + Sync>() {}
2843 _assert_send_sync::<OpenOptions>();
2848 let mut bytes = [0; 1024];
2849 StdRng::new().unwrap().fill_bytes(&mut bytes);
2851 let tmpdir = tmpdir();
2853 check!(check!(File::create(&tmpdir.join("test"))).write(&bytes));
2854 let mut v = Vec::new();
2855 check!(check!(File::open(&tmpdir.join("test"))).read_to_end(&mut v));
2856 assert!(v == &bytes[..]);
2860 fn file_try_clone() {
2861 let tmpdir = tmpdir();
2863 let mut f1 = check!(OpenOptions::new()
2867 .open(&tmpdir.join("test")));
2868 let mut f2 = check!(f1.try_clone());
2870 check!(f1.write_all(b"hello world"));
2871 check!(f1.seek(SeekFrom::Start(2)));
2873 let mut buf = vec![];
2874 check!(f2.read_to_end(&mut buf));
2875 assert_eq!(buf, b"llo world");
2878 check!(f1.write_all(b"!"));
2882 #[cfg(not(windows))]
2883 fn unlink_readonly() {
2884 let tmpdir = tmpdir();
2885 let path = tmpdir.join("file");
2886 check!(File::create(&path));
2887 let mut perm = check!(fs::metadata(&path)).permissions();
2888 perm.set_readonly(true);
2889 check!(fs::set_permissions(&path, perm));
2890 check!(fs::remove_file(&path));
2894 fn mkdir_trailing_slash() {
2895 let tmpdir = tmpdir();
2896 let path = tmpdir.join("file");
2897 check!(fs::create_dir_all(&path.join("a/")));
2901 fn canonicalize_works_simple() {
2902 let tmpdir = tmpdir();
2903 let tmpdir = fs::canonicalize(tmpdir.path()).unwrap();
2904 let file = tmpdir.join("test");
2905 File::create(&file).unwrap();
2906 assert_eq!(fs::canonicalize(&file).unwrap(), file);
2910 fn realpath_works() {
2911 let tmpdir = tmpdir();
2912 if !got_symlink_permission(&tmpdir) { return };
2914 let tmpdir = fs::canonicalize(tmpdir.path()).unwrap();
2915 let file = tmpdir.join("test");
2916 let dir = tmpdir.join("test2");
2917 let link = dir.join("link");
2918 let linkdir = tmpdir.join("test3");
2920 File::create(&file).unwrap();
2921 fs::create_dir(&dir).unwrap();
2922 symlink_file(&file, &link).unwrap();
2923 symlink_dir(&dir, &linkdir).unwrap();
2925 assert!(link.symlink_metadata().unwrap().file_type().is_symlink());
2927 assert_eq!(fs::canonicalize(&tmpdir).unwrap(), tmpdir);
2928 assert_eq!(fs::canonicalize(&file).unwrap(), file);
2929 assert_eq!(fs::canonicalize(&link).unwrap(), file);
2930 assert_eq!(fs::canonicalize(&linkdir).unwrap(), dir);
2931 assert_eq!(fs::canonicalize(&linkdir.join("link")).unwrap(), file);
2935 fn realpath_works_tricky() {
2936 let tmpdir = tmpdir();
2937 if !got_symlink_permission(&tmpdir) { return };
2939 let tmpdir = fs::canonicalize(tmpdir.path()).unwrap();
2940 let a = tmpdir.join("a");
2941 let b = a.join("b");
2942 let c = b.join("c");
2943 let d = a.join("d");
2944 let e = d.join("e");
2945 let f = a.join("f");
2947 fs::create_dir_all(&b).unwrap();
2948 fs::create_dir_all(&d).unwrap();
2949 File::create(&f).unwrap();
2950 if cfg!(not(windows)) {
2951 symlink_dir("../d/e", &c).unwrap();
2952 symlink_file("../f", &e).unwrap();
2955 symlink_dir(r"..\d\e", &c).unwrap();
2956 symlink_file(r"..\f", &e).unwrap();
2959 assert_eq!(fs::canonicalize(&c).unwrap(), f);
2960 assert_eq!(fs::canonicalize(&e).unwrap(), f);
2964 fn dir_entry_methods() {
2965 let tmpdir = tmpdir();
2967 fs::create_dir_all(&tmpdir.join("a")).unwrap();
2968 File::create(&tmpdir.join("b")).unwrap();
2970 for file in tmpdir.path().read_dir().unwrap().map(|f| f.unwrap()) {
2971 let fname = file.file_name();
2972 match fname.to_str() {
2974 assert!(file.file_type().unwrap().is_dir());
2975 assert!(file.metadata().unwrap().is_dir());
2978 assert!(file.file_type().unwrap().is_file());
2979 assert!(file.metadata().unwrap().is_file());
2981 f => panic!("unknown file name: {:?}", f),
2987 fn dir_entry_debug() {
2988 let tmpdir = tmpdir();
2989 File::create(&tmpdir.join("b")).unwrap();
2990 let mut read_dir = tmpdir.path().read_dir().unwrap();
2991 let dir_entry = read_dir.next().unwrap().unwrap();
2992 let actual = format!("{:?}", dir_entry);
2993 let expected = format!("DirEntry({:?})", dir_entry.0.path());
2994 assert_eq!(actual, expected);
2998 fn read_dir_not_found() {
2999 let res = fs::read_dir("/path/that/does/not/exist");
3000 assert_eq!(res.err().unwrap().kind(), ErrorKind::NotFound);
3004 fn create_dir_all_with_junctions() {
3005 let tmpdir = tmpdir();
3006 let target = tmpdir.join("target");
3008 let junction = tmpdir.join("junction");
3009 let b = junction.join("a/b");
3011 let link = tmpdir.join("link");
3012 let d = link.join("c/d");
3014 fs::create_dir(&target).unwrap();
3016 check!(symlink_junction(&target, &junction));
3017 check!(fs::create_dir_all(&b));
3018 // the junction itself is not a directory, but `is_dir()` on a Path
3020 assert!(junction.is_dir());
3021 assert!(b.exists());
3023 if !got_symlink_permission(&tmpdir) { return };
3024 check!(symlink_dir(&target, &link));
3025 check!(fs::create_dir_all(&d));
3026 assert!(link.is_dir());
3027 assert!(d.exists());
3031 fn metadata_access_times() {
3032 let tmpdir = tmpdir();
3034 let b = tmpdir.join("b");
3035 File::create(&b).unwrap();
3037 let a = check!(fs::metadata(&tmpdir.path()));
3038 let b = check!(fs::metadata(&b));
3040 assert_eq!(check!(a.accessed()), check!(a.accessed()));
3041 assert_eq!(check!(a.modified()), check!(a.modified()));
3042 assert_eq!(check!(b.accessed()), check!(b.modified()));
3044 if cfg!(target_os = "macos") || cfg!(target_os = "windows") {
3045 check!(a.created());
3046 check!(b.created());