]> git.lizzy.rs Git - rust.git/blob - src/libstd/io/fs.rs
doc: remove incomplete sentence
[rust.git] / src / libstd / io / fs.rs
1 // Copyright 2013-2014 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 // ignore-lexer-test FIXME #15679
12
13 //! Synchronous File I/O
14 //!
15 //! This module provides a set of functions and traits for working
16 //! with regular files & directories on a filesystem.
17 //!
18 //! At the top-level of the module are a set of freestanding functions, associated
19 //! with various filesystem operations. They all operate on `Path` objects.
20 //!
21 //! All operations in this module, including those as part of `File` et al
22 //! block the task during execution. In the event of failure, all functions/methods
23 //! will return an `IoResult` type with an `Err` value.
24 //!
25 //! Also included in this module is an implementation block on the `Path` object
26 //! defined in `std::path::Path`. The impl adds useful methods about inspecting the
27 //! metadata of a file. This includes getting the `stat` information, reading off
28 //! particular bits of it, etc.
29 //!
30 //! # Example
31 //!
32 //! ```rust
33 //! # #![allow(unused_must_use)]
34 //! use std::io::fs::PathExtensions;
35 //! use std::io::{File, fs};
36 //!
37 //! let path = Path::new("foo.txt");
38 //!
39 //! // create the file, whether it exists or not
40 //! let mut file = File::create(&path);
41 //! file.write(b"foobar");
42 //! # drop(file);
43 //!
44 //! // open the file in read-only mode
45 //! let mut file = File::open(&path);
46 //! file.read_to_end();
47 //!
48 //! println!("{}", path.stat().unwrap().size);
49 //! # drop(file);
50 //! fs::unlink(&path);
51 //! ```
52
53 use clone::Clone;
54 use io::standard_error;
55 use io::{FilePermission, Write, Open, FileAccess, FileMode, FileType};
56 use io::{IoResult, IoError, InvalidInput};
57 use io::{FileStat, SeekStyle, Seek, Writer, Reader};
58 use io::{Read, Truncate, ReadWrite, Append};
59 use io::UpdateIoError;
60 use io;
61 use iter::{Iterator, Extend};
62 use option::Option;
63 use option::Option::{Some, None};
64 use path::{Path, GenericPath};
65 use path;
66 use result::Result::{Err, Ok};
67 use slice::SliceExt;
68 use string::String;
69 use vec::Vec;
70
71 use sys::fs as fs_imp;
72 use sys_common;
73
74 /// Unconstrained file access type that exposes read and write operations
75 ///
76 /// Can be constructed via `File::open()`, `File::create()`, and
77 /// `File::open_mode()`.
78 ///
79 /// # Error
80 ///
81 /// This type will return errors as an `IoResult<T>` if operations are
82 /// attempted against it for which its underlying file descriptor was not
83 /// configured at creation time, via the `FileAccess` parameter to
84 /// `File::open_mode()`.
85 pub struct File {
86     fd: fs_imp::FileDesc,
87     path: Path,
88     last_nread: int,
89 }
90
91 impl sys_common::AsInner<fs_imp::FileDesc> for File {
92     fn as_inner(&self) -> &fs_imp::FileDesc {
93         &self.fd
94     }
95 }
96
97 impl File {
98     /// Open a file at `path` in the mode specified by the `mode` and `access`
99     /// arguments
100     ///
101     /// # Example
102     ///
103     /// ```rust,should_fail
104     /// use std::io::{File, Open, ReadWrite};
105     ///
106     /// let p = Path::new("/some/file/path.txt");
107     ///
108     /// let file = match File::open_mode(&p, Open, ReadWrite) {
109     ///     Ok(f) => f,
110     ///     Err(e) => panic!("file error: {}", e),
111     /// };
112     /// // do some stuff with that file
113     ///
114     /// // the file will be closed at the end of this block
115     /// ```
116     ///
117     /// `FileMode` and `FileAccess` provide information about the permissions
118     /// context in which a given stream is created. More information about them
119     /// can be found in `std::io`'s docs. If a file is opened with `Write`
120     /// or `ReadWrite` access, then it will be created if it does not already
121     /// exist.
122     ///
123     /// Note that, with this function, a `File` is returned regardless of the
124     /// access-limitations indicated by `FileAccess` (e.g. calling `write` on a
125     /// `File` opened as `Read` will return an error at runtime).
126     ///
127     /// # Error
128     ///
129     /// This function will return an error under a number of different
130     /// circumstances, to include but not limited to:
131     ///
132     /// * Opening a file that does not exist with `Read` access.
133     /// * Attempting to open a file with a `FileAccess` that the user lacks
134     ///   permissions for
135     /// * Filesystem-level errors (full disk, etc)
136     pub fn open_mode(path: &Path,
137                      mode: FileMode,
138                      access: FileAccess) -> IoResult<File> {
139         fs_imp::open(path, mode, access).and_then(|fd| {
140             // On *BSD systems, we can open a directory as a file and read from it:
141             // fd=open("/tmp", O_RDONLY); read(fd, buf, N);
142             // due to an old tradition before the introduction of opendir(3).
143             // We explicitly reject it because there are few use cases.
144             if cfg!(not(any(windows, target_os = "linux", target_os = "android"))) &&
145                try!(fd.fstat()).kind == FileType::Directory {
146                 Err(IoError {
147                     kind: InvalidInput,
148                     desc: "is a directory",
149                     detail: None
150                 })
151             } else {
152                 Ok(File {
153                     path: path.clone(),
154                     fd: fd,
155                     last_nread: -1
156                 })
157             }
158         }).update_err("couldn't open path as file", |e| {
159             format!("{}; path={}; mode={}; access={}", e, path.display(),
160                 mode_string(mode), access_string(access))
161         })
162     }
163
164     /// Attempts to open a file in read-only mode. This function is equivalent to
165     /// `File::open_mode(path, Open, Read)`, and will raise all of the same
166     /// errors that `File::open_mode` does.
167     ///
168     /// For more information, see the `File::open_mode` function.
169     ///
170     /// # Example
171     ///
172     /// ```rust
173     /// use std::io::File;
174     ///
175     /// let contents = File::open(&Path::new("foo.txt")).read_to_end();
176     /// ```
177     pub fn open(path: &Path) -> IoResult<File> {
178         File::open_mode(path, Open, Read)
179     }
180
181     /// Attempts to create a file in write-only mode. This function is
182     /// equivalent to `File::open_mode(path, Truncate, Write)`, and will
183     /// raise all of the same errors that `File::open_mode` does.
184     ///
185     /// For more information, see the `File::open_mode` function.
186     ///
187     /// # Example
188     ///
189     /// ```rust
190     /// # #![allow(unused_must_use)]
191     /// use std::io::File;
192     ///
193     /// let mut f = File::create(&Path::new("foo.txt"));
194     /// f.write(b"This is a sample file");
195     /// # drop(f);
196     /// # ::std::io::fs::unlink(&Path::new("foo.txt"));
197     /// ```
198     pub fn create(path: &Path) -> IoResult<File> {
199         File::open_mode(path, Truncate, Write)
200              .update_desc("couldn't create file")
201     }
202
203     /// Returns the original path that was used to open this file.
204     pub fn path<'a>(&'a self) -> &'a Path {
205         &self.path
206     }
207
208     /// Synchronizes all modifications to this file to its permanent storage
209     /// device. This will flush any internal buffers necessary to perform this
210     /// operation.
211     pub fn fsync(&mut self) -> IoResult<()> {
212         self.fd.fsync()
213             .update_err("couldn't fsync file",
214                         |e| format!("{}; path={}", e, self.path.display()))
215     }
216
217     /// This function is similar to `fsync`, except that it may not synchronize
218     /// file metadata to the filesystem. This is intended for use cases that
219     /// must synchronize content, but don't need the metadata on disk. The goal
220     /// of this method is to reduce disk operations.
221     pub fn datasync(&mut self) -> IoResult<()> {
222         self.fd.datasync()
223             .update_err("couldn't datasync file",
224                         |e| format!("{}; path={}", e, self.path.display()))
225     }
226
227     /// Either truncates or extends the underlying file, updating the size of
228     /// this file to become `size`. This is equivalent to unix's `truncate`
229     /// function.
230     ///
231     /// If the `size` is less than the current file's size, then the file will
232     /// be shrunk. If it is greater than the current file's size, then the file
233     /// will be extended to `size` and have all of the intermediate data filled
234     /// in with 0s.
235     pub fn truncate(&mut self, size: i64) -> IoResult<()> {
236         self.fd.truncate(size)
237             .update_err("couldn't truncate file", |e|
238                 format!("{}; path={}; size={}", e, self.path.display(), size))
239     }
240
241     /// Returns true if the stream has reached the end of the file.
242     ///
243     /// If true, then this file will no longer continue to return data via
244     /// `read`.
245     ///
246     /// Note that the operating system will not return an `EOF` indicator
247     /// until you have attempted to read past the end of the file, so if
248     /// you've read _exactly_ the number of bytes in the file, this will
249     /// return `false`, not `true`.
250     pub fn eof(&self) -> bool {
251         self.last_nread == 0
252     }
253
254     /// Queries information about the underlying file.
255     pub fn stat(&self) -> IoResult<FileStat> {
256         self.fd.fstat()
257             .update_err("couldn't fstat file", |e|
258                 format!("{}; path={}", e, self.path.display()))
259     }
260 }
261
262 /// Unlink a file from the underlying filesystem.
263 ///
264 /// # Example
265 ///
266 /// ```rust
267 /// # #![allow(unused_must_use)]
268 /// use std::io::fs;
269 ///
270 /// let p = Path::new("/some/file/path.txt");
271 /// fs::unlink(&p);
272 /// ```
273 ///
274 /// Note that, just because an unlink call was successful, it is not
275 /// guaranteed that a file is immediately deleted (e.g. depending on
276 /// platform, other open file descriptors may prevent immediate removal)
277 ///
278 /// # Error
279 ///
280 /// This function will return an error if `path` points to a directory, if the
281 /// user lacks permissions to remove the file, or if some other filesystem-level
282 /// error occurs.
283 pub fn unlink(path: &Path) -> IoResult<()> {
284     fs_imp::unlink(path)
285            .update_err("couldn't unlink path", |e|
286                format!("{}; path={}", e, path.display()))
287 }
288
289 /// Given a path, query the file system to get information about a file,
290 /// directory, etc. This function will traverse symlinks to query
291 /// information about the destination file.
292 ///
293 /// # Example
294 ///
295 /// ```rust
296 /// use std::io::fs;
297 ///
298 /// let p = Path::new("/some/file/path.txt");
299 /// match fs::stat(&p) {
300 ///     Ok(stat) => { /* ... */ }
301 ///     Err(e) => { /* handle error */ }
302 /// }
303 /// ```
304 ///
305 /// # Error
306 ///
307 /// This function will return an error if the user lacks the requisite permissions
308 /// to perform a `stat` call on the given `path` or if there is no entry in the
309 /// filesystem at the provided path.
310 pub fn stat(path: &Path) -> IoResult<FileStat> {
311     fs_imp::stat(path)
312            .update_err("couldn't stat path", |e|
313                format!("{}; path={}", e, path.display()))
314 }
315
316 /// Perform the same operation as the `stat` function, except that this
317 /// function does not traverse through symlinks. This will return
318 /// information about the symlink file instead of the file that it points
319 /// to.
320 ///
321 /// # Error
322 ///
323 /// See `stat`
324 pub fn lstat(path: &Path) -> IoResult<FileStat> {
325     fs_imp::lstat(path)
326            .update_err("couldn't lstat path", |e|
327                format!("{}; path={}", e, path.display()))
328 }
329
330 /// Rename a file or directory to a new name.
331 ///
332 /// # Example
333 ///
334 /// ```rust
335 /// # #![allow(unused_must_use)]
336 /// use std::io::fs;
337 ///
338 /// fs::rename(&Path::new("foo"), &Path::new("bar"));
339 /// ```
340 ///
341 /// # Error
342 ///
343 /// This function will return an error if the provided `from` doesn't exist, if
344 /// the process lacks permissions to view the contents, or if some other
345 /// intermittent I/O error occurs.
346 pub fn rename(from: &Path, to: &Path) -> IoResult<()> {
347     fs_imp::rename(from, to)
348            .update_err("couldn't rename path", |e|
349                format!("{}; from={}; to={}", e, from.display(), to.display()))
350 }
351
352 /// Copies the contents of one file to another. This function will also
353 /// copy the permission bits of the original file to the destination file.
354 ///
355 /// Note that if `from` and `to` both point to the same file, then the file
356 /// will likely get truncated by this operation.
357 ///
358 /// # Example
359 ///
360 /// ```rust
361 /// # #![allow(unused_must_use)]
362 /// use std::io::fs;
363 ///
364 /// fs::copy(&Path::new("foo.txt"), &Path::new("bar.txt"));
365 /// ```
366 ///
367 /// # Error
368 ///
369 /// This function will return an error in the following situations, but is not
370 /// limited to just these cases:
371 ///
372 /// * The `from` path is not a file
373 /// * The `from` file does not exist
374 /// * The current process does not have the permission rights to access
375 ///   `from` or write `to`
376 ///
377 /// Note that this copy is not atomic in that once the destination is
378 /// ensured to not exist, there is nothing preventing the destination from
379 /// being created and then destroyed by this operation.
380 pub fn copy(from: &Path, to: &Path) -> IoResult<()> {
381     fn update_err<T>(result: IoResult<T>, from: &Path, to: &Path) -> IoResult<T> {
382         result.update_err("couldn't copy path", |e| {
383             format!("{}; from={}; to={}", e, from.display(), to.display())
384         })
385     }
386
387     if !from.is_file() {
388         return update_err(Err(IoError {
389             kind: io::MismatchedFileTypeForOperation,
390             desc: "the source path is not an existing file",
391             detail: None
392         }), from, to)
393     }
394
395     let mut reader = try!(File::open(from));
396     let mut writer = try!(File::create(to));
397
398     try!(update_err(super::util::copy(&mut reader, &mut writer), from, to));
399
400     chmod(to, try!(update_err(from.stat(), from, to)).perm)
401 }
402
403 /// Changes the permission mode bits found on a file or a directory. This
404 /// function takes a mask from the `io` module
405 ///
406 /// # Example
407 ///
408 /// ```rust
409 /// # #![allow(unused_must_use)]
410 /// use std::io;
411 /// use std::io::fs;
412 ///
413 /// fs::chmod(&Path::new("file.txt"), io::USER_FILE);
414 /// fs::chmod(&Path::new("file.txt"), io::USER_READ | io::USER_WRITE);
415 /// fs::chmod(&Path::new("dir"),      io::USER_DIR);
416 /// fs::chmod(&Path::new("file.exe"), io::USER_EXEC);
417 /// ```
418 ///
419 /// # Error
420 ///
421 /// This function will return an error if the provided `path` doesn't exist, if
422 /// the process lacks permissions to change the attributes of the file, or if
423 /// some other I/O error is encountered.
424 pub fn chmod(path: &Path, mode: io::FilePermission) -> IoResult<()> {
425     fs_imp::chmod(path, mode.bits() as uint)
426            .update_err("couldn't chmod path", |e|
427                format!("{}; path={}; mode={}", e, path.display(), mode))
428 }
429
430 /// Change the user and group owners of a file at the specified path.
431 pub fn chown(path: &Path, uid: int, gid: int) -> IoResult<()> {
432     fs_imp::chown(path, uid, gid)
433            .update_err("couldn't chown path", |e|
434                format!("{}; path={}; uid={}; gid={}", e, path.display(), uid, gid))
435 }
436
437 /// Creates a new hard link on the filesystem. The `dst` path will be a
438 /// link pointing to the `src` path. Note that systems often require these
439 /// two paths to both be located on the same filesystem.
440 pub fn link(src: &Path, dst: &Path) -> IoResult<()> {
441     fs_imp::link(src, dst)
442            .update_err("couldn't link path", |e|
443                format!("{}; src={}; dest={}", e, src.display(), dst.display()))
444 }
445
446 /// Creates a new symbolic link on the filesystem. The `dst` path will be a
447 /// symlink pointing to the `src` path.
448 pub fn symlink(src: &Path, dst: &Path) -> IoResult<()> {
449     fs_imp::symlink(src, dst)
450            .update_err("couldn't symlink path", |e|
451                format!("{}; src={}; dest={}", e, src.display(), dst.display()))
452 }
453
454 /// Reads a symlink, returning the file that the symlink points to.
455 ///
456 /// # Error
457 ///
458 /// This function will return an error on failure. Failure conditions include
459 /// reading a file that does not exist or reading a file that is not a symlink.
460 pub fn readlink(path: &Path) -> IoResult<Path> {
461     fs_imp::readlink(path)
462            .update_err("couldn't resolve symlink for path", |e|
463                format!("{}; path={}", e, path.display()))
464 }
465
466 /// Create a new, empty directory at the provided path
467 ///
468 /// # Example
469 ///
470 /// ```rust
471 /// # #![allow(unused_must_use)]
472 /// use std::io;
473 /// use std::io::fs;
474 ///
475 /// let p = Path::new("/some/dir");
476 /// fs::mkdir(&p, io::USER_RWX);
477 /// ```
478 ///
479 /// # Error
480 ///
481 /// This function will return an error if the user lacks permissions to make a
482 /// new directory at the provided `path`, or if the directory already exists.
483 pub fn mkdir(path: &Path, mode: FilePermission) -> IoResult<()> {
484     fs_imp::mkdir(path, mode.bits() as uint)
485            .update_err("couldn't create directory", |e|
486                format!("{}; path={}; mode={}", e, path.display(), mode))
487 }
488
489 /// Remove an existing, empty directory
490 ///
491 /// # Example
492 ///
493 /// ```rust
494 /// # #![allow(unused_must_use)]
495 /// use std::io::fs;
496 ///
497 /// let p = Path::new("/some/dir");
498 /// fs::rmdir(&p);
499 /// ```
500 ///
501 /// # Error
502 ///
503 /// This function will return an error if the user lacks permissions to remove
504 /// the directory at the provided `path`, or if the directory isn't empty.
505 pub fn rmdir(path: &Path) -> IoResult<()> {
506     fs_imp::rmdir(path)
507            .update_err("couldn't remove directory", |e|
508                format!("{}; path={}", e, path.display()))
509 }
510
511 /// Retrieve a vector containing all entries within a provided directory
512 ///
513 /// # Example
514 ///
515 /// ```rust
516 /// use std::io::fs::PathExtensions;
517 /// use std::io::fs;
518 /// use std::io;
519 ///
520 /// // one possible implementation of fs::walk_dir only visiting files
521 /// fn visit_dirs(dir: &Path, cb: |&Path|) -> io::IoResult<()> {
522 ///     if dir.is_dir() {
523 ///         let contents = try!(fs::readdir(dir));
524 ///         for entry in contents.iter() {
525 ///             if entry.is_dir() {
526 ///                 try!(visit_dirs(entry, |p| cb(p)));
527 ///             } else {
528 ///                 cb(entry);
529 ///             }
530 ///         }
531 ///         Ok(())
532 ///     } else {
533 ///         Err(io::standard_error(io::InvalidInput))
534 ///     }
535 /// }
536 /// ```
537 ///
538 /// # Error
539 ///
540 /// This function will return an error if the provided `path` doesn't exist, if
541 /// the process lacks permissions to view the contents or if the `path` points
542 /// at a non-directory file
543 pub fn readdir(path: &Path) -> IoResult<Vec<Path>> {
544     fs_imp::readdir(path)
545            .update_err("couldn't read directory",
546                        |e| format!("{}; path={}", e, path.display()))
547 }
548
549 /// Returns an iterator that will recursively walk the directory structure
550 /// rooted at `path`. The path given will not be iterated over, and this will
551 /// perform iteration in some top-down order.  The contents of unreadable
552 /// subdirectories are ignored.
553 pub fn walk_dir(path: &Path) -> IoResult<Directories> {
554     Ok(Directories {
555         stack: try!(readdir(path).update_err("couldn't walk directory",
556                                              |e| format!("{}; path={}", e, path.display())))
557     })
558 }
559
560 /// An iterator that walks over a directory
561 #[deriving(Clone)]
562 pub struct Directories {
563     stack: Vec<Path>,
564 }
565
566 impl Iterator for Directories {
567     type Item = Path;
568
569     fn next(&mut self) -> Option<Path> {
570         match self.stack.pop() {
571             Some(path) => {
572                 if path.is_dir() {
573                     match readdir(&path) {
574                         Ok(dirs) => { self.stack.extend(dirs.into_iter()); }
575                         Err(..) => {}
576                     }
577                 }
578                 Some(path)
579             }
580             None => None
581         }
582     }
583 }
584
585 /// Recursively create a directory and all of its parent components if they
586 /// are missing.
587 ///
588 /// # Error
589 ///
590 /// See `fs::mkdir`.
591 pub fn mkdir_recursive(path: &Path, mode: FilePermission) -> IoResult<()> {
592     // tjc: if directory exists but with different permissions,
593     // should we return false?
594     if path.is_dir() {
595         return Ok(())
596     }
597
598     let mut comps = path.components();
599     let mut curpath = path.root_path().unwrap_or(Path::new("."));
600
601     for c in comps {
602         curpath.push(c);
603
604         let result = mkdir(&curpath, mode)
605             .update_err("couldn't recursively mkdir",
606                         |e| format!("{}; path={}", e, path.display()));
607
608         match result {
609             Err(mkdir_err) => {
610                 // already exists ?
611                 if try!(stat(&curpath)).kind != FileType::Directory {
612                     return Err(mkdir_err);
613                 }
614             }
615             Ok(()) => ()
616         }
617     }
618
619     Ok(())
620 }
621
622 /// Removes a directory at this path, after removing all its contents. Use
623 /// carefully!
624 ///
625 /// # Error
626 ///
627 /// See `file::unlink` and `fs::readdir`
628 pub fn rmdir_recursive(path: &Path) -> IoResult<()> {
629     let mut rm_stack = Vec::new();
630     rm_stack.push(path.clone());
631
632     fn rmdir_failed(err: &IoError, path: &Path) -> String {
633         format!("rmdir_recursive failed; path={}; cause={}",
634                 path.display(), err)
635     }
636
637     fn update_err<T>(err: IoResult<T>, path: &Path) -> IoResult<T> {
638         err.update_err("couldn't recursively rmdir",
639                        |e| rmdir_failed(e, path))
640     }
641
642     while !rm_stack.is_empty() {
643         let children = try!(readdir(rm_stack.last().unwrap())
644             .update_detail(|e| rmdir_failed(e, path)));
645
646         let mut has_child_dir = false;
647
648         // delete all regular files in the way and push subdirs
649         // on the stack
650         for child in children.into_iter() {
651             // FIXME(#12795) we should use lstat in all cases
652             let child_type = match cfg!(windows) {
653                 true => try!(update_err(stat(&child), path)),
654                 false => try!(update_err(lstat(&child), path))
655             };
656
657             if child_type.kind == FileType::Directory {
658                 rm_stack.push(child);
659                 has_child_dir = true;
660             } else {
661                 // we can carry on safely if the file is already gone
662                 // (eg: deleted by someone else since readdir)
663                 match update_err(unlink(&child), path) {
664                     Ok(()) => (),
665                     Err(ref e) if e.kind == io::FileNotFound => (),
666                     Err(e) => return Err(e)
667                 }
668             }
669         }
670
671         // if no subdir was found, let's pop and delete
672         if !has_child_dir {
673             let result = update_err(rmdir(&rm_stack.pop().unwrap()), path);
674             match result {
675                 Ok(()) => (),
676                 Err(ref e) if e.kind == io::FileNotFound => (),
677                 Err(e) => return Err(e)
678             }
679         }
680     }
681
682     Ok(())
683 }
684
685 /// Changes the timestamps for a file's last modification and access time.
686 /// The file at the path specified will have its last access time set to
687 /// `atime` and its modification time set to `mtime`. The times specified should
688 /// be in milliseconds.
689 // FIXME(#10301) these arguments should not be u64
690 pub fn change_file_times(path: &Path, atime: u64, mtime: u64) -> IoResult<()> {
691     fs_imp::utime(path, atime, mtime)
692            .update_err("couldn't change_file_times", |e|
693                format!("{}; path={}", e, path.display()))
694 }
695
696 impl Reader for File {
697     fn read(&mut self, buf: &mut [u8]) -> IoResult<uint> {
698         fn update_err<T>(result: IoResult<T>, file: &File) -> IoResult<T> {
699             result.update_err("couldn't read file",
700                               |e| format!("{}; path={}",
701                                           e, file.path.display()))
702         }
703
704         let result = update_err(self.fd.read(buf), self);
705
706         match result {
707             Ok(read) => {
708                 self.last_nread = read as int;
709                 match read {
710                     0 => update_err(Err(standard_error(io::EndOfFile)), self),
711                     _ => Ok(read as uint)
712                 }
713             },
714             Err(e) => Err(e)
715         }
716     }
717 }
718
719 impl Writer for File {
720     fn write(&mut self, buf: &[u8]) -> IoResult<()> {
721         self.fd.write(buf)
722             .update_err("couldn't write to file",
723                         |e| format!("{}; path={}", e, self.path.display()))
724     }
725 }
726
727 impl Seek for File {
728     fn tell(&self) -> IoResult<u64> {
729         self.fd.tell()
730             .update_err("couldn't retrieve file cursor (`tell`)",
731                         |e| format!("{}; path={}", e, self.path.display()))
732     }
733
734     fn seek(&mut self, pos: i64, style: SeekStyle) -> IoResult<()> {
735         let err = match self.fd.seek(pos, style) {
736             Ok(_) => {
737                 // successful seek resets EOF indicator
738                 self.last_nread = -1;
739                 Ok(())
740             }
741             Err(e) => Err(e),
742         };
743         err.update_err("couldn't seek in file",
744                        |e| format!("{}; path={}", e, self.path.display()))
745     }
746 }
747
748 /// Utility methods for paths.
749 pub trait PathExtensions {
750     /// Get information on the file, directory, etc at this path.
751     ///
752     /// Consult the `fs::stat` documentation for more info.
753     ///
754     /// This call preserves identical runtime/error semantics with `file::stat`.
755     fn stat(&self) -> IoResult<FileStat>;
756
757     /// Get information on the file, directory, etc at this path, not following
758     /// symlinks.
759     ///
760     /// Consult the `fs::lstat` documentation for more info.
761     ///
762     /// This call preserves identical runtime/error semantics with `file::lstat`.
763     fn lstat(&self) -> IoResult<FileStat>;
764
765     /// Boolean value indicator whether the underlying file exists on the local
766     /// filesystem. Returns false in exactly the cases where `fs::stat` fails.
767     fn exists(&self) -> bool;
768
769     /// Whether the underlying implementation (be it a file path, or something
770     /// else) points at a "regular file" on the FS. Will return false for paths
771     /// to non-existent locations or directories or other non-regular files
772     /// (named pipes, etc). Follows links when making this determination.
773     fn is_file(&self) -> bool;
774
775     /// Whether the underlying implementation (be it a file path, or something
776     /// else) is pointing at a directory in the underlying FS. Will return
777     /// false for paths to non-existent locations or if the item is not a
778     /// directory (eg files, named pipes, etc). Follows links when making this
779     /// determination.
780     fn is_dir(&self) -> bool;
781 }
782
783 impl PathExtensions for path::Path {
784     fn stat(&self) -> IoResult<FileStat> { stat(self) }
785     fn lstat(&self) -> IoResult<FileStat> { lstat(self) }
786     fn exists(&self) -> bool {
787         self.stat().is_ok()
788     }
789     fn is_file(&self) -> bool {
790         match self.stat() {
791             Ok(s) => s.kind == FileType::RegularFile,
792             Err(..) => false
793         }
794     }
795     fn is_dir(&self) -> bool {
796         match self.stat() {
797             Ok(s) => s.kind == FileType::Directory,
798             Err(..) => false
799         }
800     }
801 }
802
803 fn mode_string(mode: FileMode) -> &'static str {
804     match mode {
805         super::Open => "open",
806         super::Append => "append",
807         super::Truncate => "truncate"
808     }
809 }
810
811 fn access_string(access: FileAccess) -> &'static str {
812     match access {
813         super::Read => "read",
814         super::Write => "write",
815         super::ReadWrite => "readwrite"
816     }
817 }
818
819 #[cfg(test)]
820 #[allow(unused_imports)]
821 #[allow(unused_variables)]
822 #[allow(unused_mut)]
823 mod test {
824     use prelude::v1::*;
825     use io::{SeekSet, SeekCur, SeekEnd, Read, Open, ReadWrite, FileType};
826     use io;
827     use str;
828     use io::fs::*;
829
830     macro_rules! check { ($e:expr) => (
831         match $e {
832             Ok(t) => t,
833             Err(e) => panic!("{} failed with: {}", stringify!($e), e),
834         }
835     ) }
836
837     macro_rules! error { ($e:expr, $s:expr) => (
838         match $e {
839             Ok(_) => panic!("Unexpected success. Should've been: {}", $s),
840             Err(ref err) => assert!(err.to_string().contains($s.as_slice()),
841                                     format!("`{}` did not contain `{}`", err, $s))
842         }
843     ) }
844
845     pub struct TempDir(Path);
846
847     impl TempDir {
848         fn join(&self, path: &str) -> Path {
849             let TempDir(ref p) = *self;
850             p.join(path)
851         }
852
853         fn path<'a>(&'a self) -> &'a Path {
854             let TempDir(ref p) = *self;
855             p
856         }
857     }
858
859     impl Drop for TempDir {
860         fn drop(&mut self) {
861             // Gee, seeing how we're testing the fs module I sure hope that we
862             // at least implement this correctly!
863             let TempDir(ref p) = *self;
864             check!(io::fs::rmdir_recursive(p));
865         }
866     }
867
868     pub fn tmpdir() -> TempDir {
869         use os;
870         use rand;
871         let ret = os::tmpdir().join(format!("rust-{}", rand::random::<u32>()));
872         check!(io::fs::mkdir(&ret, io::USER_RWX));
873         TempDir(ret)
874     }
875
876     #[test]
877     fn file_test_io_smoke_test() {
878         let message = "it's alright. have a good time";
879         let tmpdir = tmpdir();
880         let filename = &tmpdir.join("file_rt_io_file_test.txt");
881         {
882             let mut write_stream = File::open_mode(filename, Open, ReadWrite);
883             check!(write_stream.write(message.as_bytes()));
884         }
885         {
886             let mut read_stream = File::open_mode(filename, Open, Read);
887             let mut read_buf = [0; 1028];
888             let read_str = match check!(read_stream.read(&mut read_buf)) {
889                 -1|0 => panic!("shouldn't happen"),
890                 n => str::from_utf8(read_buf[..n]).unwrap().to_string()
891             };
892             assert_eq!(read_str.as_slice(), message);
893         }
894         check!(unlink(filename));
895     }
896
897     #[test]
898     fn invalid_path_raises() {
899         let tmpdir = tmpdir();
900         let filename = &tmpdir.join("file_that_does_not_exist.txt");
901         let result = File::open_mode(filename, Open, Read);
902
903         error!(result, "couldn't open path as file");
904         if cfg!(unix) {
905             error!(result, "no such file or directory");
906         }
907         error!(result, format!("path={}; mode=open; access=read", filename.display()));
908     }
909
910     #[test]
911     fn file_test_iounlinking_invalid_path_should_raise_condition() {
912         let tmpdir = tmpdir();
913         let filename = &tmpdir.join("file_another_file_that_does_not_exist.txt");
914
915         let result = unlink(filename);
916
917         error!(result, "couldn't unlink path");
918         if cfg!(unix) {
919             error!(result, "no such file or directory");
920         }
921         error!(result, format!("path={}", filename.display()));
922     }
923
924     #[test]
925     fn file_test_io_non_positional_read() {
926         let message: &str = "ten-four";
927         let mut read_mem = [0; 8];
928         let tmpdir = tmpdir();
929         let filename = &tmpdir.join("file_rt_io_file_test_positional.txt");
930         {
931             let mut rw_stream = File::open_mode(filename, Open, ReadWrite);
932             check!(rw_stream.write(message.as_bytes()));
933         }
934         {
935             let mut read_stream = File::open_mode(filename, Open, Read);
936             {
937                 let read_buf = read_mem.slice_mut(0, 4);
938                 check!(read_stream.read(read_buf));
939             }
940             {
941                 let read_buf = read_mem.slice_mut(4, 8);
942                 check!(read_stream.read(read_buf));
943             }
944         }
945         check!(unlink(filename));
946         let read_str = str::from_utf8(&read_mem).unwrap();
947         assert_eq!(read_str, message);
948     }
949
950     #[test]
951     fn file_test_io_seek_and_tell_smoke_test() {
952         let message = "ten-four";
953         let mut read_mem = [0; 4];
954         let set_cursor = 4 as u64;
955         let mut tell_pos_pre_read;
956         let mut tell_pos_post_read;
957         let tmpdir = tmpdir();
958         let filename = &tmpdir.join("file_rt_io_file_test_seeking.txt");
959         {
960             let mut rw_stream = File::open_mode(filename, Open, ReadWrite);
961             check!(rw_stream.write(message.as_bytes()));
962         }
963         {
964             let mut read_stream = File::open_mode(filename, Open, Read);
965             check!(read_stream.seek(set_cursor as i64, SeekSet));
966             tell_pos_pre_read = check!(read_stream.tell());
967             check!(read_stream.read(&mut read_mem));
968             tell_pos_post_read = check!(read_stream.tell());
969         }
970         check!(unlink(filename));
971         let read_str = str::from_utf8(&read_mem).unwrap();
972         assert_eq!(read_str, message.slice(4, 8));
973         assert_eq!(tell_pos_pre_read, set_cursor);
974         assert_eq!(tell_pos_post_read, message.len() as u64);
975     }
976
977     #[test]
978     fn file_test_io_seek_and_write() {
979         let initial_msg =   "food-is-yummy";
980         let overwrite_msg =    "-the-bar!!";
981         let final_msg =     "foo-the-bar!!";
982         let seek_idx = 3i;
983         let mut read_mem = [0; 13];
984         let tmpdir = tmpdir();
985         let filename = &tmpdir.join("file_rt_io_file_test_seek_and_write.txt");
986         {
987             let mut rw_stream = File::open_mode(filename, Open, ReadWrite);
988             check!(rw_stream.write(initial_msg.as_bytes()));
989             check!(rw_stream.seek(seek_idx as i64, SeekSet));
990             check!(rw_stream.write(overwrite_msg.as_bytes()));
991         }
992         {
993             let mut read_stream = File::open_mode(filename, Open, Read);
994             check!(read_stream.read(&mut read_mem));
995         }
996         check!(unlink(filename));
997         let read_str = str::from_utf8(&read_mem).unwrap();
998         assert!(read_str == final_msg);
999     }
1000
1001     #[test]
1002     fn file_test_io_seek_shakedown() {
1003         use str;          // 01234567890123
1004         let initial_msg =   "qwer-asdf-zxcv";
1005         let chunk_one: &str = "qwer";
1006         let chunk_two: &str = "asdf";
1007         let chunk_three: &str = "zxcv";
1008         let mut read_mem = [0; 4];
1009         let tmpdir = tmpdir();
1010         let filename = &tmpdir.join("file_rt_io_file_test_seek_shakedown.txt");
1011         {
1012             let mut rw_stream = File::open_mode(filename, Open, ReadWrite);
1013             check!(rw_stream.write(initial_msg.as_bytes()));
1014         }
1015         {
1016             let mut read_stream = File::open_mode(filename, Open, Read);
1017
1018             check!(read_stream.seek(-4, SeekEnd));
1019             check!(read_stream.read(&mut read_mem));
1020             assert_eq!(str::from_utf8(&read_mem).unwrap(), chunk_three);
1021
1022             check!(read_stream.seek(-9, SeekCur));
1023             check!(read_stream.read(&mut read_mem));
1024             assert_eq!(str::from_utf8(&read_mem).unwrap(), chunk_two);
1025
1026             check!(read_stream.seek(0, SeekSet));
1027             check!(read_stream.read(&mut read_mem));
1028             assert_eq!(str::from_utf8(&read_mem).unwrap(), chunk_one);
1029         }
1030         check!(unlink(filename));
1031     }
1032
1033     #[test]
1034     fn file_test_stat_is_correct_on_is_file() {
1035         let tmpdir = tmpdir();
1036         let filename = &tmpdir.join("file_stat_correct_on_is_file.txt");
1037         {
1038             let mut fs = check!(File::open_mode(filename, Open, ReadWrite));
1039             let msg = "hw";
1040             fs.write(msg.as_bytes()).unwrap();
1041
1042             let fstat_res = check!(fs.stat());
1043             assert_eq!(fstat_res.kind, FileType::RegularFile);
1044         }
1045         let stat_res_fn = check!(stat(filename));
1046         assert_eq!(stat_res_fn.kind, FileType::RegularFile);
1047         let stat_res_meth = check!(filename.stat());
1048         assert_eq!(stat_res_meth.kind, FileType::RegularFile);
1049         check!(unlink(filename));
1050     }
1051
1052     #[test]
1053     fn file_test_stat_is_correct_on_is_dir() {
1054         let tmpdir = tmpdir();
1055         let filename = &tmpdir.join("file_stat_correct_on_is_dir");
1056         check!(mkdir(filename, io::USER_RWX));
1057         let stat_res_fn = check!(stat(filename));
1058         assert!(stat_res_fn.kind == FileType::Directory);
1059         let stat_res_meth = check!(filename.stat());
1060         assert!(stat_res_meth.kind == FileType::Directory);
1061         check!(rmdir(filename));
1062     }
1063
1064     #[test]
1065     fn file_test_fileinfo_false_when_checking_is_file_on_a_directory() {
1066         let tmpdir = tmpdir();
1067         let dir = &tmpdir.join("fileinfo_false_on_dir");
1068         check!(mkdir(dir, io::USER_RWX));
1069         assert!(dir.is_file() == false);
1070         check!(rmdir(dir));
1071     }
1072
1073     #[test]
1074     fn file_test_fileinfo_check_exists_before_and_after_file_creation() {
1075         let tmpdir = tmpdir();
1076         let file = &tmpdir.join("fileinfo_check_exists_b_and_a.txt");
1077         check!(File::create(file).write(b"foo"));
1078         assert!(file.exists());
1079         check!(unlink(file));
1080         assert!(!file.exists());
1081     }
1082
1083     #[test]
1084     fn file_test_directoryinfo_check_exists_before_and_after_mkdir() {
1085         let tmpdir = tmpdir();
1086         let dir = &tmpdir.join("before_and_after_dir");
1087         assert!(!dir.exists());
1088         check!(mkdir(dir, io::USER_RWX));
1089         assert!(dir.exists());
1090         assert!(dir.is_dir());
1091         check!(rmdir(dir));
1092         assert!(!dir.exists());
1093     }
1094
1095     #[test]
1096     fn file_test_directoryinfo_readdir() {
1097         use str;
1098         let tmpdir = tmpdir();
1099         let dir = &tmpdir.join("di_readdir");
1100         check!(mkdir(dir, io::USER_RWX));
1101         let prefix = "foo";
1102         for n in range(0i,3) {
1103             let f = dir.join(format!("{}.txt", n));
1104             let mut w = check!(File::create(&f));
1105             let msg_str = format!("{}{}", prefix, n.to_string());
1106             let msg = msg_str.as_bytes();
1107             check!(w.write(msg));
1108         }
1109         let files = check!(readdir(dir));
1110         let mut mem = [0u8; 4];
1111         for f in files.iter() {
1112             {
1113                 let n = f.filestem_str();
1114                 check!(File::open(f).read(&mut mem));
1115                 let read_str = str::from_utf8(&mem).unwrap();
1116                 let expected = match n {
1117                     None|Some("") => panic!("really shouldn't happen.."),
1118                     Some(n) => format!("{}{}", prefix, n),
1119                 };
1120                 assert_eq!(expected.as_slice(), read_str);
1121             }
1122             check!(unlink(f));
1123         }
1124         check!(rmdir(dir));
1125     }
1126
1127     #[test]
1128     fn file_test_walk_dir() {
1129         let tmpdir = tmpdir();
1130         let dir = &tmpdir.join("walk_dir");
1131         check!(mkdir(dir, io::USER_RWX));
1132
1133         let dir1 = &dir.join("01/02/03");
1134         check!(mkdir_recursive(dir1, io::USER_RWX));
1135         check!(File::create(&dir1.join("04")));
1136
1137         let dir2 = &dir.join("11/12/13");
1138         check!(mkdir_recursive(dir2, io::USER_RWX));
1139         check!(File::create(&dir2.join("14")));
1140
1141         let mut files = check!(walk_dir(dir));
1142         let mut cur = [0u8; 2];
1143         for f in files {
1144             let stem = f.filestem_str().unwrap();
1145             let root = stem.as_bytes()[0] - b'0';
1146             let name = stem.as_bytes()[1] - b'0';
1147             assert!(cur[root as uint] < name);
1148             cur[root as uint] = name;
1149         }
1150
1151         check!(rmdir_recursive(dir));
1152     }
1153
1154     #[test]
1155     fn mkdir_path_already_exists_error() {
1156         use io::{IoError, PathAlreadyExists};
1157
1158         let tmpdir = tmpdir();
1159         let dir = &tmpdir.join("mkdir_error_twice");
1160         check!(mkdir(dir, io::USER_RWX));
1161         match mkdir(dir, io::USER_RWX) {
1162             Err(IoError{kind:PathAlreadyExists,..}) => (),
1163             _ => assert!(false)
1164         };
1165     }
1166
1167     #[test]
1168     fn recursive_mkdir() {
1169         let tmpdir = tmpdir();
1170         let dir = tmpdir.join("d1/d2");
1171         check!(mkdir_recursive(&dir, io::USER_RWX));
1172         assert!(dir.is_dir())
1173     }
1174
1175     #[test]
1176     fn recursive_mkdir_failure() {
1177         let tmpdir = tmpdir();
1178         let dir = tmpdir.join("d1");
1179         let file = dir.join("f1");
1180
1181         check!(mkdir_recursive(&dir, io::USER_RWX));
1182         check!(File::create(&file));
1183
1184         let result = mkdir_recursive(&file, io::USER_RWX);
1185
1186         error!(result, "couldn't recursively mkdir");
1187         error!(result, "couldn't create directory");
1188         error!(result, "mode=0700");
1189         error!(result, format!("path={}", file.display()));
1190     }
1191
1192     #[test]
1193     fn recursive_mkdir_slash() {
1194         check!(mkdir_recursive(&Path::new("/"), io::USER_RWX));
1195     }
1196
1197     // FIXME(#12795) depends on lstat to work on windows
1198     #[cfg(not(windows))]
1199     #[test]
1200     fn recursive_rmdir() {
1201         let tmpdir = tmpdir();
1202         let d1 = tmpdir.join("d1");
1203         let dt = d1.join("t");
1204         let dtt = dt.join("t");
1205         let d2 = tmpdir.join("d2");
1206         let canary = d2.join("do_not_delete");
1207         check!(mkdir_recursive(&dtt, io::USER_RWX));
1208         check!(mkdir_recursive(&d2, io::USER_RWX));
1209         check!(File::create(&canary).write(b"foo"));
1210         check!(symlink(&d2, &dt.join("d2")));
1211         check!(rmdir_recursive(&d1));
1212
1213         assert!(!d1.is_dir());
1214         assert!(canary.exists());
1215     }
1216
1217     #[test]
1218     fn unicode_path_is_dir() {
1219         assert!(Path::new(".").is_dir());
1220         assert!(!Path::new("test/stdtest/fs.rs").is_dir());
1221
1222         let tmpdir = tmpdir();
1223
1224         let mut dirpath = tmpdir.path().clone();
1225         dirpath.push(format!("test-가一ー你好"));
1226         check!(mkdir(&dirpath, io::USER_RWX));
1227         assert!(dirpath.is_dir());
1228
1229         let mut filepath = dirpath;
1230         filepath.push("unicode-file-\u{ac00}\u{4e00}\u{30fc}\u{4f60}\u{597d}.rs");
1231         check!(File::create(&filepath)); // ignore return; touch only
1232         assert!(!filepath.is_dir());
1233         assert!(filepath.exists());
1234     }
1235
1236     #[test]
1237     fn unicode_path_exists() {
1238         assert!(Path::new(".").exists());
1239         assert!(!Path::new("test/nonexistent-bogus-path").exists());
1240
1241         let tmpdir = tmpdir();
1242         let unicode = tmpdir.path();
1243         let unicode = unicode.join(format!("test-각丁ー再见"));
1244         check!(mkdir(&unicode, io::USER_RWX));
1245         assert!(unicode.exists());
1246         assert!(!Path::new("test/unicode-bogus-path-각丁ー再见").exists());
1247     }
1248
1249     #[test]
1250     fn copy_file_does_not_exist() {
1251         let from = Path::new("test/nonexistent-bogus-path");
1252         let to = Path::new("test/other-bogus-path");
1253
1254         error!(copy(&from, &to),
1255             format!("couldn't copy path (the source path is not an \
1256                     existing file; from={}; to={})",
1257                     from.display(), to.display()));
1258
1259         match copy(&from, &to) {
1260             Ok(..) => panic!(),
1261             Err(..) => {
1262                 assert!(!from.exists());
1263                 assert!(!to.exists());
1264             }
1265         }
1266     }
1267
1268     #[test]
1269     fn copy_file_ok() {
1270         let tmpdir = tmpdir();
1271         let input = tmpdir.join("in.txt");
1272         let out = tmpdir.join("out.txt");
1273
1274         check!(File::create(&input).write(b"hello"));
1275         check!(copy(&input, &out));
1276         let contents = check!(File::open(&out).read_to_end());
1277         assert_eq!(contents.as_slice(), b"hello");
1278
1279         assert_eq!(check!(input.stat()).perm, check!(out.stat()).perm);
1280     }
1281
1282     #[test]
1283     fn copy_file_dst_dir() {
1284         let tmpdir = tmpdir();
1285         let out = tmpdir.join("out");
1286
1287         check!(File::create(&out));
1288         match copy(&out, tmpdir.path()) {
1289             Ok(..) => panic!(), Err(..) => {}
1290         }
1291     }
1292
1293     #[test]
1294     fn copy_file_dst_exists() {
1295         let tmpdir = tmpdir();
1296         let input = tmpdir.join("in");
1297         let output = tmpdir.join("out");
1298
1299         check!(File::create(&input).write("foo".as_bytes()));
1300         check!(File::create(&output).write("bar".as_bytes()));
1301         check!(copy(&input, &output));
1302
1303         assert_eq!(check!(File::open(&output).read_to_end()),
1304                    b"foo".to_vec());
1305     }
1306
1307     #[test]
1308     fn copy_file_src_dir() {
1309         let tmpdir = tmpdir();
1310         let out = tmpdir.join("out");
1311
1312         match copy(tmpdir.path(), &out) {
1313             Ok(..) => panic!(), Err(..) => {}
1314         }
1315         assert!(!out.exists());
1316     }
1317
1318     #[test]
1319     fn copy_file_preserves_perm_bits() {
1320         let tmpdir = tmpdir();
1321         let input = tmpdir.join("in.txt");
1322         let out = tmpdir.join("out.txt");
1323
1324         check!(File::create(&input));
1325         check!(chmod(&input, io::USER_READ));
1326         check!(copy(&input, &out));
1327         assert!(!check!(out.stat()).perm.intersects(io::USER_WRITE));
1328
1329         check!(chmod(&input, io::USER_FILE));
1330         check!(chmod(&out, io::USER_FILE));
1331     }
1332
1333     #[cfg(not(windows))] // FIXME(#10264) operation not permitted?
1334     #[test]
1335     fn symlinks_work() {
1336         let tmpdir = tmpdir();
1337         let input = tmpdir.join("in.txt");
1338         let out = tmpdir.join("out.txt");
1339
1340         check!(File::create(&input).write("foobar".as_bytes()));
1341         check!(symlink(&input, &out));
1342         if cfg!(not(windows)) {
1343             assert_eq!(check!(lstat(&out)).kind, FileType::Symlink);
1344             assert_eq!(check!(out.lstat()).kind, FileType::Symlink);
1345         }
1346         assert_eq!(check!(stat(&out)).size, check!(stat(&input)).size);
1347         assert_eq!(check!(File::open(&out).read_to_end()),
1348                    b"foobar".to_vec());
1349     }
1350
1351     #[cfg(not(windows))] // apparently windows doesn't like symlinks
1352     #[test]
1353     fn symlink_noexist() {
1354         let tmpdir = tmpdir();
1355         // symlinks can point to things that don't exist
1356         check!(symlink(&tmpdir.join("foo"), &tmpdir.join("bar")));
1357         assert!(check!(readlink(&tmpdir.join("bar"))) == tmpdir.join("foo"));
1358     }
1359
1360     #[test]
1361     fn readlink_not_symlink() {
1362         let tmpdir = tmpdir();
1363         match readlink(tmpdir.path()) {
1364             Ok(..) => panic!("wanted a failure"),
1365             Err(..) => {}
1366         }
1367     }
1368
1369     #[test]
1370     fn links_work() {
1371         let tmpdir = tmpdir();
1372         let input = tmpdir.join("in.txt");
1373         let out = tmpdir.join("out.txt");
1374
1375         check!(File::create(&input).write("foobar".as_bytes()));
1376         check!(link(&input, &out));
1377         if cfg!(not(windows)) {
1378             assert_eq!(check!(lstat(&out)).kind, FileType::RegularFile);
1379             assert_eq!(check!(out.lstat()).kind, FileType::RegularFile);
1380             assert_eq!(check!(stat(&out)).unstable.nlink, 2);
1381             assert_eq!(check!(out.stat()).unstable.nlink, 2);
1382         }
1383         assert_eq!(check!(stat(&out)).size, check!(stat(&input)).size);
1384         assert_eq!(check!(stat(&out)).size, check!(input.stat()).size);
1385         assert_eq!(check!(File::open(&out).read_to_end()),
1386                    b"foobar".to_vec());
1387
1388         // can't link to yourself
1389         match link(&input, &input) {
1390             Ok(..) => panic!("wanted a failure"),
1391             Err(..) => {}
1392         }
1393         // can't link to something that doesn't exist
1394         match link(&tmpdir.join("foo"), &tmpdir.join("bar")) {
1395             Ok(..) => panic!("wanted a failure"),
1396             Err(..) => {}
1397         }
1398     }
1399
1400     #[test]
1401     fn chmod_works() {
1402         let tmpdir = tmpdir();
1403         let file = tmpdir.join("in.txt");
1404
1405         check!(File::create(&file));
1406         assert!(check!(stat(&file)).perm.contains(io::USER_WRITE));
1407         check!(chmod(&file, io::USER_READ));
1408         assert!(!check!(stat(&file)).perm.contains(io::USER_WRITE));
1409
1410         match chmod(&tmpdir.join("foo"), io::USER_RWX) {
1411             Ok(..) => panic!("wanted a panic"),
1412             Err(..) => {}
1413         }
1414
1415         check!(chmod(&file, io::USER_FILE));
1416     }
1417
1418     #[test]
1419     fn sync_doesnt_kill_anything() {
1420         let tmpdir = tmpdir();
1421         let path = tmpdir.join("in.txt");
1422
1423         let mut file = check!(File::open_mode(&path, io::Open, io::ReadWrite));
1424         check!(file.fsync());
1425         check!(file.datasync());
1426         check!(file.write(b"foo"));
1427         check!(file.fsync());
1428         check!(file.datasync());
1429         drop(file);
1430     }
1431
1432     #[test]
1433     fn truncate_works() {
1434         let tmpdir = tmpdir();
1435         let path = tmpdir.join("in.txt");
1436
1437         let mut file = check!(File::open_mode(&path, io::Open, io::ReadWrite));
1438         check!(file.write(b"foo"));
1439         check!(file.fsync());
1440
1441         // Do some simple things with truncation
1442         assert_eq!(check!(file.stat()).size, 3);
1443         check!(file.truncate(10));
1444         assert_eq!(check!(file.stat()).size, 10);
1445         check!(file.write(b"bar"));
1446         check!(file.fsync());
1447         assert_eq!(check!(file.stat()).size, 10);
1448         assert_eq!(check!(File::open(&path).read_to_end()),
1449                    b"foobar\0\0\0\0".to_vec());
1450
1451         // Truncate to a smaller length, don't seek, and then write something.
1452         // Ensure that the intermediate zeroes are all filled in (we're seeked
1453         // past the end of the file).
1454         check!(file.truncate(2));
1455         assert_eq!(check!(file.stat()).size, 2);
1456         check!(file.write(b"wut"));
1457         check!(file.fsync());
1458         assert_eq!(check!(file.stat()).size, 9);
1459         assert_eq!(check!(File::open(&path).read_to_end()),
1460                    b"fo\0\0\0\0wut".to_vec());
1461         drop(file);
1462     }
1463
1464     #[test]
1465     fn open_flavors() {
1466         let tmpdir = tmpdir();
1467
1468         match File::open_mode(&tmpdir.join("a"), io::Open, io::Read) {
1469             Ok(..) => panic!(), Err(..) => {}
1470         }
1471
1472         // Perform each one twice to make sure that it succeeds the second time
1473         // (where the file exists)
1474         check!(File::open_mode(&tmpdir.join("b"), io::Open, io::Write));
1475         assert!(tmpdir.join("b").exists());
1476         check!(File::open_mode(&tmpdir.join("b"), io::Open, io::Write));
1477
1478         check!(File::open_mode(&tmpdir.join("c"), io::Open, io::ReadWrite));
1479         assert!(tmpdir.join("c").exists());
1480         check!(File::open_mode(&tmpdir.join("c"), io::Open, io::ReadWrite));
1481
1482         check!(File::open_mode(&tmpdir.join("d"), io::Append, io::Write));
1483         assert!(tmpdir.join("d").exists());
1484         check!(File::open_mode(&tmpdir.join("d"), io::Append, io::Write));
1485
1486         check!(File::open_mode(&tmpdir.join("e"), io::Append, io::ReadWrite));
1487         assert!(tmpdir.join("e").exists());
1488         check!(File::open_mode(&tmpdir.join("e"), io::Append, io::ReadWrite));
1489
1490         check!(File::open_mode(&tmpdir.join("f"), io::Truncate, io::Write));
1491         assert!(tmpdir.join("f").exists());
1492         check!(File::open_mode(&tmpdir.join("f"), io::Truncate, io::Write));
1493
1494         check!(File::open_mode(&tmpdir.join("g"), io::Truncate, io::ReadWrite));
1495         assert!(tmpdir.join("g").exists());
1496         check!(File::open_mode(&tmpdir.join("g"), io::Truncate, io::ReadWrite));
1497
1498         check!(File::create(&tmpdir.join("h")).write("foo".as_bytes()));
1499         check!(File::open_mode(&tmpdir.join("h"), io::Open, io::Read));
1500         {
1501             let mut f = check!(File::open_mode(&tmpdir.join("h"), io::Open,
1502                                                io::Read));
1503             match f.write("wut".as_bytes()) {
1504                 Ok(..) => panic!(), Err(..) => {}
1505             }
1506         }
1507         assert!(check!(stat(&tmpdir.join("h"))).size == 3,
1508                 "write/stat failed");
1509         {
1510             let mut f = check!(File::open_mode(&tmpdir.join("h"), io::Append,
1511                                                io::Write));
1512             check!(f.write("bar".as_bytes()));
1513         }
1514         assert!(check!(stat(&tmpdir.join("h"))).size == 6,
1515                 "append didn't append");
1516         {
1517             let mut f = check!(File::open_mode(&tmpdir.join("h"), io::Truncate,
1518                                                io::Write));
1519             check!(f.write("bar".as_bytes()));
1520         }
1521         assert!(check!(stat(&tmpdir.join("h"))).size == 3,
1522                 "truncate didn't truncate");
1523     }
1524
1525     #[test]
1526     fn utime() {
1527         let tmpdir = tmpdir();
1528         let path = tmpdir.join("a");
1529         check!(File::create(&path));
1530         // These numbers have to be bigger than the time in the day to account for timezones
1531         // Windows in particular will fail in certain timezones with small enough values
1532         check!(change_file_times(&path, 100000, 200000));
1533         assert_eq!(check!(path.stat()).accessed, 100000);
1534         assert_eq!(check!(path.stat()).modified, 200000);
1535     }
1536
1537     #[test]
1538     fn utime_noexist() {
1539         let tmpdir = tmpdir();
1540
1541         match change_file_times(&tmpdir.join("a"), 100, 200) {
1542             Ok(..) => panic!(),
1543             Err(..) => {}
1544         }
1545     }
1546
1547     #[test]
1548     fn binary_file() {
1549         use rand::{StdRng, Rng};
1550
1551         let mut bytes = [0; 1024];
1552         StdRng::new().ok().unwrap().fill_bytes(&mut bytes);
1553
1554         let tmpdir = tmpdir();
1555
1556         check!(File::create(&tmpdir.join("test")).write(&bytes));
1557         let actual = check!(File::open(&tmpdir.join("test")).read_to_end());
1558         assert!(actual == bytes.as_slice());
1559     }
1560
1561     #[test]
1562     fn unlink_readonly() {
1563         let tmpdir = tmpdir();
1564         let path = tmpdir.join("file");
1565         check!(File::create(&path));
1566         check!(chmod(&path, io::USER_READ));
1567         check!(unlink(&path));
1568     }
1569 }