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