src/libstd/fs.rs

   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.
   4 //
   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.
  10
  11 //! Filesystem manipulation operations.
  12 //!
  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`.
  17
  18 #![stable(feature = "rust1", since = "1.0.0")]
  19
  20 use fmt;
  21 use ffi::OsString;
  22 use io::{self, SeekFrom, Seek, Read, Write};
  23 use path::{Path, PathBuf};
  24 use sys::fs as fs_imp;
  25 use sys_common::{AsInnerMut, FromInner, AsInner, IntoInner};
  26 use vec::Vec;
  27 use time::SystemTime;
  28
  29 /// A reference to an open file on the filesystem.
  30 ///
  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.
  34 ///
  35 /// # Examples
  36 ///
  37 /// ```no_run
  38 /// use std::io::prelude::*;
  39 /// use std::fs::File;
  40 ///
  41 /// # fn foo() -> std::io::Result<()> {
  42 /// let mut f = try!(File::create("foo.txt"));
  43 /// try!(f.write_all(b"Hello, world!"));
  44 ///
  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!");
  49 /// # Ok(())
  50 /// # }
  51 /// ```
  52 #[stable(feature = "rust1", since = "1.0.0")]
  53 pub struct File {
  54     inner: fs_imp::File,
  55 }
  56
  57 /// Metadata information about a file.
  58 ///
  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")]
  63 #[derive(Clone)]
  64 pub struct Metadata(fs_imp::FileAttr);
  65
  66 /// Iterator over the entries in a directory.
  67 ///
  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
  71 /// learned.
  72 ///
  73 /// # Errors
  74 ///
  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);
  79
  80 /// Entries returned by the `ReadDir` iterator.
  81 ///
  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);
  87
  88 /// Options and flags which can be used to configure how a file is opened.
  89 ///
  90 /// This builder exposes the ability to configure how a `File` is opened and
  91 /// what operations are permitted on the open file. The `File::open` and
  92 /// `File::create` methods are aliases for commonly used options using this
  93 /// builder.
  94 ///
  95 /// Generally speaking, when using `OpenOptions`, you'll first call `new()`,
  96 /// then chain calls to methods to set each option, then call `open()`, passing
  97 /// the path of the file you're trying to open. This will give you a
  98 /// [`io::Result`][result] with a [`File`][file] inside that you can further
  99 /// operate on.
 100 ///
 101 /// [result]: ../io/type.Result.html
 102 /// [file]: struct.File.html
 103 ///
 104 /// # Examples
 105 ///
 106 /// Opening a file to read:
 107 ///
 108 /// ```no_run
 109 /// use std::fs::OpenOptions;
 110 ///
 111 /// let file = OpenOptions::new().read(true).open("foo.txt");
 112 /// ```
 113 ///
 114 /// Opening a file for both reading and writing, as well as creating it if it
 115 /// doesn't exist:
 116 ///
 117 /// ```no_run
 118 /// use std::fs::OpenOptions;
 119 ///
 120 /// let file = OpenOptions::new()
 121 ///             .read(true)
 122 ///             .write(true)
 123 ///             .create(true)
 124 ///             .open("foo.txt");
 125 /// ```
 126 #[derive(Clone)]
 127 #[stable(feature = "rust1", since = "1.0.0")]
 128 pub struct OpenOptions(fs_imp::OpenOptions);
 129
 130 /// Representation of the various permissions on a file.
 131 ///
 132 /// This module only currently provides one bit of information, `readonly`,
 133 /// which is exposed on all currently supported platforms. Unix-specific
 134 /// functionality, such as mode bits, is available through the
 135 /// `os::unix::PermissionsExt` trait.
 136 #[derive(Clone, PartialEq, Eq, Debug)]
 137 #[stable(feature = "rust1", since = "1.0.0")]
 138 pub struct Permissions(fs_imp::FilePermissions);
 139
 140 /// An structure representing a type of file with accessors for each file type.
 141 #[stable(feature = "file_type", since = "1.1.0")]
 142 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
 143 pub struct FileType(fs_imp::FileType);
 144
 145 /// A builder used to create directories in various manners.
 146 ///
 147 /// This builder also supports platform-specific options.
 148 #[stable(feature = "dir_builder", since = "1.6.0")]
 149 pub struct DirBuilder {
 150     inner: fs_imp::DirBuilder,
 151     recursive: bool,
 152 }
 153
 154 impl File {
 155     /// Attempts to open a file in read-only mode.
 156     ///
 157     /// See the `OpenOptions::open` method for more details.
 158     ///
 159     /// # Errors
 160     ///
 161     /// This function will return an error if `path` does not already exist.
 162     /// Other errors may also be returned according to `OpenOptions::open`.
 163     ///
 164     /// # Examples
 165     ///
 166     /// ```no_run
 167     /// use std::fs::File;
 168     ///
 169     /// # fn foo() -> std::io::Result<()> {
 170     /// let mut f = try!(File::open("foo.txt"));
 171     /// # Ok(())
 172     /// # }
 173     /// ```
 174     #[stable(feature = "rust1", since = "1.0.0")]
 175     pub fn open<P: AsRef<Path>>(path: P) -> io::Result<File> {
 176         OpenOptions::new().read(true).open(path.as_ref())
 177     }
 178
 179     /// Opens a file in write-only mode.
 180     ///
 181     /// This function will create a file if it does not exist,
 182     /// and will truncate it if it does.
 183     ///
 184     /// See the `OpenOptions::open` function for more details.
 185     ///
 186     /// # Examples
 187     ///
 188     /// ```no_run
 189     /// use std::fs::File;
 190     ///
 191     /// # fn foo() -> std::io::Result<()> {
 192     /// let mut f = try!(File::create("foo.txt"));
 193     /// # Ok(())
 194     /// # }
 195     /// ```
 196     #[stable(feature = "rust1", since = "1.0.0")]
 197     pub fn create<P: AsRef<Path>>(path: P) -> io::Result<File> {
 198         OpenOptions::new().write(true).create(true).truncate(true).open(path.as_ref())
 199     }
 200
 201     /// Attempts to sync all OS-internal metadata to disk.
 202     ///
 203     /// This function will attempt to ensure that all in-core data reaches the
 204     /// filesystem before returning.
 205     ///
 206     /// # Examples
 207     ///
 208     /// ```no_run
 209     /// use std::fs::File;
 210     /// use std::io::prelude::*;
 211     ///
 212     /// # fn foo() -> std::io::Result<()> {
 213     /// let mut f = try!(File::create("foo.txt"));
 214     /// try!(f.write_all(b"Hello, world!"));
 215     ///
 216     /// try!(f.sync_all());
 217     /// # Ok(())
 218     /// # }
 219     /// ```
 220     #[stable(feature = "rust1", since = "1.0.0")]
 221     pub fn sync_all(&self) -> io::Result<()> {
 222         self.inner.fsync()
 223     }
 224
 225     /// This function is similar to `sync_all`, except that it may not
 226     /// synchronize file metadata to the filesystem.
 227     ///
 228     /// This is intended for use cases that must synchronize content, but don't
 229     /// need the metadata on disk. The goal of this method is to reduce disk
 230     /// operations.
 231     ///
 232     /// Note that some platforms may simply implement this in terms of
 233     /// `sync_all`.
 234     ///
 235     /// # Examples
 236     ///
 237     /// ```no_run
 238     /// use std::fs::File;
 239     /// use std::io::prelude::*;
 240     ///
 241     /// # fn foo() -> std::io::Result<()> {
 242     /// let mut f = try!(File::create("foo.txt"));
 243     /// try!(f.write_all(b"Hello, world!"));
 244     ///
 245     /// try!(f.sync_data());
 246     /// # Ok(())
 247     /// # }
 248     /// ```
 249     #[stable(feature = "rust1", since = "1.0.0")]
 250     pub fn sync_data(&self) -> io::Result<()> {
 251         self.inner.datasync()
 252     }
 253
 254     /// Truncates or extends the underlying file, updating the size of
 255     /// this file to become `size`.
 256     ///
 257     /// If the `size` is less than the current file's size, then the file will
 258     /// be shrunk. If it is greater than the current file's size, then the file
 259     /// will be extended to `size` and have all of the intermediate data filled
 260     /// in with 0s.
 261     ///
 262     /// # Errors
 263     ///
 264     /// This function will return an error if the file is not opened for writing.
 265     ///
 266     /// # Examples
 267     ///
 268     /// ```no_run
 269     /// use std::fs::File;
 270     ///
 271     /// # fn foo() -> std::io::Result<()> {
 272     /// let mut f = try!(File::create("foo.txt"));
 273     /// try!(f.set_len(10));
 274     /// # Ok(())
 275     /// # }
 276     /// ```
 277     #[stable(feature = "rust1", since = "1.0.0")]
 278     pub fn set_len(&self, size: u64) -> io::Result<()> {
 279         self.inner.truncate(size)
 280     }
 281
 282     /// Queries metadata about the underlying file.
 283     ///
 284     /// # Examples
 285     ///
 286     /// ```no_run
 287     /// use std::fs::File;
 288     ///
 289     /// # fn foo() -> std::io::Result<()> {
 290     /// let mut f = try!(File::open("foo.txt"));
 291     /// let metadata = try!(f.metadata());
 292     /// # Ok(())
 293     /// # }
 294     /// ```
 295     #[stable(feature = "rust1", since = "1.0.0")]
 296     pub fn metadata(&self) -> io::Result<Metadata> {
 297         self.inner.file_attr().map(Metadata)
 298     }
 299
 300     /// Creates a new independently owned handle to the underlying file.
 301     ///
 302     /// The returned `File` is a reference to the same state that this object
 303     /// references. Both handles will read and write with the same cursor
 304     /// position.
 305     #[stable(feature = "file_try_clone", since = "1.9.0")]
 306     pub fn try_clone(&self) -> io::Result<File> {
 307         Ok(File {
 308             inner: self.inner.duplicate()?
 309         })
 310     }
 311 }
 312
 313 impl AsInner<fs_imp::File> for File {
 314     fn as_inner(&self) -> &fs_imp::File { &self.inner }
 315 }
 316 impl FromInner<fs_imp::File> for File {
 317     fn from_inner(f: fs_imp::File) -> File {
 318         File { inner: f }
 319     }
 320 }
 321 impl IntoInner<fs_imp::File> for File {
 322     fn into_inner(self) -> fs_imp::File {
 323         self.inner
 324     }
 325 }
 326
 327 #[stable(feature = "rust1", since = "1.0.0")]
 328 impl fmt::Debug for File {
 329     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 330         self.inner.fmt(f)
 331     }
 332 }
 333
 334 #[stable(feature = "rust1", since = "1.0.0")]
 335 impl Read for File {
 336     fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
 337         self.inner.read(buf)
 338     }
 339     fn read_to_end(&mut self, buf: &mut Vec<u8>) -> io::Result<usize> {
 340         self.inner.read_to_end(buf)
 341     }
 342 }
 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)
 347     }
 348     fn flush(&mut self) -> io::Result<()> { self.inner.flush() }
 349 }
 350 #[stable(feature = "rust1", since = "1.0.0")]
 351 impl Seek for File {
 352     fn seek(&mut self, pos: SeekFrom) -> io::Result<u64> {
 353         self.inner.seek(pos)
 354     }
 355 }
 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> {
 359         self.inner.read(buf)
 360     }
 361     fn read_to_end(&mut self, buf: &mut Vec<u8>) -> io::Result<usize> {
 362         self.inner.read_to_end(buf)
 363     }
 364 }
 365 #[stable(feature = "rust1", since = "1.0.0")]
 366 impl<'a> Write for &'a File {
 367     fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
 368         self.inner.write(buf)
 369     }
 370     fn flush(&mut self) -> io::Result<()> { self.inner.flush() }
 371 }
 372 #[stable(feature = "rust1", since = "1.0.0")]
 373 impl<'a> Seek for &'a File {
 374     fn seek(&mut self, pos: SeekFrom) -> io::Result<u64> {
 375         self.inner.seek(pos)
 376     }
 377 }
 378
 379 impl OpenOptions {
 380     /// Creates a blank new set of options ready for configuration.
 381     ///
 382     /// All options are initially set to `false`.
 383     ///
 384     /// # Examples
 385     ///
 386     /// ```no_run
 387     /// use std::fs::OpenOptions;
 388     ///
 389     /// let mut options = OpenOptions::new();
 390     /// let file = options.read(true).open("foo.txt");
 391     /// ```
 392     #[stable(feature = "rust1", since = "1.0.0")]
 393     pub fn new() -> OpenOptions {
 394         OpenOptions(fs_imp::OpenOptions::new())
 395     }
 396
 397     /// Sets the option for read access.
 398     ///
 399     /// This option, when true, will indicate that the file should be
 400     /// `read`-able if opened.
 401     ///
 402     /// # Examples
 403     ///
 404     /// ```no_run
 405     /// use std::fs::OpenOptions;
 406     ///
 407     /// let file = OpenOptions::new().read(true).open("foo.txt");
 408     /// ```
 409     #[stable(feature = "rust1", since = "1.0.0")]
 410     pub fn read(&mut self, read: bool) -> &mut OpenOptions {
 411         self.0.read(read); self
 412     }
 413
 414     /// Sets the option for write access.
 415     ///
 416     /// This option, when true, will indicate that the file should be
 417     /// `write`-able if opened.
 418     ///
 419     /// If the file already exists, any write calls on it will overwrite its
 420     /// contents, without truncating it.
 421     ///
 422     /// # Examples
 423     ///
 424     /// ```no_run
 425     /// use std::fs::OpenOptions;
 426     ///
 427     /// let file = OpenOptions::new().write(true).open("foo.txt");
 428     /// ```
 429     #[stable(feature = "rust1", since = "1.0.0")]
 430     pub fn write(&mut self, write: bool) -> &mut OpenOptions {
 431         self.0.write(write); self
 432     }
 433
 434     /// Sets the option for the append mode.
 435     ///
 436     /// This option, when true, means that writes will append to a file instead
 437     /// of overwriting previous contents.
 438     /// Note that setting `.write(true).append(true)` has the same effect as
 439     /// setting only `.append(true)`.
 440     ///
 441     /// For most filesystems, the operating system guarantees that all writes are
 442     /// atomic: no writes get mangled because another process writes at the same
 443     /// time.
 444     ///
 445     /// One maybe obvious note when using append-mode: make sure that all data
 446     /// that belongs together is written to the file in one operation. This
 447     /// can be done by concatenating strings before passing them to `write()`,
 448     /// or using a buffered writer (with a buffer of adequate size),
 449     /// and calling `flush()` when the message is complete.
 450     ///
 451     /// If a file is opened with both read and append access, beware that after
 452     /// opening, and after every write, the position for reading may be set at the
 453     /// end of the file. So, before writing, save the current position (using
 454     /// `seek(SeekFrom::Current(0))`, and restore it before the next read.
 455     ///
 456     /// # Examples
 457     ///
 458     /// ```no_run
 459     /// use std::fs::OpenOptions;
 460     ///
 461     /// let file = OpenOptions::new().append(true).open("foo.txt");
 462     /// ```
 463     #[stable(feature = "rust1", since = "1.0.0")]
 464     pub fn append(&mut self, append: bool) -> &mut OpenOptions {
 465         self.0.append(append); self
 466     }
 467
 468     /// Sets the option for truncating a previous file.
 469     ///
 470     /// If a file is successfully opened with this option set it will truncate
 471     /// the file to 0 length if it already exists.
 472     ///
 473     /// The file must be opened with write access for truncate to work.
 474     ///
 475     /// # Examples
 476     ///
 477     /// ```no_run
 478     /// use std::fs::OpenOptions;
 479     ///
 480     /// let file = OpenOptions::new().write(true).truncate(true).open("foo.txt");
 481     /// ```
 482     #[stable(feature = "rust1", since = "1.0.0")]
 483     pub fn truncate(&mut self, truncate: bool) -> &mut OpenOptions {
 484         self.0.truncate(truncate); self
 485     }
 486
 487     /// Sets the option for creating a new file.
 488     ///
 489     /// This option indicates whether a new file will be created if the file
 490     /// does not yet already exist.
 491     ///
 492     /// In order for the file to be created, `write` or `append` access must
 493     /// be used.
 494     ///
 495     /// # Examples
 496     ///
 497     /// ```no_run
 498     /// use std::fs::OpenOptions;
 499     ///
 500     /// let file = OpenOptions::new().write(true).create(true).open("foo.txt");
 501     /// ```
 502     #[stable(feature = "rust1", since = "1.0.0")]
 503     pub fn create(&mut self, create: bool) -> &mut OpenOptions {
 504         self.0.create(create); self
 505     }
 506
 507     /// Sets the option to always create a new file.
 508     ///
 509     /// This option indicates whether a new file will be created.
 510     /// No file is allowed to exist at the target location, also no (dangling)
 511     /// symlink.
 512     ///
 513     /// This option is useful because it as atomic. Otherwise between checking
 514     /// whether a file exists and creating a new one, the file may have been
 515     /// created by another process (a TOCTOU race condition / attack).
 516     ///
 517     /// If `.create_new(true)` is set, `.create()` and `.truncate()` are
 518     /// ignored.
 519     ///
 520     /// The file must be opened with write or append access in order to create
 521     /// a new file.
 522     ///
 523     /// # Examples
 524     ///
 525     /// ```no_run
 526     /// use std::fs::OpenOptions;
 527     ///
 528     /// let file = OpenOptions::new().write(true)
 529     ///                              .create_new(true)
 530     ///                              .open("foo.txt");
 531     /// ```
 532     #[stable(feature = "expand_open_options2", since = "1.9.0")]
 533     pub fn create_new(&mut self, create_new: bool) -> &mut OpenOptions {
 534         self.0.create_new(create_new); self
 535     }
 536
 537     /// Opens a file at `path` with the options specified by `self`.
 538     ///
 539     /// # Errors
 540     ///
 541     /// This function will return an error under a number of different
 542     /// circumstances, to include but not limited to:
 543     ///
 544     /// * Opening a file that does not exist without setting `create` or
 545     ///   `create_new`.
 546     /// * Attempting to open a file with access that the user lacks
 547     ///   permissions for
 548     /// * Filesystem-level errors (full disk, etc)
 549     /// * Invalid combinations of open options (truncate without write access,
 550     ///   no access mode set, etc)
 551     ///
 552     /// # Examples
 553     ///
 554     /// ```no_run
 555     /// use std::fs::OpenOptions;
 556     ///
 557     /// let file = OpenOptions::new().open("foo.txt");
 558     /// ```
 559     #[stable(feature = "rust1", since = "1.0.0")]
 560     pub fn open<P: AsRef<Path>>(&self, path: P) -> io::Result<File> {
 561         self._open(path.as_ref())
 562     }
 563
 564     fn _open(&self, path: &Path) -> io::Result<File> {
 565         let inner = fs_imp::File::open(path, &self.0)?;
 566         Ok(File { inner: inner })
 567     }
 568 }
 569
 570 impl AsInnerMut<fs_imp::OpenOptions> for OpenOptions {
 571     fn as_inner_mut(&mut self) -> &mut fs_imp::OpenOptions { &mut self.0 }
 572 }
 573
 574 impl Metadata {
 575     /// Returns the file type for this metadata.
 576     #[stable(feature = "file_type", since = "1.1.0")]
 577     pub fn file_type(&self) -> FileType {
 578         FileType(self.0.file_type())
 579     }
 580
 581     /// Returns whether this metadata is for a directory.
 582     ///
 583     /// # Examples
 584     ///
 585     /// ```
 586     /// # fn foo() -> std::io::Result<()> {
 587     /// use std::fs;
 588     ///
 589     /// let metadata = try!(fs::metadata("foo.txt"));
 590     ///
 591     /// assert!(!metadata.is_dir());
 592     /// # Ok(())
 593     /// # }
 594     /// ```
 595     #[stable(feature = "rust1", since = "1.0.0")]
 596     pub fn is_dir(&self) -> bool { self.file_type().is_dir() }
 597
 598     /// Returns whether this metadata is for a regular file.
 599     ///
 600     /// # Examples
 601     ///
 602     /// ```
 603     /// # fn foo() -> std::io::Result<()> {
 604     /// use std::fs;
 605     ///
 606     /// let metadata = try!(fs::metadata("foo.txt"));
 607     ///
 608     /// assert!(metadata.is_file());
 609     /// # Ok(())
 610     /// # }
 611     /// ```
 612     #[stable(feature = "rust1", since = "1.0.0")]
 613     pub fn is_file(&self) -> bool { self.file_type().is_file() }
 614
 615     /// Returns the size of the file, in bytes, this metadata is for.
 616     ///
 617     /// # Examples
 618     ///
 619     /// ```
 620     /// # fn foo() -> std::io::Result<()> {
 621     /// use std::fs;
 622     ///
 623     /// let metadata = try!(fs::metadata("foo.txt"));
 624     ///
 625     /// assert_eq!(0, metadata.len());
 626     /// # Ok(())
 627     /// # }
 628     /// ```
 629     #[stable(feature = "rust1", since = "1.0.0")]
 630     pub fn len(&self) -> u64 { self.0.size() }
 631
 632     /// Returns the permissions of the file this metadata is for.
 633     ///
 634     /// # Examples
 635     ///
 636     /// ```
 637     /// # fn foo() -> std::io::Result<()> {
 638     /// use std::fs;
 639     ///
 640     /// let metadata = try!(fs::metadata("foo.txt"));
 641     ///
 642     /// assert!(!metadata.permissions().readonly());
 643     /// # Ok(())
 644     /// # }
 645     /// ```
 646     #[stable(feature = "rust1", since = "1.0.0")]
 647     pub fn permissions(&self) -> Permissions {
 648         Permissions(self.0.perm())
 649     }
 650
 651     /// Returns the last modification time listed in this metadata.
 652     ///
 653     /// The returned value corresponds to the `mtime` field of `stat` on Unix
 654     /// platforms and the `ftLastWriteTime` field on Windows platforms.
 655     ///
 656     /// # Errors
 657     ///
 658     /// This field may not be available on all platforms, and will return an
 659     /// `Err` on platforms where it is not available.
 660     #[unstable(feature = "fs_time", issue = "31399")]
 661     pub fn modified(&self) -> io::Result<SystemTime> {
 662         self.0.modified().map(FromInner::from_inner)
 663     }
 664
 665     /// Returns the last access time of this metadata.
 666     ///
 667     /// The returned value corresponds to the `atime` field of `stat` on Unix
 668     /// platforms and the `ftLastAccessTime` field on Windows platforms.
 669     ///
 670     /// Note that not all platforms will keep this field update in a file's
 671     /// metadata, for example Windows has an option to disable updating this
 672     /// time when files are accessed and Linux similarly has `noatime`.
 673     ///
 674     /// # Errors
 675     ///
 676     /// This field may not be available on all platforms, and will return an
 677     /// `Err` on platforms where it is not available.
 678     #[unstable(feature = "fs_time", issue = "31399")]
 679     pub fn accessed(&self) -> io::Result<SystemTime> {
 680         self.0.accessed().map(FromInner::from_inner)
 681     }
 682
 683     /// Returns the creation time listed in the this metadata.
 684     ///
 685     /// The returned value corresponds to the `birthtime` field of `stat` on
 686     /// Unix platforms and the `ftCreationTime` field on Windows platforms.
 687     ///
 688     /// # Errors
 689     ///
 690     /// This field may not be available on all platforms, and will return an
 691     /// `Err` on platforms where it is not available.
 692     #[unstable(feature = "fs_time", issue = "31399")]
 693     pub fn created(&self) -> io::Result<SystemTime> {
 694         self.0.created().map(FromInner::from_inner)
 695     }
 696 }
 697
 698 impl AsInner<fs_imp::FileAttr> for Metadata {
 699     fn as_inner(&self) -> &fs_imp::FileAttr { &self.0 }
 700 }
 701
 702 impl Permissions {
 703     /// Returns whether these permissions describe a readonly file.
 704     ///
 705     /// # Examples
 706     ///
 707     /// ```
 708     /// use std::fs::File;
 709     ///
 710     /// # fn foo() -> std::io::Result<()> {
 711     /// let mut f = try!(File::create("foo.txt"));
 712     /// let metadata = try!(f.metadata());
 713     ///
 714     /// assert_eq!(false, metadata.permissions().readonly());
 715     /// # Ok(())
 716     /// # }
 717     /// ```
 718     #[stable(feature = "rust1", since = "1.0.0")]
 719     pub fn readonly(&self) -> bool { self.0.readonly() }
 720
 721     /// Modifies the readonly flag for this set of permissions.
 722     ///
 723     /// This operation does **not** modify the filesystem. To modify the
 724     /// filesystem use the `fs::set_permissions` function.
 725     ///
 726     /// # Examples
 727     ///
 728     /// ```
 729     /// use std::fs::File;
 730     ///
 731     /// # fn foo() -> std::io::Result<()> {
 732     /// let f = try!(File::create("foo.txt"));
 733     /// let metadata = try!(f.metadata());
 734     /// let mut permissions = metadata.permissions();
 735     ///
 736     /// permissions.set_readonly(true);
 737     ///
 738     /// // filesystem doesn't change
 739     /// assert_eq!(false, metadata.permissions().readonly());
 740     ///
 741     /// // just this particular `permissions`.
 742     /// assert_eq!(true, permissions.readonly());
 743     /// # Ok(())
 744     /// # }
 745     /// ```
 746     #[stable(feature = "rust1", since = "1.0.0")]
 747     pub fn set_readonly(&mut self, readonly: bool) {
 748         self.0.set_readonly(readonly)
 749     }
 750 }
 751
 752 impl FileType {
 753     /// Test whether this file type represents a directory.
 754     #[stable(feature = "file_type", since = "1.1.0")]
 755     pub fn is_dir(&self) -> bool { self.0.is_dir() }
 756
 757     /// Test whether this file type represents a regular file.
 758     #[stable(feature = "file_type", since = "1.1.0")]
 759     pub fn is_file(&self) -> bool { self.0.is_file() }
 760
 761     /// Test whether this file type represents a symbolic link.
 762     #[stable(feature = "file_type", since = "1.1.0")]
 763     pub fn is_symlink(&self) -> bool { self.0.is_symlink() }
 764 }
 765
 766 impl AsInner<fs_imp::FileType> for FileType {
 767     fn as_inner(&self) -> &fs_imp::FileType { &self.0 }
 768 }
 769
 770 impl FromInner<fs_imp::FilePermissions> for Permissions {
 771     fn from_inner(f: fs_imp::FilePermissions) -> Permissions {
 772         Permissions(f)
 773     }
 774 }
 775
 776 impl AsInner<fs_imp::FilePermissions> for Permissions {
 777     fn as_inner(&self) -> &fs_imp::FilePermissions { &self.0 }
 778 }
 779
 780 #[stable(feature = "rust1", since = "1.0.0")]
 781 impl Iterator for ReadDir {
 782     type Item = io::Result<DirEntry>;
 783
 784     fn next(&mut self) -> Option<io::Result<DirEntry>> {
 785         self.0.next().map(|entry| entry.map(DirEntry))
 786     }
 787 }
 788
 789 impl DirEntry {
 790     /// Returns the full path to the file that this entry represents.
 791     ///
 792     /// The full path is created by joining the original path to `read_dir` or
 793     /// `walk_dir` with the filename of this entry.
 794     ///
 795     /// # Examples
 796     ///
 797     /// ```
 798     /// use std::fs;
 799     /// # fn foo() -> std::io::Result<()> {
 800     /// for entry in try!(fs::read_dir(".")) {
 801     ///     let dir = try!(entry);
 802     ///     println!("{:?}", dir.path());
 803     /// }
 804     /// # Ok(())
 805     /// # }
 806     /// ```
 807     ///
 808     /// This prints output like:
 809     ///
 810     /// ```text
 811     /// "./whatever.txt"
 812     /// "./foo.html"
 813     /// "./hello_world.rs"
 814     /// ```
 815     ///
 816     /// The exact text, of course, depends on what files you have in `.`.
 817     #[stable(feature = "rust1", since = "1.0.0")]
 818     pub fn path(&self) -> PathBuf { self.0.path() }
 819
 820     /// Return the metadata for the file that this entry points at.
 821     ///
 822     /// This function will not traverse symlinks if this entry points at a
 823     /// symlink.
 824     ///
 825     /// # Platform-specific behavior
 826     ///
 827     /// On Windows this function is cheap to call (no extra system calls
 828     /// needed), but on Unix platforms this function is the equivalent of
 829     /// calling `symlink_metadata` on the path.
 830     #[stable(feature = "dir_entry_ext", since = "1.1.0")]
 831     pub fn metadata(&self) -> io::Result<Metadata> {
 832         self.0.metadata().map(Metadata)
 833     }
 834
 835     /// Return the file type for the file that this entry points at.
 836     ///
 837     /// This function will not traverse symlinks if this entry points at a
 838     /// symlink.
 839     ///
 840     /// # Platform-specific behavior
 841     ///
 842     /// On Windows and most Unix platforms this function is free (no extra
 843     /// system calls needed), but some Unix platforms may require the equivalent
 844     /// call to `symlink_metadata` to learn about the target file type.
 845     #[stable(feature = "dir_entry_ext", since = "1.1.0")]
 846     pub fn file_type(&self) -> io::Result<FileType> {
 847         self.0.file_type().map(FileType)
 848     }
 849
 850     /// Returns the bare file name of this directory entry without any other
 851     /// leading path component.
 852     #[stable(feature = "dir_entry_ext", since = "1.1.0")]
 853     pub fn file_name(&self) -> OsString {
 854         self.0.file_name()
 855     }
 856 }
 857
 858 impl AsInner<fs_imp::DirEntry> for DirEntry {
 859     fn as_inner(&self) -> &fs_imp::DirEntry { &self.0 }
 860 }
 861
 862 /// Removes a file from the filesystem.
 863 ///
 864 /// Note that there is no
 865 /// guarantee that the file is immediately deleted (e.g. depending on
 866 /// platform, other open file descriptors may prevent immediate removal).
 867 ///
 868 /// # Platform-specific behavior
 869 ///
 870 /// This function currently corresponds to the `unlink` function on Unix
 871 /// and the `DeleteFile` function on Windows.
 872 /// Note that, this [may change in the future][changes].
 873 /// [changes]: ../io/index.html#platform-specific-behavior
 874 ///
 875 /// # Errors
 876 ///
 877 /// This function will return an error in the following situations, but is not
 878 /// limited to just these cases:
 879 ///
 880 /// * `path` points to a directory.
 881 /// * The user lacks permissions to remove the file.
 882 ///
 883 /// # Examples
 884 ///
 885 /// ```
 886 /// use std::fs;
 887 ///
 888 /// # fn foo() -> std::io::Result<()> {
 889 /// try!(fs::remove_file("a.txt"));
 890 /// # Ok(())
 891 /// # }
 892 /// ```
 893 #[stable(feature = "rust1", since = "1.0.0")]
 894 pub fn remove_file<P: AsRef<Path>>(path: P) -> io::Result<()> {
 895     fs_imp::unlink(path.as_ref())
 896 }
 897
 898 /// Given a path, query the file system to get information about a file,
 899 /// directory, etc.
 900 ///
 901 /// This function will traverse symbolic links to query information about the
 902 /// destination file.
 903 ///
 904 /// # Platform-specific behavior
 905 ///
 906 /// This function currently corresponds to the `stat` function on Unix
 907 /// and the `GetFileAttributesEx` function on Windows.
 908 /// Note that, this [may change in the future][changes].
 909 /// [changes]: ../io/index.html#platform-specific-behavior
 910 ///
 911 /// # Errors
 912 ///
 913 /// This function will return an error in the following situations, but is not
 914 /// limited to just these cases:
 915 ///
 916 /// * The user lacks permissions to perform `metadata` call on `path`.
 917 /// * `path` does not exist.
 918 ///
 919 /// # Examples
 920 ///
 921 /// ```rust
 922 /// # fn foo() -> std::io::Result<()> {
 923 /// use std::fs;
 924 ///
 925 /// let attr = try!(fs::metadata("/some/file/path.txt"));
 926 /// // inspect attr ...
 927 /// # Ok(())
 928 /// # }
 929 /// ```
 930 #[stable(feature = "rust1", since = "1.0.0")]
 931 pub fn metadata<P: AsRef<Path>>(path: P) -> io::Result<Metadata> {
 932     fs_imp::stat(path.as_ref()).map(Metadata)
 933 }
 934
 935 /// Query the metadata about a file without following symlinks.
 936 ///
 937 /// # Platform-specific behavior
 938 ///
 939 /// This function currently corresponds to the `lstat` function on Unix
 940 /// and the `GetFileAttributesEx` function on Windows.
 941 /// Note that, this [may change in the future][changes].
 942 /// [changes]: ../io/index.html#platform-specific-behavior
 943 ///
 944 /// # Errors
 945 ///
 946 /// This function will return an error in the following situations, but is not
 947 /// limited to just these cases:
 948 ///
 949 /// * The user lacks permissions to perform `metadata` call on `path`.
 950 /// * `path` does not exist.
 951 ///
 952 /// # Examples
 953 ///
 954 /// ```rust
 955 /// # fn foo() -> std::io::Result<()> {
 956 /// use std::fs;
 957 ///
 958 /// let attr = try!(fs::symlink_metadata("/some/file/path.txt"));
 959 /// // inspect attr ...
 960 /// # Ok(())
 961 /// # }
 962 /// ```
 963 #[stable(feature = "symlink_metadata", since = "1.1.0")]
 964 pub fn symlink_metadata<P: AsRef<Path>>(path: P) -> io::Result<Metadata> {
 965     fs_imp::lstat(path.as_ref()).map(Metadata)
 966 }
 967
 968 /// Rename a file or directory to a new name, replacing the original file if
 969 /// `to` already exists.
 970 ///
 971 /// This will not work if the new name is on a different mount point.
 972 ///
 973 /// # Platform-specific behavior
 974 ///
 975 /// This function currently corresponds to the `rename` function on Unix
 976 /// and the `MoveFileEx` function with the `MOVEFILE_REPLACE_EXISTING` flag on Windows.
 977 ///
 978 /// Because of this, the behavior when both `from` and `to` exist differs. On
 979 /// Unix, if `from` is a directory, `to` must also be an (empty) directory. If
 980 /// `from` is not a directory, `to` must also be not a directory. In contrast,
 981 /// on Windows, `from` can be anything, but `to` must *not* be a directory.
 982 ///
 983 /// Note that, this [may change in the future][changes].
 984 /// [changes]: ../io/index.html#platform-specific-behavior
 985 ///
 986 /// # Errors
 987 ///
 988 /// This function will return an error in the following situations, but is not
 989 /// limited to just these cases:
 990 ///
 991 /// * `from` does not exist.
 992 /// * The user lacks permissions to view contents.
 993 /// * `from` and `to` are on separate filesystems.
 994 ///
 995 /// # Examples
 996 ///
 997 /// ```
 998 /// use std::fs;
 999 ///
