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.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 // ignore-lexer-test FIXME #15679
13 //! Synchronous File I/O
15 //! This module provides a set of functions and traits for working
16 //! with regular files & directories on a filesystem.
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.
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.
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.
33 //! # #![allow(unused_must_use)]
34 //! use std::io::fs::PathExtensions;
35 //! use std::io::{File, fs};
37 //! let path = Path::new("foo.txt");
39 //! // create the file, whether it exists or not
40 //! let mut file = File::create(&path);
41 //! file.write(b"foobar");
44 //! // open the file in read-only mode
45 //! let mut file = File::open(&path);
46 //! file.read_to_end();
48 //! println!("{}", path.stat().unwrap().size);
50 //! fs::unlink(&path);
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;
61 use iter::{Iterator, Extend};
63 use option::Option::{Some, None};
64 use path::{Path, GenericPath};
66 use result::Result::{Err, Ok};
71 use sys::fs as fs_imp;
74 /// Unconstrained file access type that exposes read and write operations
76 /// Can be constructed via `File::open()`, `File::create()`, and
77 /// `File::open_mode()`.
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()`.
91 impl sys_common::AsInner<fs_imp::FileDesc> for File {
92 fn as_inner(&self) -> &fs_imp::FileDesc {
98 /// Open a file at `path` in the mode specified by the `mode` and `access`
103 /// ```rust,should_fail
104 /// use std::io::{File, Open, ReadWrite};
106 /// let p = Path::new("/some/file/path.txt");
108 /// let file = match File::open_mode(&p, Open, ReadWrite) {
110 /// Err(e) => panic!("file error: {}", e),
112 /// // do some stuff with that file
114 /// // the file will be closed at the end of this block
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
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).
129 /// This function will return an error under a number of different
130 /// circumstances, to include but not limited to:
132 /// * Opening a file that does not exist with `Read` access.
133 /// * Attempting to open a file with a `FileAccess` that the user lacks
135 /// * Filesystem-level errors (full disk, etc)
136 pub fn open_mode(path: &Path,
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 {
148 desc: "is a directory",
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))
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.
168 /// For more information, see the `File::open_mode` function.
173 /// use std::io::File;
175 /// let contents = File::open(&Path::new("foo.txt")).read_to_end();
177 pub fn open(path: &Path) -> IoResult<File> {
178 File::open_mode(path, Open, Read)
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.
185 /// For more information, see the `File::open_mode` function.
190 /// # #![allow(unused_must_use)]
191 /// use std::io::File;
193 /// let mut f = File::create(&Path::new("foo.txt"));
194 /// f.write(b"This is a sample file");
196 /// # ::std::io::fs::unlink(&Path::new("foo.txt"));
198 pub fn create(path: &Path) -> IoResult<File> {
199 File::open_mode(path, Truncate, Write)
200 .update_desc("couldn't create file")
203 /// Returns the original path that was used to open this file.
204 pub fn path<'a>(&'a self) -> &'a Path {
208 /// Synchronizes all modifications to this file to its permanent storage
209 /// device. This will flush any internal buffers necessary to perform this
211 pub fn fsync(&mut self) -> IoResult<()> {
213 .update_err("couldn't fsync file",
214 |e| format!("{}; path={}", e, self.path.display()))
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<()> {
223 .update_err("couldn't datasync file",
224 |e| format!("{}; path={}", e, self.path.display()))
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`
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
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))
241 /// Returns true if the stream has reached the end of the file.
243 /// If true, then this file will no longer continue to return data via
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 {
254 /// Queries information about the underlying file.
255 pub fn stat(&self) -> IoResult<FileStat> {
257 .update_err("couldn't fstat file", |e|
258 format!("{}; path={}", e, self.path.display()))
262 /// Unlink a file from the underlying filesystem.
267 /// # #![allow(unused_must_use)]
270 /// let p = Path::new("/some/file/path.txt");
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)
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
283 pub fn unlink(path: &Path) -> IoResult<()> {
285 .update_err("couldn't unlink path", |e|
286 format!("{}; path={}", e, path.display()))
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.
298 /// let p = Path::new("/some/file/path.txt");
299 /// match fs::stat(&p) {
300 /// Ok(stat) => { /* ... */ }
301 /// Err(e) => { /* handle error */ }
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> {
312 .update_err("couldn't stat path", |e|
313 format!("{}; path={}", e, path.display()))
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
324 pub fn lstat(path: &Path) -> IoResult<FileStat> {
326 .update_err("couldn't lstat path", |e|
327 format!("{}; path={}", e, path.display()))
330 /// Rename a file or directory to a new name.
335 /// # #![allow(unused_must_use)]
338 /// fs::rename(&Path::new("foo"), &Path::new("bar"));
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()))
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.
355 /// Note that if `from` and `to` both point to the same file, then the file
356 /// will likely get truncated by this operation.
361 /// # #![allow(unused_must_use)]
364 /// fs::copy(&Path::new("foo.txt"), &Path::new("bar.txt"));
369 /// This function will return an error in the following situations, but is not
370 /// limited to just these cases:
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`
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())
388 return update_err(Err(IoError {
389 kind: io::MismatchedFileTypeForOperation,
390 desc: "the source path is not an existing file",
395 let mut reader = try!(File::open(from));
396 let mut writer = try!(File::create(to));
398 try!(update_err(super::util::copy(&mut reader, &mut writer), from, to));
400 chmod(to, try!(update_err(from.stat(), from, to)).perm)
403 /// Changes the permission mode bits found on a file or a directory. This
404 /// function takes a mask from the `io` module
409 /// # #![allow(unused_must_use)]
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);
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))
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))
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()))
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()))
454 /// Reads a symlink, returning the file that the symlink points to.
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()))
466 /// Create a new, empty directory at the provided path
471 /// # #![allow(unused_must_use)]
475 /// let p = Path::new("/some/dir");
476 /// fs::mkdir(&p, io::USER_RWX);
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))
489 /// Remove an existing, empty directory
494 /// # #![allow(unused_must_use)]
497 /// let p = Path::new("/some/dir");
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<()> {
507 .update_err("couldn't remove directory", |e|
508 format!("{}; path={}", e, path.display()))
511 /// Retrieve a vector containing all entries within a provided directory
516 /// use std::io::fs::PathExtensions;
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)));
533 /// Err(io::standard_error(io::InvalidInput))
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()))
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> {
555 stack: try!(readdir(path).update_err("couldn't walk directory",
556 |e| format!("{}; path={}", e, path.display())))
560 /// An iterator that walks over a directory
562 pub struct Directories {
566 impl Iterator<Path> for Directories {
567 fn next(&mut self) -> Option<Path> {
568 match self.stack.pop() {
571 match readdir(&path) {
572 Ok(dirs) => { self.stack.extend(dirs.into_iter()); }
583 /// Recursively create a directory and all of its parent components if they
589 pub fn mkdir_recursive(path: &Path, mode: FilePermission) -> IoResult<()> {
590 // tjc: if directory exists but with different permissions,
591 // should we return false?
596 let mut comps = path.components();
597 let mut curpath = path.root_path().unwrap_or(Path::new("."));
602 let result = mkdir(&curpath, mode)
603 .update_err("couldn't recursively mkdir",
604 |e| format!("{}; path={}", e, path.display()));
609 if try!(stat(&curpath)).kind != FileType::Directory {
610 return Err(mkdir_err);
620 /// Removes a directory at this path, after removing all its contents. Use
625 /// See `file::unlink` and `fs::readdir`
626 pub fn rmdir_recursive(path: &Path) -> IoResult<()> {
627 let mut rm_stack = Vec::new();
628 rm_stack.push(path.clone());
630 fn rmdir_failed(err: &IoError, path: &Path) -> String {
631 format!("rmdir_recursive failed; path={}; cause={}",
635 fn update_err<T>(err: IoResult<T>, path: &Path) -> IoResult<T> {
636 err.update_err("couldn't recursively rmdir",
637 |e| rmdir_failed(e, path))
640 while !rm_stack.is_empty() {
641 let children = try!(readdir(rm_stack.last().unwrap())
642 .update_detail(|e| rmdir_failed(e, path)));
644 let mut has_child_dir = false;
646 // delete all regular files in the way and push subdirs
648 for child in children.into_iter() {
649 // FIXME(#12795) we should use lstat in all cases
650 let child_type = match cfg!(windows) {
651 true => try!(update_err(stat(&child), path)),
652 false => try!(update_err(lstat(&child), path))
655 if child_type.kind == FileType::Directory {
656 rm_stack.push(child);
657 has_child_dir = true;
659 // we can carry on safely if the file is already gone
660 // (eg: deleted by someone else since readdir)
661 match update_err(unlink(&child), path) {
663 Err(ref e) if e.kind == io::FileNotFound => (),
664 Err(e) => return Err(e)
669 // if no subdir was found, let's pop and delete
671 let result = update_err(rmdir(&rm_stack.pop().unwrap()), path);
674 Err(ref e) if e.kind == io::FileNotFound => (),
675 Err(e) => return Err(e)
683 /// Changes the timestamps for a file's last modification and access time.
684 /// The file at the path specified will have its last access time set to
685 /// `atime` and its modification time set to `mtime`. The times specified should
686 /// be in milliseconds.
687 // FIXME(#10301) these arguments should not be u64
688 pub fn change_file_times(path: &Path, atime: u64, mtime: u64) -> IoResult<()> {
689 fs_imp::utime(path, atime, mtime)
690 .update_err("couldn't change_file_times", |e|
691 format!("{}; path={}", e, path.display()))
694 impl Reader for File {
695 fn read(&mut self, buf: &mut [u8]) -> IoResult<uint> {
696 fn update_err<T>(result: IoResult<T>, file: &File) -> IoResult<T> {
697 result.update_err("couldn't read file",
698 |e| format!("{}; path={}",
699 e, file.path.display()))
702 let result = update_err(self.fd.read(buf), self);
706 self.last_nread = read as int;
708 0 => update_err(Err(standard_error(io::EndOfFile)), self),
709 _ => Ok(read as uint)
717 impl Writer for File {
718 fn write(&mut self, buf: &[u8]) -> IoResult<()> {
720 .update_err("couldn't write to file",
721 |e| format!("{}; path={}", e, self.path.display()))
726 fn tell(&self) -> IoResult<u64> {
728 .update_err("couldn't retrieve file cursor (`tell`)",
729 |e| format!("{}; path={}", e, self.path.display()))
732 fn seek(&mut self, pos: i64, style: SeekStyle) -> IoResult<()> {
733 let err = match self.fd.seek(pos, style) {
735 // successful seek resets EOF indicator
736 self.last_nread = -1;
741 err.update_err("couldn't seek in file",
742 |e| format!("{}; path={}", e, self.path.display()))
746 /// Utility methods for paths.
747 pub trait PathExtensions {
748 /// Get information on the file, directory, etc at this path.
750 /// Consult the `fs::stat` documentation for more info.
752 /// This call preserves identical runtime/error semantics with `file::stat`.
753 fn stat(&self) -> IoResult<FileStat>;
755 /// Get information on the file, directory, etc at this path, not following
758 /// Consult the `fs::lstat` documentation for more info.
760 /// This call preserves identical runtime/error semantics with `file::lstat`.
761 fn lstat(&self) -> IoResult<FileStat>;
763 /// Boolean value indicator whether the underlying file exists on the local
764 /// filesystem. Returns false in exactly the cases where `fs::stat` fails.
765 fn exists(&self) -> bool;
767 /// Whether the underlying implementation (be it a file path, or something
768 /// else) points at a "regular file" on the FS. Will return false for paths
769 /// to non-existent locations or directories or other non-regular files
770 /// (named pipes, etc). Follows links when making this determination.
771 fn is_file(&self) -> bool;
773 /// Whether the underlying implementation (be it a file path, or something
774 /// else) is pointing at a directory in the underlying FS. Will return
775 /// false for paths to non-existent locations or if the item is not a
776 /// directory (eg files, named pipes, etc). Follows links when making this
778 fn is_dir(&self) -> bool;
781 impl PathExtensions for path::Path {
782 fn stat(&self) -> IoResult<FileStat> { stat(self) }
783 fn lstat(&self) -> IoResult<FileStat> { lstat(self) }
784 fn exists(&self) -> bool {
787 fn is_file(&self) -> bool {
789 Ok(s) => s.kind == FileType::RegularFile,
793 fn is_dir(&self) -> bool {
795 Ok(s) => s.kind == FileType::Directory,
801 fn mode_string(mode: FileMode) -> &'static str {
803 super::Open => "open",
804 super::Append => "append",
805 super::Truncate => "truncate"
809 fn access_string(access: FileAccess) -> &'static str {
811 super::Read => "read",
812 super::Write => "write",
813 super::ReadWrite => "readwrite"
818 #[allow(unused_imports)]
819 #[allow(unused_variables)]
823 use io::{SeekSet, SeekCur, SeekEnd, Read, Open, ReadWrite, FileType};
828 macro_rules! check { ($e:expr) => (
831 Err(e) => panic!("{} failed with: {}", stringify!($e), e),
835 macro_rules! error { ($e:expr, $s:expr) => (
837 Ok(_) => panic!("Unexpected success. Should've been: {}", $s),
838 Err(ref err) => assert!(err.to_string().contains($s.as_slice()),
839 format!("`{}` did not contain `{}`", err, $s))
843 pub struct TempDir(Path);
846 fn join(&self, path: &str) -> Path {
847 let TempDir(ref p) = *self;
851 fn path<'a>(&'a self) -> &'a Path {
852 let TempDir(ref p) = *self;
857 impl Drop for TempDir {
859 // Gee, seeing how we're testing the fs module I sure hope that we
860 // at least implement this correctly!
861 let TempDir(ref p) = *self;
862 check!(io::fs::rmdir_recursive(p));
866 pub fn tmpdir() -> TempDir {
869 let ret = os::tmpdir().join(format!("rust-{}", rand::random::<u32>()));
870 check!(io::fs::mkdir(&ret, io::USER_RWX));
875 fn file_test_io_smoke_test() {
876 let message = "it's alright. have a good time";
877 let tmpdir = tmpdir();
878 let filename = &tmpdir.join("file_rt_io_file_test.txt");
880 let mut write_stream = File::open_mode(filename, Open, ReadWrite);
881 check!(write_stream.write(message.as_bytes()));
884 let mut read_stream = File::open_mode(filename, Open, Read);
885 let mut read_buf = [0; 1028];
886 let read_str = match check!(read_stream.read(&mut read_buf)) {
887 -1|0 => panic!("shouldn't happen"),
888 n => str::from_utf8(read_buf[..n]).unwrap().to_string()
890 assert_eq!(read_str.as_slice(), message);
892 check!(unlink(filename));
896 fn invalid_path_raises() {
897 let tmpdir = tmpdir();
898 let filename = &tmpdir.join("file_that_does_not_exist.txt");
899 let result = File::open_mode(filename, Open, Read);
901 error!(result, "couldn't open path as file");
903 error!(result, "no such file or directory");
905 error!(result, format!("path={}; mode=open; access=read", filename.display()));
909 fn file_test_iounlinking_invalid_path_should_raise_condition() {
910 let tmpdir = tmpdir();
911 let filename = &tmpdir.join("file_another_file_that_does_not_exist.txt");
913 let result = unlink(filename);
915 error!(result, "couldn't unlink path");
917 error!(result, "no such file or directory");
919 error!(result, format!("path={}", filename.display()));
923 fn file_test_io_non_positional_read() {
924 let message: &str = "ten-four";
925 let mut read_mem = [0; 8];
926 let tmpdir = tmpdir();
927 let filename = &tmpdir.join("file_rt_io_file_test_positional.txt");
929 let mut rw_stream = File::open_mode(filename, Open, ReadWrite);
930 check!(rw_stream.write(message.as_bytes()));
933 let mut read_stream = File::open_mode(filename, Open, Read);
935 let read_buf = read_mem.slice_mut(0, 4);
936 check!(read_stream.read(read_buf));
939 let read_buf = read_mem.slice_mut(4, 8);
940 check!(read_stream.read(read_buf));
943 check!(unlink(filename));
944 let read_str = str::from_utf8(&read_mem).unwrap();
945 assert_eq!(read_str, message);
949 fn file_test_io_seek_and_tell_smoke_test() {
950 let message = "ten-four";
951 let mut read_mem = [0; 4];
952 let set_cursor = 4 as u64;
953 let mut tell_pos_pre_read;
954 let mut tell_pos_post_read;
955 let tmpdir = tmpdir();
956 let filename = &tmpdir.join("file_rt_io_file_test_seeking.txt");
958 let mut rw_stream = File::open_mode(filename, Open, ReadWrite);
959 check!(rw_stream.write(message.as_bytes()));
962 let mut read_stream = File::open_mode(filename, Open, Read);
963 check!(read_stream.seek(set_cursor as i64, SeekSet));
964 tell_pos_pre_read = check!(read_stream.tell());
965 check!(read_stream.read(&mut read_mem));
966 tell_pos_post_read = check!(read_stream.tell());
968 check!(unlink(filename));
969 let read_str = str::from_utf8(&read_mem).unwrap();
970 assert_eq!(read_str, message.slice(4, 8));
971 assert_eq!(tell_pos_pre_read, set_cursor);
972 assert_eq!(tell_pos_post_read, message.len() as u64);
976 fn file_test_io_seek_and_write() {
977 let initial_msg = "food-is-yummy";
978 let overwrite_msg = "-the-bar!!";
979 let final_msg = "foo-the-bar!!";
981 let mut read_mem = [0; 13];
982 let tmpdir = tmpdir();
983 let filename = &tmpdir.join("file_rt_io_file_test_seek_and_write.txt");
985 let mut rw_stream = File::open_mode(filename, Open, ReadWrite);
986 check!(rw_stream.write(initial_msg.as_bytes()));
987 check!(rw_stream.seek(seek_idx as i64, SeekSet));
988 check!(rw_stream.write(overwrite_msg.as_bytes()));
991 let mut read_stream = File::open_mode(filename, Open, Read);
992 check!(read_stream.read(&mut read_mem));
994 check!(unlink(filename));
995 let read_str = str::from_utf8(&read_mem).unwrap();
996 assert!(read_str == final_msg);
1000 fn file_test_io_seek_shakedown() {
1001 use str; // 01234567890123
1002 let initial_msg = "qwer-asdf-zxcv";
1003 let chunk_one: &str = "qwer";
1004 let chunk_two: &str = "asdf";
1005 let chunk_three: &str = "zxcv";
1006 let mut read_mem = [0; 4];
1007 let tmpdir = tmpdir();
1008 let filename = &tmpdir.join("file_rt_io_file_test_seek_shakedown.txt");
1010 let mut rw_stream = File::open_mode(filename, Open, ReadWrite);
1011 check!(rw_stream.write(initial_msg.as_bytes()));
1014 let mut read_stream = File::open_mode(filename, Open, Read);
1016 check!(read_stream.seek(-4, SeekEnd));
1017 check!(read_stream.read(&mut read_mem));
1018 assert_eq!(str::from_utf8(&read_mem).unwrap(), chunk_three);
1020 check!(read_stream.seek(-9, SeekCur));
1021 check!(read_stream.read(&mut read_mem));
1022 assert_eq!(str::from_utf8(&read_mem).unwrap(), chunk_two);
1024 check!(read_stream.seek(0, SeekSet));
1025 check!(read_stream.read(&mut read_mem));
1026 assert_eq!(str::from_utf8(&read_mem).unwrap(), chunk_one);
1028 check!(unlink(filename));
1032 fn file_test_stat_is_correct_on_is_file() {
1033 let tmpdir = tmpdir();
1034 let filename = &tmpdir.join("file_stat_correct_on_is_file.txt");
1036 let mut fs = check!(File::open_mode(filename, Open, ReadWrite));
1038 fs.write(msg.as_bytes()).unwrap();
1040 let fstat_res = check!(fs.stat());
1041 assert_eq!(fstat_res.kind, FileType::RegularFile);
1043 let stat_res_fn = check!(stat(filename));
1044 assert_eq!(stat_res_fn.kind, FileType::RegularFile);
1045 let stat_res_meth = check!(filename.stat());
1046 assert_eq!(stat_res_meth.kind, FileType::RegularFile);
1047 check!(unlink(filename));
1051 fn file_test_stat_is_correct_on_is_dir() {
1052 let tmpdir = tmpdir();
1053 let filename = &tmpdir.join("file_stat_correct_on_is_dir");
1054 check!(mkdir(filename, io::USER_RWX));
1055 let stat_res_fn = check!(stat(filename));
1056 assert!(stat_res_fn.kind == FileType::Directory);
1057 let stat_res_meth = check!(filename.stat());
1058 assert!(stat_res_meth.kind == FileType::Directory);
1059 check!(rmdir(filename));
1063 fn file_test_fileinfo_false_when_checking_is_file_on_a_directory() {
1064 let tmpdir = tmpdir();
1065 let dir = &tmpdir.join("fileinfo_false_on_dir");
1066 check!(mkdir(dir, io::USER_RWX));
1067 assert!(dir.is_file() == false);
1072 fn file_test_fileinfo_check_exists_before_and_after_file_creation() {
1073 let tmpdir = tmpdir();
1074 let file = &tmpdir.join("fileinfo_check_exists_b_and_a.txt");
1075 check!(File::create(file).write(b"foo"));
1076 assert!(file.exists());
1077 check!(unlink(file));
1078 assert!(!file.exists());
1082 fn file_test_directoryinfo_check_exists_before_and_after_mkdir() {
1083 let tmpdir = tmpdir();
1084 let dir = &tmpdir.join("before_and_after_dir");
1085 assert!(!dir.exists());
1086 check!(mkdir(dir, io::USER_RWX));
1087 assert!(dir.exists());
1088 assert!(dir.is_dir());
1090 assert!(!dir.exists());
1094 fn file_test_directoryinfo_readdir() {
1096 let tmpdir = tmpdir();
1097 let dir = &tmpdir.join("di_readdir");
1098 check!(mkdir(dir, io::USER_RWX));
1100 for n in range(0i,3) {
1101 let f = dir.join(format!("{}.txt", n));
1102 let mut w = check!(File::create(&f));
1103 let msg_str = format!("{}{}", prefix, n.to_string());
1104 let msg = msg_str.as_bytes();
1105 check!(w.write(msg));
1107 let files = check!(readdir(dir));
1108 let mut mem = [0u8; 4];
1109 for f in files.iter() {
1111 let n = f.filestem_str();
1112 check!(File::open(f).read(&mut mem));
1113 let read_str = str::from_utf8(&mem).unwrap();
1114 let expected = match n {
1115 None|Some("") => panic!("really shouldn't happen.."),
1116 Some(n) => format!("{}{}", prefix, n),
1118 assert_eq!(expected.as_slice(), read_str);
1126 fn file_test_walk_dir() {
1127 let tmpdir = tmpdir();
1128 let dir = &tmpdir.join("walk_dir");
1129 check!(mkdir(dir, io::USER_RWX));
1131 let dir1 = &dir.join("01/02/03");
1132 check!(mkdir_recursive(dir1, io::USER_RWX));
1133 check!(File::create(&dir1.join("04")));
1135 let dir2 = &dir.join("11/12/13");
1136 check!(mkdir_recursive(dir2, io::USER_RWX));
1137 check!(File::create(&dir2.join("14")));
1139 let mut files = check!(walk_dir(dir));
1140 let mut cur = [0u8; 2];
1142 let stem = f.filestem_str().unwrap();
1143 let root = stem.as_bytes()[0] - b'0';
1144 let name = stem.as_bytes()[1] - b'0';
1145 assert!(cur[root as uint] < name);
1146 cur[root as uint] = name;
1149 check!(rmdir_recursive(dir));
1153 fn mkdir_path_already_exists_error() {
1154 use io::{IoError, PathAlreadyExists};
1156 let tmpdir = tmpdir();
1157 let dir = &tmpdir.join("mkdir_error_twice");
1158 check!(mkdir(dir, io::USER_RWX));
1159 match mkdir(dir, io::USER_RWX) {
1160 Err(IoError{kind:PathAlreadyExists,..}) => (),
1166 fn recursive_mkdir() {
1167 let tmpdir = tmpdir();
1168 let dir = tmpdir.join("d1/d2");
1169 check!(mkdir_recursive(&dir, io::USER_RWX));
1170 assert!(dir.is_dir())
1174 fn recursive_mkdir_failure() {
1175 let tmpdir = tmpdir();
1176 let dir = tmpdir.join("d1");
1177 let file = dir.join("f1");
1179 check!(mkdir_recursive(&dir, io::USER_RWX));
1180 check!(File::create(&file));
1182 let result = mkdir_recursive(&file, io::USER_RWX);
1184 error!(result, "couldn't recursively mkdir");
1185 error!(result, "couldn't create directory");
1186 error!(result, "mode=0700");
1187 error!(result, format!("path={}", file.display()));
1191 fn recursive_mkdir_slash() {
1192 check!(mkdir_recursive(&Path::new("/"), io::USER_RWX));
1195 // FIXME(#12795) depends on lstat to work on windows
1196 #[cfg(not(windows))]
1198 fn recursive_rmdir() {
1199 let tmpdir = tmpdir();
1200 let d1 = tmpdir.join("d1");
1201 let dt = d1.join("t");
1202 let dtt = dt.join("t");
1203 let d2 = tmpdir.join("d2");
1204 let canary = d2.join("do_not_delete");
1205 check!(mkdir_recursive(&dtt, io::USER_RWX));
1206 check!(mkdir_recursive(&d2, io::USER_RWX));
1207 check!(File::create(&canary).write(b"foo"));
1208 check!(symlink(&d2, &dt.join("d2")));
1209 check!(rmdir_recursive(&d1));
1211 assert!(!d1.is_dir());
1212 assert!(canary.exists());
1216 fn unicode_path_is_dir() {
1217 assert!(Path::new(".").is_dir());
1218 assert!(!Path::new("test/stdtest/fs.rs").is_dir());
1220 let tmpdir = tmpdir();
1222 let mut dirpath = tmpdir.path().clone();
1223 dirpath.push(format!("test-가一ー你好"));
1224 check!(mkdir(&dirpath, io::USER_RWX));
1225 assert!(dirpath.is_dir());
1227 let mut filepath = dirpath;
1228 filepath.push("unicode-file-\u{ac00}\u{4e00}\u{30fc}\u{4f60}\u{597d}.rs");
1229 check!(File::create(&filepath)); // ignore return; touch only
1230 assert!(!filepath.is_dir());
1231 assert!(filepath.exists());
1235 fn unicode_path_exists() {
1236 assert!(Path::new(".").exists());
1237 assert!(!Path::new("test/nonexistent-bogus-path").exists());
1239 let tmpdir = tmpdir();
1240 let unicode = tmpdir.path();
1241 let unicode = unicode.join(format!("test-각丁ー再见"));
1242 check!(mkdir(&unicode, io::USER_RWX));
1243 assert!(unicode.exists());
1244 assert!(!Path::new("test/unicode-bogus-path-각丁ー再见").exists());
1248 fn copy_file_does_not_exist() {
1249 let from = Path::new("test/nonexistent-bogus-path");
1250 let to = Path::new("test/other-bogus-path");
1252 error!(copy(&from, &to),
1253 format!("couldn't copy path (the source path is not an \
1254 existing file; from={}; to={})",
1255 from.display(), to.display()));
1257 match copy(&from, &to) {
1260 assert!(!from.exists());
1261 assert!(!to.exists());
1268 let tmpdir = tmpdir();
1269 let input = tmpdir.join("in.txt");
1270 let out = tmpdir.join("out.txt");
1272 check!(File::create(&input).write(b"hello"));
1273 check!(copy(&input, &out));
1274 let contents = check!(File::open(&out).read_to_end());
1275 assert_eq!(contents.as_slice(), b"hello");
1277 assert_eq!(check!(input.stat()).perm, check!(out.stat()).perm);
1281 fn copy_file_dst_dir() {
1282 let tmpdir = tmpdir();
1283 let out = tmpdir.join("out");
1285 check!(File::create(&out));
1286 match copy(&out, tmpdir.path()) {
1287 Ok(..) => panic!(), Err(..) => {}
1292 fn copy_file_dst_exists() {
1293 let tmpdir = tmpdir();
1294 let input = tmpdir.join("in");
1295 let output = tmpdir.join("out");
1297 check!(File::create(&input).write("foo".as_bytes()));
1298 check!(File::create(&output).write("bar".as_bytes()));
1299 check!(copy(&input, &output));
1301 assert_eq!(check!(File::open(&output).read_to_end()),
1306 fn copy_file_src_dir() {
1307 let tmpdir = tmpdir();
1308 let out = tmpdir.join("out");
1310 match copy(tmpdir.path(), &out) {
1311 Ok(..) => panic!(), Err(..) => {}
1313 assert!(!out.exists());
1317 fn copy_file_preserves_perm_bits() {
1318 let tmpdir = tmpdir();
1319 let input = tmpdir.join("in.txt");
1320 let out = tmpdir.join("out.txt");
1322 check!(File::create(&input));
1323 check!(chmod(&input, io::USER_READ));
1324 check!(copy(&input, &out));
1325 assert!(!check!(out.stat()).perm.intersects(io::USER_WRITE));
1327 check!(chmod(&input, io::USER_FILE));
1328 check!(chmod(&out, io::USER_FILE));
1331 #[cfg(not(windows))] // FIXME(#10264) operation not permitted?
1333 fn symlinks_work() {
1334 let tmpdir = tmpdir();
1335 let input = tmpdir.join("in.txt");
1336 let out = tmpdir.join("out.txt");
1338 check!(File::create(&input).write("foobar".as_bytes()));
1339 check!(symlink(&input, &out));
1340 if cfg!(not(windows)) {
1341 assert_eq!(check!(lstat(&out)).kind, FileType::Symlink);
1342 assert_eq!(check!(out.lstat()).kind, FileType::Symlink);
1344 assert_eq!(check!(stat(&out)).size, check!(stat(&input)).size);
1345 assert_eq!(check!(File::open(&out).read_to_end()),
1346 b"foobar".to_vec());
1349 #[cfg(not(windows))] // apparently windows doesn't like symlinks
1351 fn symlink_noexist() {
1352 let tmpdir = tmpdir();
1353 // symlinks can point to things that don't exist
1354 check!(symlink(&tmpdir.join("foo"), &tmpdir.join("bar")));
1355 assert!(check!(readlink(&tmpdir.join("bar"))) == tmpdir.join("foo"));
1359 fn readlink_not_symlink() {
1360 let tmpdir = tmpdir();
1361 match readlink(tmpdir.path()) {
1362 Ok(..) => panic!("wanted a failure"),
1369 let tmpdir = tmpdir();
1370 let input = tmpdir.join("in.txt");
1371 let out = tmpdir.join("out.txt");
1373 check!(File::create(&input).write("foobar".as_bytes()));
1374 check!(link(&input, &out));
1375 if cfg!(not(windows)) {
1376 assert_eq!(check!(lstat(&out)).kind, FileType::RegularFile);
1377 assert_eq!(check!(out.lstat()).kind, FileType::RegularFile);
1378 assert_eq!(check!(stat(&out)).unstable.nlink, 2);
1379 assert_eq!(check!(out.stat()).unstable.nlink, 2);
1381 assert_eq!(check!(stat(&out)).size, check!(stat(&input)).size);
1382 assert_eq!(check!(stat(&out)).size, check!(input.stat()).size);
1383 assert_eq!(check!(File::open(&out).read_to_end()),
1384 b"foobar".to_vec());
1386 // can't link to yourself
1387 match link(&input, &input) {
1388 Ok(..) => panic!("wanted a failure"),
1391 // can't link to something that doesn't exist
1392 match link(&tmpdir.join("foo"), &tmpdir.join("bar")) {
1393 Ok(..) => panic!("wanted a failure"),
1400 let tmpdir = tmpdir();
1401 let file = tmpdir.join("in.txt");
1403 check!(File::create(&file));
1404 assert!(check!(stat(&file)).perm.contains(io::USER_WRITE));
1405 check!(chmod(&file, io::USER_READ));
1406 assert!(!check!(stat(&file)).perm.contains(io::USER_WRITE));
1408 match chmod(&tmpdir.join("foo"), io::USER_RWX) {
1409 Ok(..) => panic!("wanted a panic"),
1413 check!(chmod(&file, io::USER_FILE));
1417 fn sync_doesnt_kill_anything() {
1418 let tmpdir = tmpdir();
1419 let path = tmpdir.join("in.txt");
1421 let mut file = check!(File::open_mode(&path, io::Open, io::ReadWrite));
1422 check!(file.fsync());
1423 check!(file.datasync());
1424 check!(file.write(b"foo"));
1425 check!(file.fsync());
1426 check!(file.datasync());
1431 fn truncate_works() {
1432 let tmpdir = tmpdir();
1433 let path = tmpdir.join("in.txt");
1435 let mut file = check!(File::open_mode(&path, io::Open, io::ReadWrite));
1436 check!(file.write(b"foo"));
1437 check!(file.fsync());
1439 // Do some simple things with truncation
1440 assert_eq!(check!(file.stat()).size, 3);
1441 check!(file.truncate(10));
1442 assert_eq!(check!(file.stat()).size, 10);
1443 check!(file.write(b"bar"));
1444 check!(file.fsync());
1445 assert_eq!(check!(file.stat()).size, 10);
1446 assert_eq!(check!(File::open(&path).read_to_end()),
1447 b"foobar\0\0\0\0".to_vec());
1449 // Truncate to a smaller length, don't seek, and then write something.
1450 // Ensure that the intermediate zeroes are all filled in (we're seeked
1451 // past the end of the file).
1452 check!(file.truncate(2));
1453 assert_eq!(check!(file.stat()).size, 2);
1454 check!(file.write(b"wut"));
1455 check!(file.fsync());
1456 assert_eq!(check!(file.stat()).size, 9);
1457 assert_eq!(check!(File::open(&path).read_to_end()),
1458 b"fo\0\0\0\0wut".to_vec());
1464 let tmpdir = tmpdir();
1466 match File::open_mode(&tmpdir.join("a"), io::Open, io::Read) {
1467 Ok(..) => panic!(), Err(..) => {}
1470 // Perform each one twice to make sure that it succeeds the second time
1471 // (where the file exists)
1472 check!(File::open_mode(&tmpdir.join("b"), io::Open, io::Write));
1473 assert!(tmpdir.join("b").exists());
1474 check!(File::open_mode(&tmpdir.join("b"), io::Open, io::Write));
1476 check!(File::open_mode(&tmpdir.join("c"), io::Open, io::ReadWrite));
1477 assert!(tmpdir.join("c").exists());
1478 check!(File::open_mode(&tmpdir.join("c"), io::Open, io::ReadWrite));
1480 check!(File::open_mode(&tmpdir.join("d"), io::Append, io::Write));
1481 assert!(tmpdir.join("d").exists());
1482 check!(File::open_mode(&tmpdir.join("d"), io::Append, io::Write));
1484 check!(File::open_mode(&tmpdir.join("e"), io::Append, io::ReadWrite));
1485 assert!(tmpdir.join("e").exists());
1486 check!(File::open_mode(&tmpdir.join("e"), io::Append, io::ReadWrite));
1488 check!(File::open_mode(&tmpdir.join("f"), io::Truncate, io::Write));
1489 assert!(tmpdir.join("f").exists());
1490 check!(File::open_mode(&tmpdir.join("f"), io::Truncate, io::Write));
1492 check!(File::open_mode(&tmpdir.join("g"), io::Truncate, io::ReadWrite));
1493 assert!(tmpdir.join("g").exists());
1494 check!(File::open_mode(&tmpdir.join("g"), io::Truncate, io::ReadWrite));
1496 check!(File::create(&tmpdir.join("h")).write("foo".as_bytes()));
1497 check!(File::open_mode(&tmpdir.join("h"), io::Open, io::Read));
1499 let mut f = check!(File::open_mode(&tmpdir.join("h"), io::Open,
1501 match f.write("wut".as_bytes()) {
1502 Ok(..) => panic!(), Err(..) => {}
1505 assert!(check!(stat(&tmpdir.join("h"))).size == 3,
1506 "write/stat failed");
1508 let mut f = check!(File::open_mode(&tmpdir.join("h"), io::Append,
1510 check!(f.write("bar".as_bytes()));
1512 assert!(check!(stat(&tmpdir.join("h"))).size == 6,
1513 "append didn't append");
1515 let mut f = check!(File::open_mode(&tmpdir.join("h"), io::Truncate,
1517 check!(f.write("bar".as_bytes()));
1519 assert!(check!(stat(&tmpdir.join("h"))).size == 3,
1520 "truncate didn't truncate");
1525 let tmpdir = tmpdir();
1526 let path = tmpdir.join("a");
1527 check!(File::create(&path));
1528 // These numbers have to be bigger than the time in the day to account for timezones
1529 // Windows in particular will fail in certain timezones with small enough values
1530 check!(change_file_times(&path, 100000, 200000));
1531 assert_eq!(check!(path.stat()).accessed, 100000);
1532 assert_eq!(check!(path.stat()).modified, 200000);
1536 fn utime_noexist() {
1537 let tmpdir = tmpdir();
1539 match change_file_times(&tmpdir.join("a"), 100, 200) {
1547 use rand::{StdRng, Rng};
1549 let mut bytes = [0; 1024];
1550 StdRng::new().ok().unwrap().fill_bytes(&mut bytes);
1552 let tmpdir = tmpdir();
1554 check!(File::create(&tmpdir.join("test")).write(&bytes));
1555 let actual = check!(File::open(&tmpdir.join("test")).read_to_end());
1556 assert!(actual == bytes.as_slice());
1560 fn unlink_readonly() {
1561 let tmpdir = tmpdir();
1562 let path = tmpdir.join("file");
1563 check!(File::create(&path));
1564 check!(chmod(&path, io::USER_READ));
1565 check!(unlink(&path));