1000 /// # fn foo() -> std::io::Result<()> {
1001 /// try!(fs::rename("a.txt", "b.txt")); // Rename a.txt to b.txt
1002 /// # Ok(())
1003 /// # }
1004 /// ```
1005 #[stable(feature = "rust1", since = "1.0.0")]
1006 pub fn rename<P: AsRef<Path>, Q: AsRef<Path>>(from: P, to: Q) -> io::Result<()> {
1007     fs_imp::rename(from.as_ref(), to.as_ref())
1008 }
1009
1010 /// Copies the contents of one file to another. This function will also
1011 /// copy the permission bits of the original file to the destination file.
1012 ///
1013 /// This function will **overwrite** the contents of `to`.
1014 ///
1015 /// Note that if `from` and `to` both point to the same file, then the file
1016 /// will likely get truncated by this operation.
1017 ///
1018 /// On success, the total number of bytes copied is returned.
1019 ///
1020 /// # Platform-specific behavior
1021 ///
1022 /// This function currently corresponds to the `open` function in Unix
1023 /// with `O_RDONLY` for `from` and `O_WRONLY`, `O_CREAT`, and `O_TRUNC` for `to`.
1024 /// `O_CLOEXEC` is set for returned file descriptors.
1025 /// On Windows, this function currently corresponds to `CopyFileEx`.
1026 /// Note that, this [may change in the future][changes].
1027 /// [changes]: ../io/index.html#platform-specific-behavior
1028 ///
1029 /// # Errors
1030 ///
1031 /// This function will return an error in the following situations, but is not
1032 /// limited to just these cases:
1033 ///
1034 /// * The `from` path is not a file.
1035 /// * The `from` file does not exist.
1036 /// * The current process does not have the permission rights to access
1037 ///   `from` or write `to`.
1038 ///
1039 /// # Examples
1040 ///
1041 /// ```no_run
1042 /// use std::fs;
1043 ///
1044 /// # fn foo() -> std::io::Result<()> {
1045 /// try!(fs::copy("foo.txt", "bar.txt"));  // Copy foo.txt to bar.txt
1046 /// # Ok(()) }
1047 /// ```
1048 #[stable(feature = "rust1", since = "1.0.0")]
1049 pub fn copy<P: AsRef<Path>, Q: AsRef<Path>>(from: P, to: Q) -> io::Result<u64> {
1050     fs_imp::copy(from.as_ref(), to.as_ref())
1051 }
1052
1053 /// Creates a new hard link on the filesystem.
1054 ///
1055 /// The `dst` path will be a link pointing to the `src` path. Note that systems
1056 /// often require these two paths to both be located on the same filesystem.
1057 ///
1058 /// # Platform-specific behavior
1059 ///
1060 /// This function currently corresponds to the `link` function on Unix
1061 /// and the `CreateHardLink` function on Windows.
1062 /// Note that, this [may change in the future][changes].
1063 /// [changes]: ../io/index.html#platform-specific-behavior
1064 ///
1065 /// # Errors
1066 ///
1067 /// This function will return an error in the following situations, but is not
1068 /// limited to just these cases:
1069 ///
1070 /// * The `src` path is not a file or doesn't exist.
1071 ///
1072 /// # Examples
1073 ///
1074 /// ```
1075 /// use std::fs;
1076 ///
1077 /// # fn foo() -> std::io::Result<()> {
1078 /// try!(fs::hard_link("a.txt", "b.txt")); // Hard link a.txt to b.txt
1079 /// # Ok(())
1080 /// # }
1081 /// ```
1082 #[stable(feature = "rust1", since = "1.0.0")]
1083 pub fn hard_link<P: AsRef<Path>, Q: AsRef<Path>>(src: P, dst: Q) -> io::Result<()> {
1084     fs_imp::link(src.as_ref(), dst.as_ref())
1085 }
1086
1087 /// Creates a new symbolic link on the filesystem.
1088 ///
1089 /// The `dst` path will be a symbolic link pointing to the `src` path.
1090 /// On Windows, this will be a file symlink, not a directory symlink;
1091 /// for this reason, the platform-specific `std::os::unix::fs::symlink`
1092 /// and `std::os::windows::fs::{symlink_file, symlink_dir}` should be
1093 /// used instead to make the intent explicit.
1094 ///
1095 /// # Examples
1096 ///
1097 /// ```
1098 /// use std::fs;
1099 ///
1100 /// # fn foo() -> std::io::Result<()> {
1101 /// try!(fs::soft_link("a.txt", "b.txt"));
1102 /// # Ok(())
1103 /// # }
1104 /// ```
1105 #[stable(feature = "rust1", since = "1.0.0")]
1106 #[rustc_deprecated(since = "1.1.0",
1107              reason = "replaced with std::os::unix::fs::symlink and \
1108                        std::os::windows::fs::{symlink_file, symlink_dir}")]
1109 pub fn soft_link<P: AsRef<Path>, Q: AsRef<Path>>(src: P, dst: Q) -> io::Result<()> {
1110     fs_imp::symlink(src.as_ref(), dst.as_ref())
1111 }
1112
1113 /// Reads a symbolic link, returning the file that the link points to.
1114 ///
1115 /// # Platform-specific behavior
1116 ///
1117 /// This function currently corresponds to the `readlink` function on Unix
1118 /// and the `CreateFile` function with `FILE_FLAG_OPEN_REPARSE_POINT` and
1119 /// `FILE_FLAG_BACKUP_SEMANTICS` flags on Windows.
1120 /// Note that, this [may change in the future][changes].
1121 /// [changes]: ../io/index.html#platform-specific-behavior
1122 ///
1123 /// # Errors
1124 ///
1125 /// This function will return an error in the following situations, but is not
1126 /// limited to just these cases:
1127 ///
1128 /// * `path` is not a symbolic link.
1129 /// * `path` does not exist.
1130 ///
1131 /// # Examples
1132 ///
1133 /// ```
1134 /// use std::fs;
1135 ///
1136 /// # fn foo() -> std::io::Result<()> {
1137 /// let path = try!(fs::read_link("a.txt"));
1138 /// # Ok(())
1139 /// # }
1140 /// ```
1141 #[stable(feature = "rust1", since = "1.0.0")]
1142 pub fn read_link<P: AsRef<Path>>(path: P) -> io::Result<PathBuf> {
1143     fs_imp::readlink(path.as_ref())
1144 }
1145
1146 /// Returns the canonical form of a path with all intermediate components
1147 /// normalized and symbolic links resolved.
1148 ///
1149 /// # Platform-specific behavior
1150 ///
1151 /// This function currently corresponds to the `realpath` function on Unix
1152 /// and the `CreateFile` and `GetFinalPathNameByHandle` functions on Windows.
1153 /// Note that, this [may change in the future][changes].
1154 /// [changes]: ../io/index.html#platform-specific-behavior
1155 ///
1156 /// # Errors
1157 ///
1158 /// This function will return an error in the following situations, but is not
1159 /// limited to just these cases:
1160 ///
1161 /// * `path` does not exist.
1162 /// * A component in path is not a directory.
1163 ///
1164 /// # Examples
1165 ///
1166 /// ```
1167 /// use std::fs;
1168 ///
1169 /// # fn foo() -> std::io::Result<()> {
1170 /// let path = try!(fs::canonicalize("../a/../foo.txt"));
1171 /// # Ok(())
1172 /// # }
1173 /// ```
1174 #[stable(feature = "fs_canonicalize", since = "1.5.0")]
1175 pub fn canonicalize<P: AsRef<Path>>(path: P) -> io::Result<PathBuf> {
1176     fs_imp::canonicalize(path.as_ref())
1177 }
1178
1179 /// Creates a new, empty directory at the provided path
1180 ///
1181 /// # Platform-specific behavior
1182 ///
1183 /// This function currently corresponds to the `mkdir` function on Unix
1184 /// and the `CreateDirectory` function on Windows.
1185 /// Note that, this [may change in the future][changes].
1186 /// [changes]: ../io/index.html#platform-specific-behavior
1187 ///
1188 /// # Errors
1189 ///
1190 /// This function will return an error in the following situations, but is not
1191 /// limited to just these cases:
1192 ///
1193 /// * User lacks permissions to create directory at `path`.
1194 /// * `path` already exists.
1195 ///
1196 /// # Examples
1197 ///
1198 /// ```
1199 /// use std::fs;
1200 ///
1201 /// # fn foo() -> std::io::Result<()> {
1202 /// try!(fs::create_dir("/some/dir"));
1203 /// # Ok(())
1204 /// # }
1205 /// ```
1206 #[stable(feature = "rust1", since = "1.0.0")]
1207 pub fn create_dir<P: AsRef<Path>>(path: P) -> io::Result<()> {
1208     DirBuilder::new().create(path.as_ref())
1209 }
1210
1211 /// Recursively create a directory and all of its parent components if they
1212 /// are missing.
1213 ///
1214 /// # Platform-specific behavior
1215 ///
1216 /// This function currently corresponds to the `mkdir` function on Unix
1217 /// and the `CreateDirectory` function on Windows.
1218 /// Note that, this [may change in the future][changes].
1219 /// [changes]: ../io/index.html#platform-specific-behavior
1220 ///
1221 /// # Errors
1222 ///
1223 /// This function will return an error in the following situations, but is not
1224 /// limited to just these cases:
1225 ///
1226 /// * If any directory in the path specified by `path`
1227 /// does not already exist and it could not be created otherwise. The specific
1228 /// error conditions for when a directory is being created (after it is
1229 /// determined to not exist) are outlined by `fs::create_dir`.
1230 ///
1231 /// # Examples
1232 ///
1233 /// ```
1234 /// use std::fs;
1235 ///
1236 /// # fn foo() -> std::io::Result<()> {
1237 /// try!(fs::create_dir_all("/some/dir"));
1238 /// # Ok(())
1239 /// # }
1240 /// ```
1241 #[stable(feature = "rust1", since = "1.0.0")]
1242 pub fn create_dir_all<P: AsRef<Path>>(path: P) -> io::Result<()> {
1243     DirBuilder::new().recursive(true).create(path.as_ref())
1244 }
1245
1246 /// Removes an existing, empty directory.
1247 ///
1248 /// # Platform-specific behavior
1249 ///
1250 /// This function currently corresponds to the `rmdir` function on Unix
1251 /// and the `RemoveDirectory` function on Windows.
1252 /// Note that, this [may change in the future][changes].
1253 /// [changes]: ../io/index.html#platform-specific-behavior
1254 ///
1255 /// # Errors
1256 ///
1257 /// This function will return an error in the following situations, but is not
1258 /// limited to just these cases:
1259 ///
1260 /// * The user lacks permissions to remove the directory at the provided `path`.
1261 /// * The directory isn't empty.
1262 ///
1263 /// # Examples
1264 ///
1265 /// ```
1266 /// use std::fs;
1267 ///
1268 /// # fn foo() -> std::io::Result<()> {
1269 /// try!(fs::remove_dir("/some/dir"));
1270 /// # Ok(())
1271 /// # }
1272 /// ```
1273 #[stable(feature = "rust1", since = "1.0.0")]
1274 pub fn remove_dir<P: AsRef<Path>>(path: P) -> io::Result<()> {
1275     fs_imp::rmdir(path.as_ref())
1276 }
1277
1278 /// Removes a directory at this path, after removing all its contents. Use
1279 /// carefully!
1280 ///
1281 /// This function does **not** follow symbolic links and it will simply remove the
1282 /// symbolic link itself.
1283 ///
1284 /// # Platform-specific behavior
1285 ///
1286 /// This function currently corresponds to `opendir`, `lstat`, `rm` and `rmdir` functions on Unix
1287 /// and the `FindFirstFile`, `GetFileAttributesEx`, `DeleteFile`, and `RemoveDirectory` functions
1288 /// on Windows.
1289 /// Note that, this [may change in the future][changes].
1290 /// [changes]: ../io/index.html#platform-specific-behavior
1291 ///
1292 /// # Errors
1293 ///
1294 /// See `file::remove_file` and `fs::remove_dir`.
1295 ///
1296 /// # Examples
1297 ///
1298 /// ```
1299 /// use std::fs;
1300 ///
1301 /// # fn foo() -> std::io::Result<()> {
1302 /// try!(fs::remove_dir_all("/some/dir"));
1303 /// # Ok(())
1304 /// # }
1305 /// ```
1306 #[stable(feature = "rust1", since = "1.0.0")]
1307 pub fn remove_dir_all<P: AsRef<Path>>(path: P) -> io::Result<()> {
1308     fs_imp::remove_dir_all(path.as_ref())
1309 }
1310
1311 /// Returns an iterator over the entries within a directory.
1312 ///
1313 /// The iterator will yield instances of `io::Result<DirEntry>`. New errors may
1314 /// be encountered after an iterator is initially constructed.
1315 ///
1316 /// # Platform-specific behavior
1317 ///
1318 /// This function currently corresponds to the `opendir` function on Unix
1319 /// and the `FindFirstFile` function on Windows.
1320 /// Note that, this [may change in the future][changes].
1321 /// [changes]: ../io/index.html#platform-specific-behavior
1322 ///
1323 /// # Errors
1324 ///
1325 /// This function will return an error in the following situations, but is not
1326 /// limited to just these cases:
1327 ///
1328 /// * The provided `path` doesn't exist.
1329 /// * The process lacks permissions to view the contents.
1330 /// * The `path` points at a non-directory file.
1331 ///
1332 /// # Examples
1333 ///
1334 /// ```
1335 /// use std::io;
1336 /// use std::fs::{self, DirEntry};
1337 /// use std::path::Path;
1338 ///
1339 /// // one possible implementation of walking a directory only visiting files
1340 /// fn visit_dirs(dir: &Path, cb: &Fn(&DirEntry)) -> io::Result<()> {
1341 ///     if try!(fs::metadata(dir)).is_dir() {
1342 ///         for entry in try!(fs::read_dir(dir)) {
1343 ///             let entry = try!(entry);
1344 ///             if try!(fs::metadata(entry.path())).is_dir() {
1345 ///                 try!(visit_dirs(&entry.path(), cb));
1346 ///             } else {
1347 ///                 cb(&entry);
1348 ///             }
1349 ///         }
1350 ///     }
1351 ///     Ok(())
1352 /// }
1353 /// ```
1354 #[stable(feature = "rust1", since = "1.0.0")]
1355 pub fn read_dir<P: AsRef<Path>>(path: P) -> io::Result<ReadDir> {
1356     fs_imp::readdir(path.as_ref()).map(ReadDir)
1357 }
1358
1359 /// Changes the permissions found on a file or a directory.
1360 ///
1361 /// # Platform-specific behavior
1362 ///
1363 /// This function currently corresponds to the `chmod` function on Unix
1364 /// and the `SetFileAttributes` function on Windows.
1365 /// Note that, this [may change in the future][changes].
1366 /// [changes]: ../io/index.html#platform-specific-behavior
1367 ///
1368 /// # Errors
1369 ///
1370 /// This function will return an error in the following situations, but is not
1371 /// limited to just these cases:
1372 ///
1373 /// * `path` does not exist.
1374 /// * The user lacks the permission to change attributes of the file.
1375 ///
1376 /// # Examples
1377 ///
1378 /// ```
1379 /// # fn foo() -> std::io::Result<()> {
1380 /// use std::fs;
1381 ///
1382 /// let mut perms = try!(fs::metadata("foo.txt")).permissions();
1383 /// perms.set_readonly(true);
1384 /// try!(fs::set_permissions("foo.txt", perms));
1385 /// # Ok(())
1386 /// # }
1387 /// ```
1388 #[stable(feature = "set_permissions", since = "1.1.0")]
1389 pub fn set_permissions<P: AsRef<Path>>(path: P, perm: Permissions)
1390                                        -> io::Result<()> {
1391     fs_imp::set_perm(path.as_ref(), perm.0)
1392 }
1393
1394 impl DirBuilder {
1395     /// Creates a new set of options with default mode/security settings for all
1396     /// platforms and also non-recursive.
1397     #[stable(feature = "dir_builder", since = "1.6.0")]
1398     pub fn new() -> DirBuilder {
1399         DirBuilder {
1400             inner: fs_imp::DirBuilder::new(),
1401             recursive: false,
1402         }
1403     }
1404
1405     /// Indicate that directories create should be created recursively, creating
1406     /// all parent directories if they do not exist with the same security and
1407     /// permissions settings.
1408     ///
1409     /// This option defaults to `false`
1410     #[stable(feature = "dir_builder", since = "1.6.0")]
1411     pub fn recursive(&mut self, recursive: bool) -> &mut Self {
1412         self.recursive = recursive;
1413         self
1414     }
1415
1416     /// Create the specified directory with the options configured in this
1417     /// builder.
1418     ///
1419     /// # Examples
1420     ///
1421     /// ```no_run
1422     /// use std::fs::{self, DirBuilder};
1423     ///
1424     /// let path = "/tmp/foo/bar/baz";
1425     /// DirBuilder::new()
1426     ///     .recursive(true)
1427     ///     .create(path).unwrap();
1428     ///
1429     /// assert!(fs::metadata(path).unwrap().is_dir());
1430     /// ```
1431     #[stable(feature = "dir_builder", since = "1.6.0")]
1432     pub fn create<P: AsRef<Path>>(&self, path: P) -> io::Result<()> {
1433         self._create(path.as_ref())
1434     }
1435
1436     fn _create(&self, path: &Path) -> io::Result<()> {
1437         if self.recursive {
1438             self.create_dir_all(path)
1439         } else {
1440             self.inner.mkdir(path)
1441         }
1442     }
1443
1444     fn create_dir_all(&self, path: &Path) -> io::Result<()> {
1445         if path == Path::new("") || path.is_dir() { return Ok(()) }
1446         if let Some(p) = path.parent() {
1447             self.create_dir_all(p)?
1448         }
1449         self.inner.mkdir(path)
1450     }
1451 }
1452
1453 impl AsInnerMut<fs_imp::DirBuilder> for DirBuilder {
1454     fn as_inner_mut(&mut self) -> &mut fs_imp::DirBuilder {
1455         &mut self.inner
1456     }
1457 }
1458
1459 #[cfg(test)]
1460 mod tests {
1461     use prelude::v1::*;
1462     use io::prelude::*;
1463
1464     use fs::{self, File, OpenOptions};
1465     use io::{ErrorKind, SeekFrom};
1466     use path::Path;
1467     use rand::{StdRng, Rng};
1468     use str;
1469     use sys_common::io::test::{TempDir, tmpdir};
1470
1471     #[cfg(windows)]
1472     use os::windows::fs::{symlink_dir, symlink_file};
1473     #[cfg(windows)]
1474     use sys::fs::symlink_junction;
1475     #[cfg(unix)]
1476     use os::unix::fs::symlink as symlink_dir;
1477     #[cfg(unix)]
1478     use os::unix::fs::symlink as symlink_file;
1479     #[cfg(unix)]
1480     use os::unix::fs::symlink as symlink_junction;
1481
1482     macro_rules! check { ($e:expr) => (
1483         match $e {
1484             Ok(t) => t,
1485             Err(e) => panic!("{} failed with: {}", stringify!($e), e),
1486         }
1487     ) }
1488
1489     macro_rules! error { ($e:expr, $s:expr) => (
1490         match $e {
1491             Ok(_) => panic!("Unexpected success. Should've been: {:?}", $s),
1492             Err(ref err) => assert!(err.to_string().contains($s),
1493                                     format!("`{}` did not contain `{}`", err, $s))
1494         }
1495     ) }
1496
1497     // Several test fail on windows if the user does not have permission to
1498     // create symlinks (the `SeCreateSymbolicLinkPrivilege`). Instead of
1499     // disabling these test on Windows, use this function to test whether we
1500     // have permission, and return otherwise. This way, we still don't run these
1501     // tests most of the time, but at least we do if the user has the right
1502     // permissions.
1503     pub fn got_symlink_permission(tmpdir: &TempDir) -> bool {
1504         if cfg!(unix) { return true }
1505         let link = tmpdir.join("some_hopefully_unique_link_name");
1506
1507         match symlink_file(r"nonexisting_target", link) {
1508             Ok(_) => true,
1509             Err(ref err) =>
1510                 if err.to_string().contains("A required privilege is not held by the client.") {
1511                     false
1512                 } else {
1513                     true
1514                 }
1515         }
1516     }
1517
1518     #[test]
1519     fn file_test_io_smoke_test() {
1520         let message = "it's alright. have a good time";
1521         let tmpdir = tmpdir();
1522         let filename = &tmpdir.join("file_rt_io_file_test.txt");
1523         {
1524             let mut write_stream = check!(File::create(filename));
1525             check!(write_stream.write(message.as_bytes()));
1526         }
1527         {
1528             let mut read_stream = check!(File::open(filename));
1529             let mut read_buf = [0; 1028];
1530             let read_str = match check!(read_stream.read(&mut read_buf)) {
1531                 0 => panic!("shouldn't happen"),
1532                 n => str::from_utf8(&read_buf[..n]).unwrap().to_string()
1533             };
1534             assert_eq!(read_str, message);
1535         }
1536         check!(fs::remove_file(filename));
1537     }
1538
1539     #[test]
1540     fn invalid_path_raises() {
1541         let tmpdir = tmpdir();
1542         let filename = &tmpdir.join("file_that_does_not_exist.txt");
1543         let result = File::open(filename);
1544
1545         if cfg!(unix) {
1546             error!(result, "o such file or directory");
1547         }
1548         if cfg!(windows) {
1549             error!(result, "The system cannot find the file specified");
1550         }
1551     }
1552
1553     #[test]
1554     fn file_test_iounlinking_invalid_path_should_raise_condition() {
1555         let tmpdir = tmpdir();
1556         let filename = &tmpdir.join("file_another_file_that_does_not_exist.txt");
1557
1558         let result = fs::remove_file(filename);
1559
1560         if cfg!(unix) {
1561             error!(result, "o such file or directory");
1562         }
1563         if cfg!(windows) {
1564             error!(result, "The system cannot find the file specified");
1565         }
1566     }
1567
1568     #[test]
1569     fn file_test_io_non_positional_read() {
1570         let message: &str = "ten-four";
1571         let mut read_mem = [0; 8];
1572         let tmpdir = tmpdir();
1573         let filename = &tmpdir.join("file_rt_io_file_test_positional.txt");
1574         {
1575             let mut rw_stream = check!(File::create(filename));
1576             check!(rw_stream.write(message.as_bytes()));
1577         }
1578         {
1579             let mut read_stream = check!(File::open(filename));
1580             {
1581                 let read_buf = &mut read_mem[0..4];
1582                 check!(read_stream.read(read_buf));
1583             }
1584             {
1585                 let read_buf = &mut read_mem[4..8];
1586                 check!(read_stream.read(read_buf));
1587             }
1588         }
1589         check!(fs::remove_file(filename));
1590         let read_str = str::from_utf8(&read_mem).unwrap();
1591         assert_eq!(read_str, message);
1592     }
1593
1594     #[test]
1595     fn file_test_io_seek_and_tell_smoke_test() {
1596         let message = "ten-four";
1597         let mut read_mem = [0; 4];
1598         let set_cursor = 4 as u64;
1599         let tell_pos_pre_read;
1600         let tell_pos_post_read;
1601         let tmpdir = tmpdir();
1602         let filename = &tmpdir.join("file_rt_io_file_test_seeking.txt");
1603         {
1604             let mut rw_stream = check!(File::create(filename));
1605             check!(rw_stream.write(message.as_bytes()));
1606         }
1607         {
1608             let mut read_stream = check!(File::open(filename));
1609             check!(read_stream.seek(SeekFrom::Start(set_cursor)));
1610             tell_pos_pre_read = check!(read_stream.seek(SeekFrom::Current(0)));
1611             check!(read_stream.read(&mut read_mem));
1612             tell_pos_post_read = check!(read_stream.seek(SeekFrom::Current(0)));
1613         }
1614         check!(fs::remove_file(filename));
1615         let read_str = str::from_utf8(&read_mem).unwrap();
1616         assert_eq!(read_str, &message[4..8]);
1617         assert_eq!(tell_pos_pre_read, set_cursor);
1618         assert_eq!(tell_pos_post_read, message.len() as u64);
1619     }
1620
1621     #[test]
1622     fn file_test_io_seek_and_write() {
1623         let initial_msg =   "food-is-yummy";
1624         let overwrite_msg =    "-the-bar!!";
1625         let final_msg =     "foo-the-bar!!";
1626         let seek_idx = 3;
1627         let mut read_mem = [0; 13];
1628         let tmpdir = tmpdir();
1629         let filename = &tmpdir.join("file_rt_io_file_test_seek_and_write.txt");
1630         {
1631             let mut rw_stream = check!(File::create(filename));
1632             check!(rw_stream.write(initial_msg.as_bytes()));
1633             check!(rw_stream.seek(SeekFrom::Start(seek_idx)));
1634             check!(rw_stream.write(overwrite_msg.as_bytes()));
1635         }
1636         {
1637             let mut read_stream = check!(File::open(filename));
1638             check!(read_stream.read(&mut read_mem));
1639         }
1640         check!(fs::remove_file(filename));
1641         let read_str = str::from_utf8(&read_mem).unwrap();
1642         assert!(read_str == final_msg);
1643     }
1644
1645     #[test]
1646     fn file_test_io_seek_shakedown() {
1647         //                   01234567890123
1648         let initial_msg =   "qwer-asdf-zxcv";
1649         let chunk_one: &str = "qwer";
1650         let chunk_two: &str = "asdf";
1651         let chunk_three: &str = "zxcv";
1652         let mut read_mem = [0; 4];
1653         let tmpdir = tmpdir();
1654         let filename = &tmpdir.join("file_rt_io_file_test_seek_shakedown.txt");
1655         {
1656             let mut rw_stream = check!(File::create(filename));
1657             check!(rw_stream.write(initial_msg.as_bytes()));
1658         }
1659         {
1660             let mut read_stream = check!(File::open(filename));
1661
1662             check!(read_stream.seek(SeekFrom::End(-4)));
1663             check!(read_stream.read(&mut read_mem));
1664             assert_eq!(str::from_utf8(&read_mem).unwrap(), chunk_three);
1665
1666             check!(read_stream.seek(SeekFrom::Current(-9)));
1667             check!(read_stream.read(&mut read_mem));
1668             assert_eq!(str::from_utf8(&read_mem).unwrap(), chunk_two);
1669
1670             check!(read_stream.seek(SeekFrom::Start(0)));
1671             check!(read_stream.read(&mut read_mem));
1672             assert_eq!(str::from_utf8(&read_mem).unwrap(), chunk_one);
1673         }
1674         check!(fs::remove_file(filename));
1675     }
1676
1677     #[test]
1678     fn file_test_stat_is_correct_on_is_file() {
1679         let tmpdir = tmpdir();
1680         let filename = &tmpdir.join("file_stat_correct_on_is_file.txt");
1681         {
1682             let mut opts = OpenOptions::new();
1683             let mut fs = check!(opts.read(true).write(true)
1684                                     .create(true).open(filename));
1685             let msg = "hw";
1686             fs.write(msg.as_bytes()).unwrap();
1687
1688             let fstat_res = check!(fs.metadata());
1689             assert!(fstat_res.is_file());
1690         }
1691         let stat_res_fn = check!(fs::metadata(filename));
1692         assert!(stat_res_fn.is_file());
1693         let stat_res_meth = check!(filename.metadata());
1694         assert!(stat_res_meth.is_file());
1695         check!(fs::remove_file(filename));
1696     }
1697
1698     #[test]
1699     fn file_test_stat_is_correct_on_is_dir() {
1700         let tmpdir = tmpdir();
1701         let filename = &tmpdir.join("file_stat_correct_on_is_dir");
1702         check!(fs::create_dir(filename));
1703         let stat_res_fn = check!(fs::metadata(filename));
1704         assert!(stat_res_fn.is_dir());
1705         let stat_res_meth = check!(filename.metadata());
1706         assert!(stat_res_meth.is_dir());
1707         check!(fs::remove_dir(filename));
1708     }
1709
1710     #[test]
1711     fn file_test_fileinfo_false_when_checking_is_file_on_a_directory() {
1712         let tmpdir = tmpdir();
1713         let dir = &tmpdir.join("fileinfo_false_on_dir");
1714         check!(fs::create_dir(dir));
1715         assert!(!dir.is_file());
1716         check!(fs::remove_dir(dir));
1717     }
1718
1719     #[test]
1720     fn file_test_fileinfo_check_exists_before_and_after_file_creation() {
1721         let tmpdir = tmpdir();
1722         let file = &tmpdir.join("fileinfo_check_exists_b_and_a.txt");
1723         check!(check!(File::create(file)).write(b"foo"));
1724         assert!(file.exists());
1725         check!(fs::remove_file(file));
1726         assert!(!file.exists());
1727     }
1728
1729     #[test]
1730     fn file_test_directoryinfo_check_exists_before_and_after_mkdir() {
1731         let tmpdir = tmpdir();
1732         let dir = &tmpdir.join("before_and_after_dir");
1733         assert!(!dir.exists());
1734         check!(fs::create_dir(dir));
1735         assert!(dir.exists());
1736         assert!(dir.is_dir());
1737         check!(fs::remove_dir(dir));
1738         assert!(!dir.exists());
1739     }
1740
1741     #[test]
1742     fn file_test_directoryinfo_readdir() {
1743         let tmpdir = tmpdir();
1744         let dir = &tmpdir.join("di_readdir");
1745         check!(fs::create_dir(dir));
1746         let prefix = "foo";
1747         for n in 0..3 {
1748             let f = dir.join(&format!("{}.txt", n));
1749             let mut w = check!(File::create(&f));
1750             let msg_str = format!("{}{}", prefix, n.to_string());
1751             let msg = msg_str.as_bytes();
1752             check!(w.write(msg));
1753         }
1754         let files = check!(fs::read_dir(dir));
1755         let mut mem = [0; 4];
1756         for f in files {
1757             let f = f.unwrap().path();
1758             {
1759                 let n = f.file_stem().unwrap();
1760                 check!(check!(File::open(&f)).read(&mut mem));
1761                 let read_str = str::from_utf8(&mem).unwrap();
1762                 let expected = format!("{}{}", prefix, n.to_str().unwrap());
1763                 assert_eq!(expected, read_str);
1764             }
1765             check!(fs::remove_file(&f));
1766         }
1767         check!(fs::remove_dir(dir));
1768     }
1769
1770     #[test]
1771     fn mkdir_path_already_exists_error() {
1772         let tmpdir = tmpdir();
1773         let dir = &tmpdir.join("mkdir_error_twice");
1774         check!(fs::create_dir(dir));
1775         let e = fs::create_dir(dir).err().unwrap();
1776         assert_eq!(e.kind(), ErrorKind::AlreadyExists);
1777     }
1778
1779     #[test]
1780     fn recursive_mkdir() {
1781         let tmpdir = tmpdir();
1782         let dir = tmpdir.join("d1/d2");
1783         check!(fs::create_dir_all(&dir));
1784         assert!(dir.is_dir())
1785     }
1786
1787     #[test]
1788     fn recursive_mkdir_failure() {
1789         let tmpdir = tmpdir();
1790         let dir = tmpdir.join("d1");
1791         let file = dir.join("f1");
1792
1793         check!(fs::create_dir_all(&dir));
1794         check!(File::create(&file));
1795
1796         let result = fs::create_dir_all(&file);
1797
1798         assert!(result.is_err());
1799     }
1800
1801     #[test]
1802     fn recursive_mkdir_slash() {
1803         check!(fs::create_dir_all(&Path::new("/")));
1804     }
1805
1806     #[test]
1807     fn recursive_rmdir() {
1808         let tmpdir = tmpdir();
1809         let d1 = tmpdir.join("d1");
1810         let dt = d1.join("t");
1811         let dtt = dt.join("t");
1812         let d2 = tmpdir.join("d2");
1813         let canary = d2.join("do_not_delete");
1814         check!(fs::create_dir_all(&dtt));
1815         check!(fs::create_dir_all(&d2));
1816         check!(check!(File::create(&canary)).write(b"foo"));
1817         check!(symlink_junction(&d2, &dt.join("d2")));
1818         let _ = symlink_file(&canary, &d1.join("canary"));
1819         check!(fs::remove_dir_all(&d1));
1820
1821         assert!(!d1.is_dir());
1822         assert!(canary.exists());
1823     }
1824
1825     #[test]
1826     fn recursive_rmdir_of_symlink() {
1827         // test we do not recursively delete a symlink but only dirs.
1828         let tmpdir = tmpdir();
1829         let link = tmpdir.join("d1");
1830         let dir = tmpdir.join("d2");
1831         let canary = dir.join("do_not_delete");
1832         check!(fs::create_dir_all(&dir));
1833         check!(check!(File::create(&canary)).write(b"foo"));
1834         check!(symlink_junction(&dir, &link));
1835         check!(fs::remove_dir_all(&link));
1836
1837         assert!(!link.is_dir());
1838         assert!(canary.exists());
1839     }
1840
1841     #[test]
1842     // only Windows makes a distinction between file and directory symlinks.
1843     #[cfg(windows)]
1844     fn recursive_rmdir_of_file_symlink() {
1845         let tmpdir = tmpdir();
1846         if !got_symlink_permission(&tmpdir) { return };
1847
1848         let f1 = tmpdir.join("f1");
1849         let f2 = tmpdir.join("f2");
1850         check!(check!(File::create(&f1)).write(b"foo"));
1851         check!(symlink_file(&f1, &f2));
1852         match fs::remove_dir_all(&f2) {
1853             Ok(..) => panic!("wanted a failure"),
1854             Err(..) => {}
1855         }
1856     }
1857
1858     #[test]
1859     fn unicode_path_is_dir() {
1860         assert!(Path::new(".").is_dir());
1861         assert!(!Path::new("test/stdtest/fs.rs").is_dir());
1862
1863         let tmpdir = tmpdir();
1864
1865         let mut dirpath = tmpdir.path().to_path_buf();
1866         dirpath.push("test-가一ー你好");
1867         check!(fs::create_dir(&dirpath));
1868         assert!(dirpath.is_dir());
1869
1870         let mut filepath = dirpath;
1871         filepath.push("unicode-file-\u{ac00}\u{4e00}\u{30fc}\u{4f60}\u{597d}.rs");
1872         check!(File::create(&filepath)); // ignore return; touch only
1873         assert!(!filepath.is_dir());
1874         assert!(filepath.exists());
1875     }
1876
1877     #[test]
1878     fn unicode_path_exists() {
1879         assert!(Path::new(".").exists());
1880         assert!(!Path::new("test/nonexistent-bogus-path").exists());
1881
1882         let tmpdir = tmpdir();
1883         let unicode = tmpdir.path();
1884         let unicode = unicode.join(&format!("test-각丁ー再见"));
1885         check!(fs::create_dir(&unicode));
1886         assert!(unicode.exists());
1887         assert!(!Path::new("test/unicode-bogus-path-각丁ー再见").exists());
1888     }
1889
1890     #[test]
1891     fn copy_file_does_not_exist() {
1892         let from = Path::new("test/nonexistent-bogus-path");
1893         let to = Path::new("test/other-bogus-path");
1894
1895         match fs::copy(&from, &to) {
1896             Ok(..) => panic!(),
1897             Err(..) => {
1898                 assert!(!from.exists());
1899                 assert!(!to.exists());
1900             }
1901         }
1902     }
1903
1904     #[test]
1905     fn copy_src_does_not_exist() {
1906         let tmpdir = tmpdir();
1907         let from = Path::new("test/nonexistent-bogus-path");
1908         let to = tmpdir.join("out.txt");
1909         check!(check!(File::create(&to)).write(b"hello"));
1910         assert!(fs::copy(&from, &to).is_err());
1911         assert!(!from.exists());
1912         let mut v = Vec::new();
1913         check!(check!(File::open(&to)).read_to_end(&mut v));
1914         assert_eq!(v, b"hello");
1915     }
1916
1917     #[test]
1918     fn copy_file_ok() {
1919         let tmpdir = tmpdir();
1920         let input = tmpdir.join("in.txt");
1921         let out = tmpdir.join("out.txt");
1922
1923         check!(check!(File::create(&input)).write(b"hello"));
1924         check!(fs::copy(&input, &out));
1925         let mut v = Vec::new();
1926         check!(check!(File::open(&out)).read_to_end(&mut v));
1927         assert_eq!(v, b"hello");
1928
1929         assert_eq!(check!(input.metadata()).permissions(),
1930                    check!(out.metadata()).permissions());
1931     }
1932
1933     #[test]
1934     fn copy_file_dst_dir() {
1935         let tmpdir = tmpdir();
1936         let out = tmpdir.join("out");
1937
1938         check!(File::create(&out));
1939         match fs::copy(&*out, tmpdir.path()) {
1940             Ok(..) => panic!(), Err(..) => {}
1941         }
1942     }
1943
1944     #[test]
1945     fn copy_file_dst_exists() {
1946         let tmpdir = tmpdir();
1947         let input = tmpdir.join("in");
1948         let output = tmpdir.join("out");
1949
1950         check!(check!(File::create(&input)).write("foo".as_bytes()));
1951         check!(check!(File::create(&output)).write("bar".as_bytes()));
1952         check!(fs::copy(&input, &output));
1953
1954         let mut v = Vec::new();
1955         check!(check!(File::open(&output)).read_to_end(&mut v));
1956         assert_eq!(v, b"foo".to_vec());
1957     }
1958
1959     #[test]
1960     fn copy_file_src_dir() {
1961         let tmpdir = tmpdir();
1962         let out = tmpdir.join("out");
1963
1964         match fs::copy(tmpdir.path(), &out) {
1965             Ok(..) => panic!(), Err(..) => {}
1966         }
1967         assert!(!out.exists());
1968     }
1969
1970     #[test]
1971     fn copy_file_preserves_perm_bits() {
1972         let tmpdir = tmpdir();
1973         let input = tmpdir.join("in.txt");
1974         let out = tmpdir.join("out.txt");
1975
1976         let attr = check!(check!(File::create(&input)).metadata());
1977         let mut p = attr.permissions();
1978         p.set_readonly(true);
1979         check!(fs::set_permissions(&input, p));
1980         check!(fs::copy(&input, &out));
1981         assert!(check!(out.metadata()).permissions().readonly());
1982         check!(fs::set_permissions(&input, attr.permissions()));
1983         check!(fs::set_permissions(&out, attr.permissions()));
1984     }
1985
1986     #[cfg(windows)]
1987     #[test]
1988     fn copy_file_preserves_streams() {
1989         let tmp = tmpdir();
1990         check!(check!(File::create(tmp.join("in.txt:bunny"))).write("carrot".as_bytes()));
1991         assert_eq!(check!(fs::copy(tmp.join("in.txt"), tmp.join("out.txt"))), 6);
1992         assert_eq!(check!(tmp.join("out.txt").metadata()).len(), 0);
1993         let mut v = Vec::new();
1994         check!(check!(File::open(tmp.join("out.txt:bunny"))).read_to_end(&mut v));
1995         assert_eq!(v, b"carrot".to_vec());
1996     }
1997
1998     #[test]
1999     fn symlinks_work() {
2000         let tmpdir = tmpdir();
2001         if !got_symlink_permission(&tmpdir) { return };
2002
2003         let input = tmpdir.join("in.txt");
2004         let out = tmpdir.join("out.txt");
2005
2006         check!(check!(File::create(&input)).write("foobar".as_bytes()));
2007         check!(symlink_file(&input, &out));
2008         assert!(check!(out.symlink_metadata()).file_type().is_symlink());
2009         assert_eq!(check!(fs::metadata(&out)).len(),
2010                    check!(fs::metadata(&input)).len());
2011         let mut v = Vec::new();
2012         check!(check!(File::open(&out)).read_to_end(&mut v));
2013         assert_eq!(v, b"foobar".to_vec());
2014     }
2015
2016     #[test]
2017     fn symlink_noexist() {
2018         // Symlinks can point to things that don't exist
2019         let tmpdir = tmpdir();
2020         if !got_symlink_permission(&tmpdir) { return };
2021
2022         // Use a relative path for testing. Symlinks get normalized by Windows,
2023         // so we may not get the same path back for absolute paths
2024         check!(symlink_file(&"foo", &tmpdir.join("bar")));
2025         assert_eq!(check!(fs::read_link(&tmpdir.join("bar"))).to_str().unwrap(),
2026                    "foo");
2027     }
2028
2029     #[test]
2030     fn read_link() {
2031         if cfg!(windows) {
2032             // directory symlink
2033             assert_eq!(check!(fs::read_link(r"C:\Users\All Users")).to_str().unwrap(),
2034                        r"C:\ProgramData");
2035             // junction
2036             assert_eq!(check!(fs::read_link(r"C:\Users\Default User")).to_str().unwrap(),
2037                        r"C:\Users\Default");
2038             // junction with special permissions
2039             assert_eq!(check!(fs::read_link(r"C:\Documents and Settings\")).to_str().unwrap(),
2040                        r"C:\Users");
2041         }
2042         let tmpdir = tmpdir();
2043         let link = tmpdir.join("link");
2044         if !got_symlink_permission(&tmpdir) { return };
2045         check!(symlink_file(&"foo", &link));
2046         assert_eq!(check!(fs::read_link(&link)).to_str().unwrap(), "foo");
2047     }
2048
2049     #[test]
2050     fn readlink_not_symlink() {
2051         let tmpdir = tmpdir();
2052         match fs::read_link(tmpdir.path()) {
2053             Ok(..) => panic!("wanted a failure"),
2054             Err(..) => {}
2055         }
2056     }
2057
2058     #[test]
2059     fn links_work() {
2060         let tmpdir = tmpdir();
2061         let input = tmpdir.join("in.txt");
2062         let out = tmpdir.join("out.txt");
2063
2064         check!(check!(File::create(&input)).write("foobar".as_bytes()));
2065         check!(fs::hard_link(&input, &out));
2066         assert_eq!(check!(fs::metadata(&out)).len(),
2067                    check!(fs::metadata(&input)).len());
2068         assert_eq!(check!(fs::metadata(&out)).len(),
2069                    check!(input.metadata()).len());
2070         let mut v = Vec::new();
2071         check!(check!(File::open(&out)).read_to_end(&mut v));
2072         assert_eq!(v, b"foobar".to_vec());
2073
2074         // can't link to yourself
2075         match fs::hard_link(&input, &input) {
2076             Ok(..) => panic!("wanted a failure"),
2077             Err(..) => {}
2078         }
2079         // can't link to something that doesn't exist
2080         match fs::hard_link(&tmpdir.join("foo"), &tmpdir.join("bar")) {
2081             Ok(..) => panic!("wanted a failure"),
2082             Err(..) => {}
2083         }
2084     }
2085
2086     #[test]
2087     fn chmod_works() {
2088         let tmpdir = tmpdir();
2089         let file = tmpdir.join("in.txt");
2090
2091         check!(File::create(&file));
2092         let attr = check!(fs::metadata(&file));
2093         assert!(!attr.permissions().readonly());
2094         let mut p = attr.permissions();
2095         p.set_readonly(true);
2096         check!(fs::set_permissions(&file, p.clone()));
2097         let attr = check!(fs::metadata(&file));
2098         assert!(attr.permissions().readonly());
2099
2100         match fs::set_permissions(&tmpdir.join("foo"), p.clone()) {
2101             Ok(..) => panic!("wanted an error"),
2102             Err(..) => {}
2103         }
2104
2105         p.set_readonly(false);
2106         check!(fs::set_permissions(&file, p));
2107     }
2108
2109     #[test]
2110     fn sync_doesnt_kill_anything() {
2111         let tmpdir = tmpdir();
2112         let path = tmpdir.join("in.txt");
2113
2114         let mut file = check!(File::create(&path));
2115         check!(file.sync_all());
2116         check!(file.sync_data());
2117         check!(file.write(b"foo"));
2118         check!(file.sync_all());
2119         check!(file.sync_data());
2120     }
2121
2122     #[test]
2123     fn truncate_works() {
2124         let tmpdir = tmpdir();
2125         let path = tmpdir.join("in.txt");
2126
2127         let mut file = check!(File::create(&path));
2128         check!(file.write(b"foo"));
2129         check!(file.sync_all());
2130
2131         // Do some simple things with truncation
2132         assert_eq!(check!(file.metadata()).len(), 3);
2133         check!(file.set_len(10));
2134         assert_eq!(check!(file.metadata()).len(), 10);
2135         check!(file.write(b"bar"));
2136         check!(file.sync_all());
2137         assert_eq!(check!(file.metadata()).len(), 10);
2138
2139         let mut v = Vec::new();
2140         check!(check!(File::open(&path)).read_to_end(&mut v));
2141         assert_eq!(v, b"foobar\0\0\0\0".to_vec());
2142
2143         // Truncate to a smaller length, don't seek, and then write something.
2144         // Ensure that the intermediate zeroes are all filled in (we have `seek`ed
2145         // past the end of the file).
2146         check!(file.set_len(2));
2147         assert_eq!(check!(file.metadata()).len(), 2);
2148         check!(file.write(b"wut"));
2149         check!(file.sync_all());
2150         assert_eq!(check!(file.metadata()).len(), 9);
2151         let mut v = Vec::new();
2152         check!(check!(File::open(&path)).read_to_end(&mut v));
2153         assert_eq!(v, b"fo\0\0\0\0wut".to_vec());
2154     }
2155
2156     #[test]
2157     fn open_flavors() {
2158         use fs::OpenOptions as OO;
2159         fn c<T: Clone>(t: &T) -> T { t.clone() }
2160
2161         let tmpdir = tmpdir();
2162
2163         let mut r = OO::new(); r.read(true);
2164         let mut w = OO::new(); w.write(true);
2165         let mut rw = OO::new(); rw.read(true).write(true);
2166         let mut a = OO::new(); a.append(true);
2167         let mut ra = OO::new(); ra.read(true).append(true);
2168
2169         let invalid_options = if cfg!(windows) { "The parameter is incorrect" }
2170                               else { "Invalid argument" };
2171
2172         // Test various combinations of creation modes and access modes.
2173         //
2174         // Allowed:
2175         // creation mode           | read  | write | read-write | append | read-append |
2176         // :-----------------------|:-----:|:-----:|:----------:|:------:|:-----------:|
2177         // not set (open existing) |   X   |   X   |     X      |   X    |      X      |
2178         // create                  |       |   X   |     X      |   X    |      X      |
2179         // truncate                |       |   X   |     X      |        |             |
2180         // create and truncate     |       |   X   |     X      |        |             |
2181         // create_new              |       |   X   |     X      |   X    |      X      |
2182         //
2183         // tested in reverse order, so 'create_new' creates the file, and 'open existing' opens it.
2184
2185         // write-only
2186         check!(c(&w).create_new(true).open(&tmpdir.join("a")));
2187         check!(c(&w).create(true).truncate(true).open(&tmpdir.join("a")));
2188         check!(c(&w).truncate(true).open(&tmpdir.join("a")));
2189         check!(c(&w).create(true).open(&tmpdir.join("a")));
2190         check!(c(&w).open(&tmpdir.join("a")));
2191
2192         // read-only
2193         error!(c(&r).create_new(true).open(&tmpdir.join("b")), invalid_options);
2194         error!(c(&r).create(true).truncate(true).open(&tmpdir.join("b")), invalid_options);
2195         error!(c(&r).truncate(true).open(&tmpdir.join("b")), invalid_options);
2196         error!(c(&r).create(true).open(&tmpdir.join("b")), invalid_options);
2197         check!(c(&r).open(&tmpdir.join("a"))); // try opening the file created with write_only
2198
2199         // read-write
2200         check!(c(&rw).create_new(true).open(&tmpdir.join("c")));
2201         check!(c(&rw).create(true).truncate(true).open(&tmpdir.join("c")));
2202         check!(c(&rw).truncate(true).open(&tmpdir.join("c")));
2203         check!(c(&rw).create(true).open(&tmpdir.join("c")));
2204         check!(c(&rw).open(&tmpdir.join("c")));
2205
2206         // append
2207         check!(c(&a).create_new(true).open(&tmpdir.join("d")));
2208         error!(c(&a).create(true).truncate(true).open(&tmpdir.join("d")), invalid_options);
2209         error!(c(&a).truncate(true).open(&tmpdir.join("d")), invalid_options);
2210         check!(c(&a).create(true).open(&tmpdir.join("d")));
2211         check!(c(&a).open(&tmpdir.join("d")));
2212
2213         // read-append
2214         check!(c(&ra).create_new(true).open(&tmpdir.join("e")));
2215         error!(c(&ra).create(true).truncate(true).open(&tmpdir.join("e")), invalid_options);
2216         error!(c(&ra).truncate(true).open(&tmpdir.join("e")), invalid_options);
2217         check!(c(&ra).create(true).open(&tmpdir.join("e")));
2218         check!(c(&ra).open(&tmpdir.join("e")));
2219
2220         // Test opening a file without setting an access mode
2221         let mut blank = OO::new();
2222          error!(blank.create(true).open(&tmpdir.join("f")), invalid_options);
2223
2224         // Test write works
2225         check!(check!(File::create(&tmpdir.join("h"))).write("foobar".as_bytes()));
2226
2227         // Test write fails for read-only
2228         check!(r.open(&tmpdir.join("h")));
2229         {
2230             let mut f = check!(r.open(&tmpdir.join("h")));
2231             assert!(f.write("wut".as_bytes()).is_err());
2232         }
2233
2234         // Test write overwrites
2235         {
2236             let mut f = check!(c(&w).open(&tmpdir.join("h")));
2237             check!(f.write("baz".as_bytes()));
2238         }
2239         {
2240             let mut f = check!(c(&r).open(&tmpdir.join("h")));
2241             let mut b = vec![0; 6];
2242             check!(f.read(&mut b));
2243             assert_eq!(b, "bazbar".as_bytes());
2244         }
2245
2246         // Test truncate works
2247         {
2248             let mut f = check!(c(&w).truncate(true).open(&tmpdir.join("h")));
2249             check!(f.write("foo".as_bytes()));
2250         }
2251         assert_eq!(check!(fs::metadata(&tmpdir.join("h"))).len(), 3);
2252
2253         // Test append works
2254         assert_eq!(check!(fs::metadata(&tmpdir.join("h"))).len(), 3);
2255         {
2256             let mut f = check!(c(&a).open(&tmpdir.join("h")));
2257             check!(f.write("bar".as_bytes()));
2258         }
2259         assert_eq!(check!(fs::metadata(&tmpdir.join("h"))).len(), 6);
2260
2261         // Test .append(true) equals .write(true).append(true)
2262         {
2263             let mut f = check!(c(&w).append(true).open(&tmpdir.join("h")));
2264             check!(f.write("baz".as_bytes()));
2265         }
2266         assert_eq!(check!(fs::metadata(&tmpdir.join("h"))).len(), 9);
2267     }
2268
2269     #[test]
2270     fn _assert_send_sync() {
2271         fn _assert_send_sync<T: Send + Sync>() {}
2272         _assert_send_sync::<OpenOptions>();
2273     }
2274
2275     #[test]
2276     fn binary_file() {
2277         let mut bytes = [0; 1024];
2278         StdRng::new().unwrap().fill_bytes(&mut bytes);
2279
2280         let tmpdir = tmpdir();
2281
2282         check!(check!(File::create(&tmpdir.join("test"))).write(&bytes));
2283         let mut v = Vec::new();
2284         check!(check!(File::open(&tmpdir.join("test"))).read_to_end(&mut v));
2285         assert!(v == &bytes[..]);
2286     }
2287
2288     #[test]
2289     fn file_try_clone() {
2290         let tmpdir = tmpdir();
2291
2292         let mut f1 = check!(OpenOptions::new()
2293                                        .read(true)
2294                                        .write(true)
2295                                        .create(true)
2296                                        .open(&tmpdir.join("test")));
2297         let mut f2 = check!(f1.try_clone());
2298
2299         check!(f1.write_all(b"hello world"));
2300         check!(f1.seek(SeekFrom::Start(2)));
2301
2302         let mut buf = vec![];
2303         check!(f2.read_to_end(&mut buf));
2304         assert_eq!(buf, b"llo world");
2305         drop(f2);
2306
2307         check!(f1.write_all(b"!"));
2308     }
2309
2310     #[test]
2311     #[cfg(not(windows))]
2312     fn unlink_readonly() {
2313         let tmpdir = tmpdir();
2314         let path = tmpdir.join("file");
2315         check!(File::create(&path));
2316         let mut perm = check!(fs::metadata(&path)).permissions();
2317         perm.set_readonly(true);
2318         check!(fs::set_permissions(&path, perm));
2319         check!(fs::remove_file(&path));
2320     }
2321
2322     #[test]
2323     fn mkdir_trailing_slash() {
2324         let tmpdir = tmpdir();
2325         let path = tmpdir.join("file");
2326         check!(fs::create_dir_all(&path.join("a/")));
2327     }
2328
2329     #[test]
2330     fn canonicalize_works_simple() {
2331         let tmpdir = tmpdir();
2332         let tmpdir = fs::canonicalize(tmpdir.path()).unwrap();
2333         let file = tmpdir.join("test");
2334         File::create(&file).unwrap();
2335         assert_eq!(fs::canonicalize(&file).unwrap(), file);
2336     }
2337
2338     #[test]
2339     fn realpath_works() {
2340         let tmpdir = tmpdir();
2341         if !got_symlink_permission(&tmpdir) { return };
2342
2343         let tmpdir = fs::canonicalize(tmpdir.path()).unwrap();
2344         let file = tmpdir.join("test");
2345         let dir = tmpdir.join("test2");
2346         let link = dir.join("link");
2347         let linkdir = tmpdir.join("test3");
2348
2349         File::create(&file).unwrap();
2350         fs::create_dir(&dir).unwrap();
2351         symlink_file(&file, &link).unwrap();
2352         symlink_dir(&dir, &linkdir).unwrap();
2353
2354         assert!(link.symlink_metadata().unwrap().file_type().is_symlink());
2355
2356         assert_eq!(fs::canonicalize(&tmpdir).unwrap(), tmpdir);
2357         assert_eq!(fs::canonicalize(&file).unwrap(), file);
2358         assert_eq!(fs::canonicalize(&link).unwrap(), file);
2359         assert_eq!(fs::canonicalize(&linkdir).unwrap(), dir);
2360         assert_eq!(fs::canonicalize(&linkdir.join("link")).unwrap(), file);
2361     }
2362
2363     #[test]
2364     fn realpath_works_tricky() {
2365         let tmpdir = tmpdir();
2366         if !got_symlink_permission(&tmpdir) { return };
2367
2368         let tmpdir = fs::canonicalize(tmpdir.path()).unwrap();
2369         let a = tmpdir.join("a");
2370         let b = a.join("b");
2371         let c = b.join("c");
2372         let d = a.join("d");
2373         let e = d.join("e");
2374         let f = a.join("f");
2375
2376         fs::create_dir_all(&b).unwrap();
2377         fs::create_dir_all(&d).unwrap();
2378         File::create(&f).unwrap();
2379         if cfg!(not(windows)) {
2380             symlink_dir("../d/e", &c).unwrap();
2381             symlink_file("../f", &e).unwrap();
2382         }
2383         if cfg!(windows) {
2384             symlink_dir(r"..\d\e", &c).unwrap();
2385             symlink_file(r"..\f", &e).unwrap();
2386         }
2387
2388         assert_eq!(fs::canonicalize(&c).unwrap(), f);
2389         assert_eq!(fs::canonicalize(&e).unwrap(), f);
2390     }
2391
2392     #[test]
2393     fn dir_entry_methods() {
2394         let tmpdir = tmpdir();
2395
2396         fs::create_dir_all(&tmpdir.join("a")).unwrap();
2397         File::create(&tmpdir.join("b")).unwrap();
2398
2399         for file in tmpdir.path().read_dir().unwrap().map(|f| f.unwrap()) {
2400             let fname = file.file_name();
2401             match fname.to_str() {
2402                 Some("a") => {
2403                     assert!(file.file_type().unwrap().is_dir());
2404                     assert!(file.metadata().unwrap().is_dir());
2405                 }
2406                 Some("b") => {
2407                     assert!(file.file_type().unwrap().is_file());
2408                     assert!(file.metadata().unwrap().is_file());
2409                 }
2410                 f => panic!("unknown file name: {:?}", f),
2411             }
2412         }
2413     }
2414
2415     #[test]
2416     fn read_dir_not_found() {
2417         let res = fs::read_dir("/path/that/does/not/exist");
2418         assert_eq!(res.err().unwrap().kind(), ErrorKind::NotFound);
2419     }
2420
2421     #[test]
2422     fn create_dir_all_with_junctions() {
2423         let tmpdir = tmpdir();
2424         let target = tmpdir.join("target");
2425
2426         let junction = tmpdir.join("junction");
2427         let b = junction.join("a/b");
2428
2429         let link = tmpdir.join("link");
2430         let d = link.join("c/d");
2431
2432         fs::create_dir(&target).unwrap();
2433
2434         check!(symlink_junction(&target, &junction));
2435         check!(fs::create_dir_all(&b));
2436         // the junction itself is not a directory, but `is_dir()` on a Path
2437         // follows links
2438         assert!(junction.is_dir());
2439         assert!(b.exists());
2440
2441         if !got_symlink_permission(&tmpdir) { return };
2442         check!(symlink_dir(&target, &link));
2443         check!(fs::create_dir_all(&d));
2444         assert!(link.is_dir());
2445         assert!(d.exists());
2446     }
2447
2448     #[test]
2449     fn metadata_access_times() {
2450         let tmpdir = tmpdir();
2451
2452         let b = tmpdir.join("b");
2453         File::create(&b).unwrap();
2454
2455         let a = check!(fs::metadata(&tmpdir.path()));
2456         let b = check!(fs::metadata(&b));
2457
2458         assert_eq!(check!(a.accessed()), check!(a.accessed()));
2459         assert_eq!(check!(a.modified()), check!(a.modified()));
2460         assert_eq!(check!(b.accessed()), check!(b.modified()));
2461
2462         if cfg!(target_os = "macos") || cfg!(target_os = "windows") {
2463             check!(a.created());
2464             check!(b.created());
2465         }
2466     }
2467 }