1 // Copyright 2015 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 //! Filesystem manipulation operations.
13 //! This module contains basic methods to manipulate the contents of the local
14 //! filesystem. All methods in this module represent cross-platform filesystem
15 //! operations. Extra platform-specific functionality can be found in the
16 //! extension traits of `std::os::$platform`.
18 #![stable(feature = "rust1", since = "1.0.0")]
22 use io::{self, SeekFrom, Seek, Read, Initializer, Write};
23 use path::{Path, PathBuf};
24 use sys::fs as fs_imp;
25 use sys_common::{AsInnerMut, FromInner, AsInner, IntoInner};
28 /// A reference to an open file on the filesystem.
30 /// An instance of a `File` can be read and/or written depending on what options
31 /// it was opened with. Files also implement [`Seek`] to alter the logical cursor
32 /// that the file contains internally.
34 /// Files are automatically closed when they go out of scope.
38 /// Create a new file and write bytes to it:
41 /// use std::fs::File;
42 /// use std::io::prelude::*;
44 /// fn main() -> std::io::Result<()> {
45 /// let mut file = File::create("foo.txt")?;
46 /// file.write_all(b"Hello, world!")?;
51 /// Read the contents of a file into a [`String`]:
54 /// use std::fs::File;
55 /// use std::io::prelude::*;
57 /// fn main() -> std::io::Result<()> {
58 /// let mut file = File::open("foo.txt")?;
59 /// let mut contents = String::new();
60 /// file.read_to_string(&mut contents)?;
61 /// assert_eq!(contents, "Hello, world!");
66 /// It can be more efficient to read the contents of a file with a buffered
67 /// [`Read`]er. This can be accomplished with [`BufReader<R>`]:
70 /// use std::fs::File;
71 /// use std::io::BufReader;
72 /// use std::io::prelude::*;
74 /// fn main() -> std::io::Result<()> {
75 /// let file = File::open("foo.txt")?;
76 /// let mut buf_reader = BufReader::new(file);
77 /// let mut contents = String::new();
78 /// buf_reader.read_to_string(&mut contents)?;
79 /// assert_eq!(contents, "Hello, world!");
84 /// Note that, although read and write methods require a `&mut File`, because
85 /// of the interfaces for [`Read`] and [`Write`], the holder of a `&File` can
86 /// still modify the file, either through methods that take `&File` or by
87 /// retrieving the underlying OS object and modifying the file that way.
88 /// Additionally, many operating systems allow concurrent modification of files
89 /// by different processes. Avoid assuming that holding a `&File` means that the
90 /// file will not change.
92 /// [`Seek`]: ../io/trait.Seek.html
93 /// [`String`]: ../string/struct.String.html
94 /// [`Read`]: ../io/trait.Read.html
95 /// [`Write`]: ../io/trait.Write.html
96 /// [`BufReader<R>`]: ../io/struct.BufReader.html
97 #[stable(feature = "rust1", since = "1.0.0")]
102 /// Metadata information about a file.
104 /// This structure is returned from the [`metadata`] or
105 /// [`symlink_metadata`] function or method and represents known
106 /// metadata about a file such as its permissions, size, modification
109 /// [`metadata`]: fn.metadata.html
110 /// [`symlink_metadata`]: fn.symlink_metadata.html
111 #[stable(feature = "rust1", since = "1.0.0")]
113 pub struct Metadata(fs_imp::FileAttr);
115 /// Iterator over the entries in a directory.
117 /// This iterator is returned from the [`read_dir`] function of this module and
118 /// will yield instances of [`io::Result`]`<`[`DirEntry`]`>`. Through a [`DirEntry`]
119 /// information like the entry's path and possibly other metadata can be
124 /// This [`io::Result`] will be an [`Err`] if there's some sort of intermittent
125 /// IO error during iteration.
127 /// [`read_dir`]: fn.read_dir.html
128 /// [`DirEntry`]: struct.DirEntry.html
129 /// [`io::Result`]: ../io/type.Result.html
130 /// [`Err`]: ../result/enum.Result.html#variant.Err
131 #[stable(feature = "rust1", since = "1.0.0")]
133 pub struct ReadDir(fs_imp::ReadDir);
135 /// Entries returned by the [`ReadDir`] iterator.
137 /// [`ReadDir`]: struct.ReadDir.html
139 /// An instance of `DirEntry` represents an entry inside of a directory on the
140 /// filesystem. Each entry can be inspected via methods to learn about the full
141 /// path or possibly other metadata through per-platform extension traits.
142 #[stable(feature = "rust1", since = "1.0.0")]
143 pub struct DirEntry(fs_imp::DirEntry);
145 /// Options and flags which can be used to configure how a file is opened.
147 /// This builder exposes the ability to configure how a [`File`] is opened and
148 /// what operations are permitted on the open file. The [`File::open`] and
149 /// [`File::create`] methods are aliases for commonly used options using this
152 /// [`File`]: struct.File.html
153 /// [`File::open`]: struct.File.html#method.open
154 /// [`File::create`]: struct.File.html#method.create
156 /// Generally speaking, when using `OpenOptions`, you'll first call [`new`],
157 /// then chain calls to methods to set each option, then call [`open`],
158 /// passing the path of the file you're trying to open. This will give you a
159 /// [`io::Result`][result] with a [`File`][file] inside that you can further
162 /// [`new`]: struct.OpenOptions.html#method.new
163 /// [`open`]: struct.OpenOptions.html#method.open
164 /// [result]: ../io/type.Result.html
165 /// [file]: struct.File.html
169 /// Opening a file to read:
172 /// use std::fs::OpenOptions;
174 /// let file = OpenOptions::new().read(true).open("foo.txt");
177 /// Opening a file for both reading and writing, as well as creating it if it
181 /// use std::fs::OpenOptions;
183 /// let file = OpenOptions::new()
187 /// .open("foo.txt");
189 #[derive(Clone, Debug)]
190 #[stable(feature = "rust1", since = "1.0.0")]
191 pub struct OpenOptions(fs_imp::OpenOptions);
193 /// Representation of the various permissions on a file.
195 /// This module only currently provides one bit of information, [`readonly`],
196 /// which is exposed on all currently supported platforms. Unix-specific
197 /// functionality, such as mode bits, is available through the
198 /// `os::unix::PermissionsExt` trait.
200 /// [`readonly`]: struct.Permissions.html#method.readonly
201 #[derive(Clone, PartialEq, Eq, Debug)]
202 #[stable(feature = "rust1", since = "1.0.0")]
203 pub struct Permissions(fs_imp::FilePermissions);
205 /// A structure representing a type of file with accessors for each file type.
206 /// It is returned by [`Metadata::file_type`] method.
208 /// [`Metadata::file_type`]: struct.Metadata.html#method.file_type
209 #[stable(feature = "file_type", since = "1.1.0")]
210 #[derive(Copy, Clone, PartialEq, Eq, Hash, Debug)]
211 pub struct FileType(fs_imp::FileType);
213 /// A builder used to create directories in various manners.
215 /// This builder also supports platform-specific options.
216 #[stable(feature = "dir_builder", since = "1.6.0")]
218 pub struct DirBuilder {
219 inner: fs_imp::DirBuilder,
223 /// How large a buffer to pre-allocate before reading the entire file.
224 fn initial_buffer_size(file: &File) -> usize {
225 // Allocate one extra byte so the buffer doesn't need to grow before the
226 // final `read` call at the end of the file. Don't worry about `usize`
227 // overflow because reading will fail regardless in that case.
228 file.metadata().map(|m| m.len() as usize + 1).unwrap_or(0)
231 /// Read the entire contents of a file into a bytes vector.
233 /// This is a convenience function for using [`File::open`] and [`read_to_end`]
234 /// with fewer imports and without an intermediate variable. It pre-allocates a
235 /// buffer based on the file size when available, so it is generally faster than
236 /// reading into a vector created with `Vec::new()`.
238 /// [`File::open`]: struct.File.html#method.open
239 /// [`read_to_end`]: ../io/trait.Read.html#method.read_to_end
243 /// This function will return an error if `path` does not already exist.
244 /// Other errors may also be returned according to [`OpenOptions::open`].
246 /// [`OpenOptions::open`]: struct.OpenOptions.html#method.open
248 /// It will also return an error if it encounters while reading an error
249 /// of a kind other than [`ErrorKind::Interrupted`].
251 /// [`ErrorKind::Interrupted`]: ../../std/io/enum.ErrorKind.html#variant.Interrupted
257 /// use std::net::SocketAddr;
259 /// fn main() -> Result<(), Box<std::error::Error + 'static>> {
260 /// let foo: SocketAddr = String::from_utf8_lossy(&fs::read("address.txt")?).parse()?;
264 #[stable(feature = "fs_read_write_bytes", since = "1.26.0")]
265 pub fn read<P: AsRef<Path>>(path: P) -> io::Result<Vec<u8>> {
266 let mut file = File::open(path)?;
267 let mut bytes = Vec::with_capacity(initial_buffer_size(&file));
268 file.read_to_end(&mut bytes)?;
272 /// Read the entire contents of a file into a string.
274 /// This is a convenience function for using [`File::open`] and [`read_to_string`]
275 /// with fewer imports and without an intermediate variable. It pre-allocates a
276 /// buffer based on the file size when available, so it is generally faster than
277 /// reading into a string created with `String::new()`.
279 /// [`File::open`]: struct.File.html#method.open
280 /// [`read_to_string`]: ../io/trait.Read.html#method.read_to_string
284 /// This function will return an error if `path` does not already exist.
285 /// Other errors may also be returned according to [`OpenOptions::open`].
287 /// [`OpenOptions::open`]: struct.OpenOptions.html#method.open
289 /// It will also return an error if it encounters while reading an error
290 /// of a kind other than [`ErrorKind::Interrupted`],
291 /// or if the contents of the file are not valid UTF-8.
293 /// [`ErrorKind::Interrupted`]: ../../std/io/enum.ErrorKind.html#variant.Interrupted
299 /// use std::net::SocketAddr;
301 /// fn main() -> Result<(), Box<std::error::Error + 'static>> {
302 /// let foo: SocketAddr = fs::read_to_string("address.txt")?.parse()?;
306 #[stable(feature = "fs_read_write", since = "1.26.0")]
307 pub fn read_to_string<P: AsRef<Path>>(path: P) -> io::Result<String> {
308 let mut file = File::open(path)?;
309 let mut string = String::with_capacity(initial_buffer_size(&file));
310 file.read_to_string(&mut string)?;
314 /// Write a slice as the entire contents of a file.
316 /// This function will create a file if it does not exist,
317 /// and will entirely replace its contents if it does.
319 /// This is a convenience function for using [`File::create`] and [`write_all`]
320 /// with fewer imports.
322 /// [`File::create`]: struct.File.html#method.create
323 /// [`write_all`]: ../io/trait.Write.html#method.write_all
330 /// fn main() -> std::io::Result<()> {
331 /// fs::write("foo.txt", b"Lorem ipsum")?;
332 /// fs::write("bar.txt", "dolor sit")?;
336 #[stable(feature = "fs_read_write_bytes", since = "1.26.0")]
337 pub fn write<P: AsRef<Path>, C: AsRef<[u8]>>(path: P, contents: C) -> io::Result<()> {
338 File::create(path)?.write_all(contents.as_ref())
342 /// Attempts to open a file in read-only mode.
344 /// See the [`OpenOptions::open`] method for more details.
348 /// This function will return an error if `path` does not already exist.
349 /// Other errors may also be returned according to [`OpenOptions::open`].
351 /// [`OpenOptions::open`]: struct.OpenOptions.html#method.open
356 /// use std::fs::File;
358 /// fn main() -> std::io::Result<()> {
359 /// let mut f = File::open("foo.txt")?;
363 #[stable(feature = "rust1", since = "1.0.0")]
364 pub fn open<P: AsRef<Path>>(path: P) -> io::Result<File> {
365 OpenOptions::new().read(true).open(path.as_ref())
368 /// Opens a file in write-only mode.
370 /// This function will create a file if it does not exist,
371 /// and will truncate it if it does.
373 /// See the [`OpenOptions::open`] function for more details.
375 /// [`OpenOptions::open`]: struct.OpenOptions.html#method.open
380 /// use std::fs::File;
382 /// fn main() -> std::io::Result<()> {
383 /// let mut f = File::create("foo.txt")?;
387 #[stable(feature = "rust1", since = "1.0.0")]
388 pub fn create<P: AsRef<Path>>(path: P) -> io::Result<File> {
389 OpenOptions::new().write(true).create(true).truncate(true).open(path.as_ref())
392 /// Attempts to sync all OS-internal metadata to disk.
394 /// This function will attempt to ensure that all in-core data reaches the
395 /// filesystem before returning.
400 /// use std::fs::File;
401 /// use std::io::prelude::*;
403 /// fn main() -> std::io::Result<()> {
404 /// let mut f = File::create("foo.txt")?;
405 /// f.write_all(b"Hello, world!")?;
411 #[stable(feature = "rust1", since = "1.0.0")]
412 pub fn sync_all(&self) -> io::Result<()> {
416 /// This function is similar to [`sync_all`], except that it may not
417 /// synchronize file metadata to the filesystem.
419 /// This is intended for use cases that must synchronize content, but don't
420 /// need the metadata on disk. The goal of this method is to reduce disk
423 /// Note that some platforms may simply implement this in terms of
426 /// [`sync_all`]: struct.File.html#method.sync_all
431 /// use std::fs::File;
432 /// use std::io::prelude::*;
434 /// fn main() -> std::io::Result<()> {
435 /// let mut f = File::create("foo.txt")?;
436 /// f.write_all(b"Hello, world!")?;
442 #[stable(feature = "rust1", since = "1.0.0")]
443 pub fn sync_data(&self) -> io::Result<()> {
444 self.inner.datasync()
447 /// Truncates or extends the underlying file, updating the size of
448 /// this file to become `size`.
450 /// If the `size` is less than the current file's size, then the file will
451 /// be shrunk. If it is greater than the current file's size, then the file
452 /// will be extended to `size` and have all of the intermediate data filled
455 /// The file's cursor isn't changed. In particular, if the cursor was at the
456 /// end and the file is shrunk using this operation, the cursor will now be
461 /// This function will return an error if the file is not opened for writing.
466 /// use std::fs::File;
468 /// fn main() -> std::io::Result<()> {
469 /// let mut f = File::create("foo.txt")?;
475 /// Note that this method alters the content of the underlying file, even
476 /// though it takes `&self` rather than `&mut self`.
477 #[stable(feature = "rust1", since = "1.0.0")]
478 pub fn set_len(&self, size: u64) -> io::Result<()> {
479 self.inner.truncate(size)
482 /// Queries metadata about the underlying file.
487 /// use std::fs::File;
489 /// fn main() -> std::io::Result<()> {
490 /// let mut f = File::open("foo.txt")?;
491 /// let metadata = f.metadata()?;
495 #[stable(feature = "rust1", since = "1.0.0")]
496 pub fn metadata(&self) -> io::Result<Metadata> {
497 self.inner.file_attr().map(Metadata)
500 /// Create a new `File` instance that shares the same underlying file handle
501 /// as the existing `File` instance. Reads, writes, and seeks will affect
502 /// both `File` instances simultaneously.
506 /// Create two handles for a file named `foo.txt`:
509 /// use std::fs::File;
511 /// fn main() -> std::io::Result<()> {
512 /// let mut file = File::open("foo.txt")?;
513 /// let file_copy = file.try_clone()?;
518 /// Assuming there’s a file named `foo.txt` with contents `abcdef\n`, create
519 /// two handles, seek one of them, and read the remaining bytes from the
523 /// use std::fs::File;
524 /// use std::io::SeekFrom;
525 /// use std::io::prelude::*;
527 /// fn main() -> std::io::Result<()> {
528 /// let mut file = File::open("foo.txt")?;
529 /// let mut file_copy = file.try_clone()?;
531 /// file.seek(SeekFrom::Start(3))?;
533 /// let mut contents = vec![];
534 /// file_copy.read_to_end(&mut contents)?;
535 /// assert_eq!(contents, b"def\n");
539 #[stable(feature = "file_try_clone", since = "1.9.0")]
540 pub fn try_clone(&self) -> io::Result<File> {
542 inner: self.inner.duplicate()?
546 /// Changes the permissions on the underlying file.
548 /// # Platform-specific behavior
550 /// This function currently corresponds to the `fchmod` function on Unix and
551 /// the `SetFileInformationByHandle` function on Windows. Note that, this
552 /// [may change in the future][changes].
554 /// [changes]: ../io/index.html#platform-specific-behavior
558 /// This function will return an error if the user lacks permission change
559 /// attributes on the underlying file. It may also return an error in other
560 /// os-specific unspecified cases.
565 /// fn main() -> std::io::Result<()> {
566 /// use std::fs::File;
568 /// let file = File::open("foo.txt")?;
569 /// let mut perms = file.metadata()?.permissions();
570 /// perms.set_readonly(true);
571 /// file.set_permissions(perms)?;
576 /// Note that this method alters the permissions of the underlying file,
577 /// even though it takes `&self` rather than `&mut self`.
578 #[stable(feature = "set_permissions_atomic", since = "1.16.0")]
579 pub fn set_permissions(&self, perm: Permissions) -> io::Result<()> {
580 self.inner.set_permissions(perm.0)
584 impl AsInner<fs_imp::File> for File {
585 fn as_inner(&self) -> &fs_imp::File { &self.inner }
587 impl FromInner<fs_imp::File> for File {
588 fn from_inner(f: fs_imp::File) -> File {
592 impl IntoInner<fs_imp::File> for File {
593 fn into_inner(self) -> fs_imp::File {
598 #[stable(feature = "rust1", since = "1.0.0")]
599 impl fmt::Debug for File {
600 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
605 #[stable(feature = "rust1", since = "1.0.0")]
607 fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
612 unsafe fn initializer(&self) -> Initializer {
616 #[stable(feature = "rust1", since = "1.0.0")]
617 impl Write for File {
618 fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
619 self.inner.write(buf)
621 fn flush(&mut self) -> io::Result<()> { self.inner.flush() }
623 #[stable(feature = "rust1", since = "1.0.0")]
625 fn seek(&mut self, pos: SeekFrom) -> io::Result<u64> {
629 #[stable(feature = "rust1", since = "1.0.0")]
630 impl<'a> Read for &'a File {
631 fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
636 unsafe fn initializer(&self) -> Initializer {
640 #[stable(feature = "rust1", since = "1.0.0")]
641 impl<'a> Write for &'a File {
642 fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
643 self.inner.write(buf)
645 fn flush(&mut self) -> io::Result<()> { self.inner.flush() }
647 #[stable(feature = "rust1", since = "1.0.0")]
648 impl<'a> Seek for &'a File {
649 fn seek(&mut self, pos: SeekFrom) -> io::Result<u64> {
655 /// Creates a blank new set of options ready for configuration.
657 /// All options are initially set to `false`.
662 /// use std::fs::OpenOptions;
664 /// let mut options = OpenOptions::new();
665 /// let file = options.read(true).open("foo.txt");
667 #[stable(feature = "rust1", since = "1.0.0")]
668 pub fn new() -> OpenOptions {
669 OpenOptions(fs_imp::OpenOptions::new())
672 /// Sets the option for read access.
674 /// This option, when true, will indicate that the file should be
675 /// `read`-able if opened.
680 /// use std::fs::OpenOptions;
682 /// let file = OpenOptions::new().read(true).open("foo.txt");
684 #[stable(feature = "rust1", since = "1.0.0")]
685 pub fn read(&mut self, read: bool) -> &mut OpenOptions {
686 self.0.read(read); self
689 /// Sets the option for write access.
691 /// This option, when true, will indicate that the file should be
692 /// `write`-able if opened.
694 /// If the file already exists, any write calls on it will overwrite its
695 /// contents, without truncating it.
700 /// use std::fs::OpenOptions;
702 /// let file = OpenOptions::new().write(true).open("foo.txt");
704 #[stable(feature = "rust1", since = "1.0.0")]
705 pub fn write(&mut self, write: bool) -> &mut OpenOptions {
706 self.0.write(write); self
709 /// Sets the option for the append mode.
711 /// This option, when true, means that writes will append to a file instead
712 /// of overwriting previous contents.
713 /// Note that setting `.write(true).append(true)` has the same effect as
714 /// setting only `.append(true)`.
716 /// For most filesystems, the operating system guarantees that all writes are
717 /// atomic: no writes get mangled because another process writes at the same
720 /// One maybe obvious note when using append-mode: make sure that all data
721 /// that belongs together is written to the file in one operation. This
722 /// can be done by concatenating strings before passing them to [`write()`],
723 /// or using a buffered writer (with a buffer of adequate size),
724 /// and calling [`flush()`] when the message is complete.
726 /// If a file is opened with both read and append access, beware that after
727 /// opening, and after every write, the position for reading may be set at the
728 /// end of the file. So, before writing, save the current position (using
729 /// [`seek`]`(`[`SeekFrom`]`::`[`Current`]`(0))`, and restore it before the next read.
733 /// This function doesn't create the file if it doesn't exist. Use the [`create`]
736 /// [`write()`]: ../../std/fs/struct.File.html#method.write
737 /// [`flush()`]: ../../std/fs/struct.File.html#method.flush
738 /// [`seek`]: ../../std/fs/struct.File.html#method.seek
739 /// [`SeekFrom`]: ../../std/io/enum.SeekFrom.html
740 /// [`Current`]: ../../std/io/enum.SeekFrom.html#variant.Current
741 /// [`create`]: #method.create
746 /// use std::fs::OpenOptions;
748 /// let file = OpenOptions::new().append(true).open("foo.txt");
750 #[stable(feature = "rust1", since = "1.0.0")]
751 pub fn append(&mut self, append: bool) -> &mut OpenOptions {
752 self.0.append(append); self
755 /// Sets the option for truncating a previous file.
757 /// If a file is successfully opened with this option set it will truncate
758 /// the file to 0 length if it already exists.
760 /// The file must be opened with write access for truncate to work.
765 /// use std::fs::OpenOptions;
767 /// let file = OpenOptions::new().write(true).truncate(true).open("foo.txt");
769 #[stable(feature = "rust1", since = "1.0.0")]
770 pub fn truncate(&mut self, truncate: bool) -> &mut OpenOptions {
771 self.0.truncate(truncate); self
774 /// Sets the option for creating a new file.
776 /// This option indicates whether a new file will be created if the file
777 /// does not yet already exist.
779 /// In order for the file to be created, [`write`] or [`append`] access must
782 /// [`write`]: #method.write
783 /// [`append`]: #method.append
788 /// use std::fs::OpenOptions;
790 /// let file = OpenOptions::new().write(true).create(true).open("foo.txt");
792 #[stable(feature = "rust1", since = "1.0.0")]
793 pub fn create(&mut self, create: bool) -> &mut OpenOptions {
794 self.0.create(create); self
797 /// Sets the option to always create a new file.
799 /// This option indicates whether a new file will be created.
800 /// No file is allowed to exist at the target location, also no (dangling)
803 /// This option is useful because it is atomic. Otherwise between checking
804 /// whether a file exists and creating a new one, the file may have been
805 /// created by another process (a TOCTOU race condition / attack).
807 /// If `.create_new(true)` is set, [`.create()`] and [`.truncate()`] are
810 /// The file must be opened with write or append access in order to create
813 /// [`.create()`]: #method.create
814 /// [`.truncate()`]: #method.truncate
819 /// use std::fs::OpenOptions;
821 /// let file = OpenOptions::new().write(true)
822 /// .create_new(true)
823 /// .open("foo.txt");
825 #[stable(feature = "expand_open_options2", since = "1.9.0")]
826 pub fn create_new(&mut self, create_new: bool) -> &mut OpenOptions {
827 self.0.create_new(create_new); self
830 /// Opens a file at `path` with the options specified by `self`.
834 /// This function will return an error under a number of different
835 /// circumstances. Some of these error conditions are listed here, together
836 /// with their [`ErrorKind`]. The mapping to [`ErrorKind`]s is not part of
837 /// the compatibility contract of the function, especially the `Other` kind
838 /// might change to more specific kinds in the future.
840 /// * [`NotFound`]: The specified file does not exist and neither `create`
841 /// or `create_new` is set.
842 /// * [`NotFound`]: One of the directory components of the file path does
844 /// * [`PermissionDenied`]: The user lacks permission to get the specified
845 /// access rights for the file.
846 /// * [`PermissionDenied`]: The user lacks permission to open one of the
847 /// directory components of the specified path.
848 /// * [`AlreadyExists`]: `create_new` was specified and the file already
850 /// * [`InvalidInput`]: Invalid combinations of open options (truncate
851 /// without write access, no access mode set, etc.).
852 /// * [`Other`]: One of the directory components of the specified file path
853 /// was not, in fact, a directory.
854 /// * [`Other`]: Filesystem-level errors: full disk, write permission
855 /// requested on a read-only file system, exceeded disk quota, too many
856 /// open files, too long filename, too many symbolic links in the
857 /// specified path (Unix-like systems only), etc.
862 /// use std::fs::OpenOptions;
864 /// let file = OpenOptions::new().open("foo.txt");
867 /// [`ErrorKind`]: ../io/enum.ErrorKind.html
868 /// [`AlreadyExists`]: ../io/enum.ErrorKind.html#variant.AlreadyExists
869 /// [`InvalidInput`]: ../io/enum.ErrorKind.html#variant.InvalidInput
870 /// [`NotFound`]: ../io/enum.ErrorKind.html#variant.NotFound
871 /// [`Other`]: ../io/enum.ErrorKind.html#variant.Other
872 /// [`PermissionDenied`]: ../io/enum.ErrorKind.html#variant.PermissionDenied
873 #[stable(feature = "rust1", since = "1.0.0")]
874 pub fn open<P: AsRef<Path>>(&self, path: P) -> io::Result<File> {
875 self._open(path.as_ref())
878 fn _open(&self, path: &Path) -> io::Result<File> {
879 let inner = fs_imp::File::open(path, &self.0)?;
880 Ok(File { inner: inner })
884 impl AsInnerMut<fs_imp::OpenOptions> for OpenOptions {
885 fn as_inner_mut(&mut self) -> &mut fs_imp::OpenOptions { &mut self.0 }
889 /// Returns the file type for this metadata.
894 /// fn main() -> std::io::Result<()> {
897 /// let metadata = fs::metadata("foo.txt")?;
899 /// println!("{:?}", metadata.file_type());
903 #[stable(feature = "file_type", since = "1.1.0")]
904 pub fn file_type(&self) -> FileType {
905 FileType(self.0.file_type())
908 /// Returns whether this metadata is for a directory. The
909 /// result is mutually exclusive to the result of
910 /// [`is_file`], and will be false for symlink metadata
911 /// obtained from [`symlink_metadata`].
913 /// [`is_file`]: struct.Metadata.html#method.is_file
914 /// [`symlink_metadata`]: fn.symlink_metadata.html
919 /// fn main() -> std::io::Result<()> {
922 /// let metadata = fs::metadata("foo.txt")?;
924 /// assert!(!metadata.is_dir());
928 #[stable(feature = "rust1", since = "1.0.0")]
929 pub fn is_dir(&self) -> bool { self.file_type().is_dir() }
931 /// Returns whether this metadata is for a regular file. The
932 /// result is mutually exclusive to the result of
933 /// [`is_dir`], and will be false for symlink metadata
934 /// obtained from [`symlink_metadata`].
936 /// [`is_dir`]: struct.Metadata.html#method.is_dir
937 /// [`symlink_metadata`]: fn.symlink_metadata.html
944 /// fn main() -> std::io::Result<()> {
945 /// let metadata = fs::metadata("foo.txt")?;
947 /// assert!(metadata.is_file());
951 #[stable(feature = "rust1", since = "1.0.0")]
952 pub fn is_file(&self) -> bool { self.file_type().is_file() }
954 /// Returns the size of the file, in bytes, this metadata is for.
961 /// fn main() -> std::io::Result<()> {
962 /// let metadata = fs::metadata("foo.txt")?;
964 /// assert_eq!(0, metadata.len());
968 #[stable(feature = "rust1", since = "1.0.0")]
969 pub fn len(&self) -> u64 { self.0.size() }
971 /// Returns the permissions of the file this metadata is for.
978 /// fn main() -> std::io::Result<()> {
979 /// let metadata = fs::metadata("foo.txt")?;
981 /// assert!(!metadata.permissions().readonly());
985 #[stable(feature = "rust1", since = "1.0.0")]
986 pub fn permissions(&self) -> Permissions {
987 Permissions(self.0.perm())
990 /// Returns the last modification time listed in this metadata.
992 /// The returned value corresponds to the `mtime` field of `stat` on Unix
993 /// platforms and the `ftLastWriteTime` field on Windows platforms.
997 /// This field may not be available on all platforms, and will return an
998 /// `Err` on platforms where it is not available.
1005 /// fn main() -> std::io::Result<()> {
1006 /// let metadata = fs::metadata("foo.txt")?;
1008 /// if let Ok(time) = metadata.modified() {
1009 /// println!("{:?}", time);
1011 /// println!("Not supported on this platform");
1016 #[stable(feature = "fs_time", since = "1.10.0")]
1017 pub fn modified(&self) -> io::Result<SystemTime> {
1018 self.0.modified().map(FromInner::from_inner)
1021 /// Returns the last access time of this metadata.
1023 /// The returned value corresponds to the `atime` field of `stat` on Unix
1024 /// platforms and the `ftLastAccessTime` field on Windows platforms.
1026 /// Note that not all platforms will keep this field update in a file's
1027 /// metadata, for example Windows has an option to disable updating this
1028 /// time when files are accessed and Linux similarly has `noatime`.
1032 /// This field may not be available on all platforms, and will return an
1033 /// `Err` on platforms where it is not available.
1040 /// fn main() -> std::io::Result<()> {
1041 /// let metadata = fs::metadata("foo.txt")?;
1043 /// if let Ok(time) = metadata.accessed() {
1044 /// println!("{:?}", time);
1046 /// println!("Not supported on this platform");
1051 #[stable(feature = "fs_time", since = "1.10.0")]
1052 pub fn accessed(&self) -> io::Result<SystemTime> {
1053 self.0.accessed().map(FromInner::from_inner)
1056 /// Returns the creation time listed in this metadata.
1058 /// The returned value corresponds to the `birthtime` field of `stat` on
1059 /// Unix platforms and the `ftCreationTime` field on Windows platforms.
1063 /// This field may not be available on all platforms, and will return an
1064 /// `Err` on platforms where it is not available.
1071 /// fn main() -> std::io::Result<()> {
1072 /// let metadata = fs::metadata("foo.txt")?;
1074 /// if let Ok(time) = metadata.created() {
1075 /// println!("{:?}", time);
1077 /// println!("Not supported on this platform");
1082 #[stable(feature = "fs_time", since = "1.10.0")]
1083 pub fn created(&self) -> io::Result<SystemTime> {
1084 self.0.created().map(FromInner::from_inner)
1088 #[stable(feature = "std_debug", since = "1.16.0")]
1089 impl fmt::Debug for Metadata {
1090 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1091 f.debug_struct("Metadata")
1092 .field("file_type", &self.file_type())
1093 .field("is_dir", &self.is_dir())
1094 .field("is_file", &self.is_file())
1095 .field("permissions", &self.permissions())
1096 .field("modified", &self.modified())
1097 .field("accessed", &self.accessed())
1098 .field("created", &self.created())
1103 impl AsInner<fs_imp::FileAttr> for Metadata {
1104 fn as_inner(&self) -> &fs_imp::FileAttr { &self.0 }
1108 /// Returns whether these permissions describe a readonly (unwritable) file.
1113 /// use std::fs::File;
1115 /// fn main() -> std::io::Result<()> {
1116 /// let mut f = File::create("foo.txt")?;
1117 /// let metadata = f.metadata()?;
1119 /// assert_eq!(false, metadata.permissions().readonly());
1123 #[stable(feature = "rust1", since = "1.0.0")]
1124 pub fn readonly(&self) -> bool { self.0.readonly() }
1126 /// Modifies the readonly flag for this set of permissions. If the
1127 /// `readonly` argument is `true`, using the resulting `Permission` will
1128 /// update file permissions to forbid writing. Conversely, if it's `false`,
1129 /// using the resulting `Permission` will update file permissions to allow
1132 /// This operation does **not** modify the filesystem. To modify the
1133 /// filesystem use the `fs::set_permissions` function.
1138 /// use std::fs::File;
1140 /// fn main() -> std::io::Result<()> {
1141 /// let f = File::create("foo.txt")?;
1142 /// let metadata = f.metadata()?;
1143 /// let mut permissions = metadata.permissions();
1145 /// permissions.set_readonly(true);
1147 /// // filesystem doesn't change
1148 /// assert_eq!(false, metadata.permissions().readonly());
1150 /// // just this particular `permissions`.
1151 /// assert_eq!(true, permissions.readonly());
1155 #[stable(feature = "rust1", since = "1.0.0")]
1156 pub fn set_readonly(&mut self, readonly: bool) {
1157 self.0.set_readonly(readonly)
1162 /// Test whether this file type represents a directory. The
1163 /// result is mutually exclusive to the results of
1164 /// [`is_file`] and [`is_symlink`]; only zero or one of these
1167 /// [`is_file`]: struct.FileType.html#method.is_file
1168 /// [`is_symlink`]: struct.FileType.html#method.is_symlink
1173 /// fn main() -> std::io::Result<()> {
1176 /// let metadata = fs::metadata("foo.txt")?;
1177 /// let file_type = metadata.file_type();
1179 /// assert_eq!(file_type.is_dir(), false);
1183 #[stable(feature = "file_type", since = "1.1.0")]
1184 pub fn is_dir(&self) -> bool { self.0.is_dir() }
1186 /// Test whether this file type represents a regular file.
1187 /// The result is mutually exclusive to the results of
1188 /// [`is_dir`] and [`is_symlink`]; only zero or one of these
1191 /// [`is_dir`]: struct.FileType.html#method.is_dir
1192 /// [`is_symlink`]: struct.FileType.html#method.is_symlink
1197 /// fn main() -> std::io::Result<()> {
1200 /// let metadata = fs::metadata("foo.txt")?;
1201 /// let file_type = metadata.file_type();
1203 /// assert_eq!(file_type.is_file(), true);
1207 #[stable(feature = "file_type", since = "1.1.0")]
1208 pub fn is_file(&self) -> bool { self.0.is_file() }
1210 /// Test whether this file type represents a symbolic link.
1211 /// The result is mutually exclusive to the results of
1212 /// [`is_dir`] and [`is_file`]; only zero or one of these
1215 /// The underlying [`Metadata`] struct needs to be retrieved
1216 /// with the [`fs::symlink_metadata`] function and not the
1217 /// [`fs::metadata`] function. The [`fs::metadata`] function
1218 /// follows symbolic links, so [`is_symlink`] would always
1219 /// return false for the target file.
1221 /// [`Metadata`]: struct.Metadata.html
1222 /// [`fs::metadata`]: fn.metadata.html
1223 /// [`fs::symlink_metadata`]: fn.symlink_metadata.html
1224 /// [`is_dir`]: struct.FileType.html#method.is_dir
1225 /// [`is_file`]: struct.FileType.html#method.is_file
1226 /// [`is_symlink`]: struct.FileType.html#method.is_symlink
1233 /// fn main() -> std::io::Result<()> {
1234 /// let metadata = fs::symlink_metadata("foo.txt")?;
1235 /// let file_type = metadata.file_type();
1237 /// assert_eq!(file_type.is_symlink(), false);
1241 #[stable(feature = "file_type", since = "1.1.0")]
1242 pub fn is_symlink(&self) -> bool { self.0.is_symlink() }
1245 impl AsInner<fs_imp::FileType> for FileType {
1246 fn as_inner(&self) -> &fs_imp::FileType { &self.0 }
1249 impl FromInner<fs_imp::FilePermissions> for Permissions {
1250 fn from_inner(f: fs_imp::FilePermissions) -> Permissions {
1255 impl AsInner<fs_imp::FilePermissions> for Permissions {
1256 fn as_inner(&self) -> &fs_imp::FilePermissions { &self.0 }
1259 #[stable(feature = "rust1", since = "1.0.0")]
1260 impl Iterator for ReadDir {
1261 type Item = io::Result<DirEntry>;
1263 fn next(&mut self) -> Option<io::Result<DirEntry>> {
1264 self.0.next().map(|entry| entry.map(DirEntry))
1269 /// Returns the full path to the file that this entry represents.
1271 /// The full path is created by joining the original path to `read_dir`
1272 /// with the filename of this entry.
1279 /// fn main() -> std::io::Result<()> {
1280 /// for entry in fs::read_dir(".")? {
1281 /// let dir = entry?;
1282 /// println!("{:?}", dir.path());
1288 /// This prints output like:
1291 /// "./whatever.txt"
1293 /// "./hello_world.rs"
1296 /// The exact text, of course, depends on what files you have in `.`.
1297 #[stable(feature = "rust1", since = "1.0.0")]
1298 pub fn path(&self) -> PathBuf { self.0.path() }
1300 /// Return the metadata for the file that this entry points at.
1302 /// This function will not traverse symlinks if this entry points at a
1305 /// # Platform-specific behavior
1307 /// On Windows this function is cheap to call (no extra system calls
1308 /// needed), but on Unix platforms this function is the equivalent of
1309 /// calling `symlink_metadata` on the path.
1316 /// if let Ok(entries) = fs::read_dir(".") {
1317 /// for entry in entries {
1318 /// if let Ok(entry) = entry {
1319 /// // Here, `entry` is a `DirEntry`.
1320 /// if let Ok(metadata) = entry.metadata() {
1321 /// // Now let's show our entry's permissions!
1322 /// println!("{:?}: {:?}", entry.path(), metadata.permissions());
1324 /// println!("Couldn't get metadata for {:?}", entry.path());
1330 #[stable(feature = "dir_entry_ext", since = "1.1.0")]
1331 pub fn metadata(&self) -> io::Result<Metadata> {
1332 self.0.metadata().map(Metadata)
1335 /// Return the file type for the file that this entry points at.
1337 /// This function will not traverse symlinks if this entry points at a
1340 /// # Platform-specific behavior
1342 /// On Windows and most Unix platforms this function is free (no extra
1343 /// system calls needed), but some Unix platforms may require the equivalent
1344 /// call to `symlink_metadata` to learn about the target file type.
1351 /// if let Ok(entries) = fs::read_dir(".") {
1352 /// for entry in entries {
1353 /// if let Ok(entry) = entry {
1354 /// // Here, `entry` is a `DirEntry`.
1355 /// if let Ok(file_type) = entry.file_type() {
1356 /// // Now let's show our entry's file type!
1357 /// println!("{:?}: {:?}", entry.path(), file_type);
1359 /// println!("Couldn't get file type for {:?}", entry.path());
1365 #[stable(feature = "dir_entry_ext", since = "1.1.0")]
1366 pub fn file_type(&self) -> io::Result<FileType> {
1367 self.0.file_type().map(FileType)
1370 /// Returns the bare file name of this directory entry without any other
1371 /// leading path component.
1378 /// if let Ok(entries) = fs::read_dir(".") {
1379 /// for entry in entries {
1380 /// if let Ok(entry) = entry {
1381 /// // Here, `entry` is a `DirEntry`.
1382 /// println!("{:?}", entry.file_name());
1387 #[stable(feature = "dir_entry_ext", since = "1.1.0")]
1388 pub fn file_name(&self) -> OsString {
1393 #[stable(feature = "dir_entry_debug", since = "1.13.0")]
1394 impl fmt::Debug for DirEntry {
1395 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1396 f.debug_tuple("DirEntry")
1397 .field(&self.path())
1402 impl AsInner<fs_imp::DirEntry> for DirEntry {
1403 fn as_inner(&self) -> &fs_imp::DirEntry { &self.0 }
1406 /// Removes a file from the filesystem.
1408 /// Note that there is no
1409 /// guarantee that the file is immediately deleted (e.g. depending on
1410 /// platform, other open file descriptors may prevent immediate removal).
1412 /// # Platform-specific behavior
1414 /// This function currently corresponds to the `unlink` function on Unix
1415 /// and the `DeleteFile` function on Windows.
1416 /// Note that, this [may change in the future][changes].
1418 /// [changes]: ../io/index.html#platform-specific-behavior
1422 /// This function will return an error in the following situations, but is not
1423 /// limited to just these cases:
1425 /// * `path` points to a directory.
1426 /// * The user lacks permissions to remove the file.
1433 /// fn main() -> std::io::Result<()> {
1434 /// fs::remove_file("a.txt")?;
1438 #[stable(feature = "rust1", since = "1.0.0")]
1439 pub fn remove_file<P: AsRef<Path>>(path: P) -> io::Result<()> {
1440 fs_imp::unlink(path.as_ref())
1443 /// Given a path, query the file system to get information about a file,
1446 /// This function will traverse symbolic links to query information about the
1447 /// destination file.
1449 /// # Platform-specific behavior
1451 /// This function currently corresponds to the `stat` function on Unix
1452 /// and the `GetFileAttributesEx` function on Windows.
1453 /// Note that, this [may change in the future][changes].
1455 /// [changes]: ../io/index.html#platform-specific-behavior
1459 /// This function will return an error in the following situations, but is not
1460 /// limited to just these cases:
1462 /// * The user lacks permissions to perform `metadata` call on `path`.
1463 /// * `path` does not exist.
1470 /// fn main() -> std::io::Result<()> {
1471 /// let attr = fs::metadata("/some/file/path.txt")?;
1472 /// // inspect attr ...
1476 #[stable(feature = "rust1", since = "1.0.0")]
1477 pub fn metadata<P: AsRef<Path>>(path: P) -> io::Result<Metadata> {
1478 fs_imp::stat(path.as_ref()).map(Metadata)
1481 /// Query the metadata about a file without following symlinks.
1483 /// # Platform-specific behavior
1485 /// This function currently corresponds to the `lstat` function on Unix
1486 /// and the `GetFileAttributesEx` function on Windows.
1487 /// Note that, this [may change in the future][changes].
1489 /// [changes]: ../io/index.html#platform-specific-behavior
1493 /// This function will return an error in the following situations, but is not
1494 /// limited to just these cases:
1496 /// * The user lacks permissions to perform `metadata` call on `path`.
1497 /// * `path` does not exist.
1504 /// fn main() -> std::io::Result<()> {
1505 /// let attr = fs::symlink_metadata("/some/file/path.txt")?;
1506 /// // inspect attr ...
1510 #[stable(feature = "symlink_metadata", since = "1.1.0")]
1511 pub fn symlink_metadata<P: AsRef<Path>>(path: P) -> io::Result<Metadata> {
1512 fs_imp::lstat(path.as_ref()).map(Metadata)
1515 /// Rename a file or directory to a new name, replacing the original file if
1516 /// `to` already exists.
1518 /// This will not work if the new name is on a different mount point.
1520 /// # Platform-specific behavior
1522 /// This function currently corresponds to the `rename` function on Unix
1523 /// and the `MoveFileEx` function with the `MOVEFILE_REPLACE_EXISTING` flag on Windows.
1525 /// Because of this, the behavior when both `from` and `to` exist differs. On
1526 /// Unix, if `from` is a directory, `to` must also be an (empty) directory. If
1527 /// `from` is not a directory, `to` must also be not a directory. In contrast,
1528 /// on Windows, `from` can be anything, but `to` must *not* be a directory.
1530 /// Note that, this [may change in the future][changes].
1532 /// [changes]: ../io/index.html#platform-specific-behavior
1536 /// This function will return an error in the following situations, but is not
1537 /// limited to just these cases:
1539 /// * `from` does not exist.
1540 /// * The user lacks permissions to view contents.
1541 /// * `from` and `to` are on separate filesystems.
1548 /// fn main() -> std::io::Result<()> {
1549 /// fs::rename("a.txt", "b.txt")?; // Rename a.txt to b.txt
1553 #[stable(feature = "rust1", since = "1.0.0")]
1554 pub fn rename<P: AsRef<Path>, Q: AsRef<Path>>(from: P, to: Q) -> io::Result<()> {
1555 fs_imp::rename(from.as_ref(), to.as_ref())
1558 /// Copies the contents of one file to another. This function will also
1559 /// copy the permission bits of the original file to the destination file.
1561 /// This function will **overwrite** the contents of `to`.
1563 /// Note that if `from` and `to` both point to the same file, then the file
1564 /// will likely get truncated by this operation.
1566 /// On success, the total number of bytes copied is returned and it is equal to
1567 /// the length of the `to` file as reported by `metadata`.
1569 /// # Platform-specific behavior
1571 /// This function currently corresponds to the `open` function in Unix
1572 /// with `O_RDONLY` for `from` and `O_WRONLY`, `O_CREAT`, and `O_TRUNC` for `to`.
1573 /// `O_CLOEXEC` is set for returned file descriptors.
1574 /// On Windows, this function currently corresponds to `CopyFileEx`. Alternate
1575 /// NTFS streams are copied but only the size of the main stream is returned by
1577 /// Note that, this [may change in the future][changes].
1579 /// [changes]: ../io/index.html#platform-specific-behavior
1583 /// This function will return an error in the following situations, but is not
1584 /// limited to just these cases:
1586 /// * The `from` path is not a file.
1587 /// * The `from` file does not exist.
1588 /// * The current process does not have the permission rights to access
1589 /// `from` or write `to`.
1596 /// fn main() -> std::io::Result<()> {
1597 /// fs::copy("foo.txt", "bar.txt")?; // Copy foo.txt to bar.txt
1601 #[stable(feature = "rust1", since = "1.0.0")]
1602 pub fn copy<P: AsRef<Path>, Q: AsRef<Path>>(from: P, to: Q) -> io::Result<u64> {
1603 fs_imp::copy(from.as_ref(), to.as_ref())
1606 /// Creates a new hard link on the filesystem.
1608 /// The `dst` path will be a link pointing to the `src` path. Note that systems
1609 /// often require these two paths to both be located on the same filesystem.
1611 /// # Platform-specific behavior
1613 /// This function currently corresponds to the `link` function on Unix
1614 /// and the `CreateHardLink` function on Windows.
1615 /// Note that, this [may change in the future][changes].
1617 /// [changes]: ../io/index.html#platform-specific-behavior
1621 /// This function will return an error in the following situations, but is not
1622 /// limited to just these cases:
1624 /// * The `src` path is not a file or doesn't exist.
1631 /// fn main() -> std::io::Result<()> {
1632 /// fs::hard_link("a.txt", "b.txt")?; // Hard link a.txt to b.txt
1636 #[stable(feature = "rust1", since = "1.0.0")]
1637 pub fn hard_link<P: AsRef<Path>, Q: AsRef<Path>>(src: P, dst: Q) -> io::Result<()> {
1638 fs_imp::link(src.as_ref(), dst.as_ref())
1641 /// Creates a new symbolic link on the filesystem.
1643 /// The `dst` path will be a symbolic link pointing to the `src` path.
1644 /// On Windows, this will be a file symlink, not a directory symlink;
1645 /// for this reason, the platform-specific `std::os::unix::fs::symlink`
1646 /// and `std::os::windows::fs::{symlink_file, symlink_dir}` should be
1647 /// used instead to make the intent explicit.
1654 /// fn main() -> std::io::Result<()> {
1655 /// fs::soft_link("a.txt", "b.txt")?;
1659 #[stable(feature = "rust1", since = "1.0.0")]
1660 #[rustc_deprecated(since = "1.1.0",
1661 reason = "replaced with std::os::unix::fs::symlink and \
1662 std::os::windows::fs::{symlink_file, symlink_dir}")]
1663 pub fn soft_link<P: AsRef<Path>, Q: AsRef<Path>>(src: P, dst: Q) -> io::Result<()> {
1664 fs_imp::symlink(src.as_ref(), dst.as_ref())
1667 /// Reads a symbolic link, returning the file that the link points to.
1669 /// # Platform-specific behavior
1671 /// This function currently corresponds to the `readlink` function on Unix
1672 /// and the `CreateFile` function with `FILE_FLAG_OPEN_REPARSE_POINT` and
1673 /// `FILE_FLAG_BACKUP_SEMANTICS` flags on Windows.
1674 /// Note that, this [may change in the future][changes].
1676 /// [changes]: ../io/index.html#platform-specific-behavior
1680 /// This function will return an error in the following situations, but is not
1681 /// limited to just these cases:
1683 /// * `path` is not a symbolic link.
1684 /// * `path` does not exist.
1691 /// fn main() -> std::io::Result<()> {
1692 /// let path = fs::read_link("a.txt")?;
1696 #[stable(feature = "rust1", since = "1.0.0")]
1697 pub fn read_link<P: AsRef<Path>>(path: P) -> io::Result<PathBuf> {
1698 fs_imp::readlink(path.as_ref())
1701 /// Returns the canonical, absolute form of a path with all intermediate
1702 /// components normalized and symbolic links resolved.
1704 /// # Platform-specific behavior
1706 /// This function currently corresponds to the `realpath` function on Unix
1707 /// and the `CreateFile` and `GetFinalPathNameByHandle` functions on Windows.
1708 /// Note that, this [may change in the future][changes].
1710 /// On Windows, this converts the path to use [extended length path][path]
1711 /// syntax, which allows your program to use longer path names, but means you
1712 /// can only join backslash-delimited paths to it, and it may be incompatible
1713 /// with other applications (if passed to the application on the command-line,
1714 /// or written to a file another application may read).
1716 /// [changes]: ../io/index.html#platform-specific-behavior
1717 /// [path]: https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85).aspx#maxpath
1721 /// This function will return an error in the following situations, but is not
1722 /// limited to just these cases:
1724 /// * `path` does not exist.
1725 /// * A component in path is not a directory.
1732 /// fn main() -> std::io::Result<()> {
1733 /// let path = fs::canonicalize("../a/../foo.txt")?;
1737 #[stable(feature = "fs_canonicalize", since = "1.5.0")]
1738 pub fn canonicalize<P: AsRef<Path>>(path: P) -> io::Result<PathBuf> {
1739 fs_imp::canonicalize(path.as_ref())
1742 /// Creates a new, empty directory at the provided path
1744 /// # Platform-specific behavior
1746 /// This function currently corresponds to the `mkdir` function on Unix
1747 /// and the `CreateDirectory` function on Windows.
1748 /// Note that, this [may change in the future][changes].
1750 /// [changes]: ../io/index.html#platform-specific-behavior
1754 /// This function will return an error in the following situations, but is not
1755 /// limited to just these cases:
1757 /// * User lacks permissions to create directory at `path`.
1758 /// * `path` already exists.
1765 /// fn main() -> std::io::Result<()> {
1766 /// fs::create_dir("/some/dir")?;
1770 #[stable(feature = "rust1", since = "1.0.0")]
1771 pub fn create_dir<P: AsRef<Path>>(path: P) -> io::Result<()> {
1772 DirBuilder::new().create(path.as_ref())
1775 /// Recursively create a directory and all of its parent components if they
1778 /// # Platform-specific behavior
1780 /// This function currently corresponds to the `mkdir` function on Unix
1781 /// and the `CreateDirectory` function on Windows.
1782 /// Note that, this [may change in the future][changes].
1784 /// [changes]: ../io/index.html#platform-specific-behavior
1788 /// This function will return an error in the following situations, but is not
1789 /// limited to just these cases:
1791 /// * If any directory in the path specified by `path`
1792 /// does not already exist and it could not be created otherwise. The specific
1793 /// error conditions for when a directory is being created (after it is
1794 /// determined to not exist) are outlined by `fs::create_dir`.
1796 /// Notable exception is made for situations where any of the directories
1797 /// specified in the `path` could not be created as it was being created concurrently.
1798 /// Such cases are considered to be successful. That is, calling `create_dir_all`
1799 /// concurrently from multiple threads or processes is guaranteed not to fail
1800 /// due to a race condition with itself.
1807 /// fn main() -> std::io::Result<()> {
1808 /// fs::create_dir_all("/some/dir")?;
1812 #[stable(feature = "rust1", since = "1.0.0")]
1813 pub fn create_dir_all<P: AsRef<Path>>(path: P) -> io::Result<()> {
1814 DirBuilder::new().recursive(true).create(path.as_ref())
1817 /// Removes an existing, empty directory.
1819 /// # Platform-specific behavior
1821 /// This function currently corresponds to the `rmdir` function on Unix
1822 /// and the `RemoveDirectory` function on Windows.
1823 /// Note that, this [may change in the future][changes].
1825 /// [changes]: ../io/index.html#platform-specific-behavior
1829 /// This function will return an error in the following situations, but is not
1830 /// limited to just these cases:
1832 /// * The user lacks permissions to remove the directory at the provided `path`.
1833 /// * The directory isn't empty.
1840 /// fn main() -> std::io::Result<()> {
1841 /// fs::remove_dir("/some/dir")?;
1845 #[stable(feature = "rust1", since = "1.0.0")]
1846 pub fn remove_dir<P: AsRef<Path>>(path: P) -> io::Result<()> {
1847 fs_imp::rmdir(path.as_ref())
1850 /// Removes a directory at this path, after removing all its contents. Use
1853 /// This function does **not** follow symbolic links and it will simply remove the
1854 /// symbolic link itself.
1856 /// # Platform-specific behavior
1858 /// This function currently corresponds to `opendir`, `lstat`, `rm` and `rmdir` functions on Unix
1859 /// and the `FindFirstFile`, `GetFileAttributesEx`, `DeleteFile`, and `RemoveDirectory` functions
1861 /// Note that, this [may change in the future][changes].
1863 /// [changes]: ../io/index.html#platform-specific-behavior
1867 /// See `file::remove_file` and `fs::remove_dir`.
1874 /// fn main() -> std::io::Result<()> {
1875 /// fs::remove_dir_all("/some/dir")?;
1879 #[stable(feature = "rust1", since = "1.0.0")]
1880 pub fn remove_dir_all<P: AsRef<Path>>(path: P) -> io::Result<()> {
1881 fs_imp::remove_dir_all(path.as_ref())
1884 /// Returns an iterator over the entries within a directory.
1886 /// The iterator will yield instances of [`io::Result`]`<`[`DirEntry`]`>`.
1887 /// New errors may be encountered after an iterator is initially constructed.
1889 /// [`io::Result`]: ../io/type.Result.html
1890 /// [`DirEntry`]: struct.DirEntry.html
1892 /// # Platform-specific behavior
1894 /// This function currently corresponds to the `opendir` function on Unix
1895 /// and the `FindFirstFile` function on Windows.
1896 /// Note that, this [may change in the future][changes].
1898 /// [changes]: ../io/index.html#platform-specific-behavior
1902 /// This function will return an error in the following situations, but is not
1903 /// limited to just these cases:
1905 /// * The provided `path` doesn't exist.
1906 /// * The process lacks permissions to view the contents.
1907 /// * The `path` points at a non-directory file.
1913 /// use std::fs::{self, DirEntry};
1914 /// use std::path::Path;
1916 /// // one possible implementation of walking a directory only visiting files
1917 /// fn visit_dirs(dir: &Path, cb: &Fn(&DirEntry)) -> io::Result<()> {
1918 /// if dir.is_dir() {
1919 /// for entry in fs::read_dir(dir)? {
1920 /// let entry = entry?;
1921 /// let path = entry.path();
1922 /// if path.is_dir() {
1923 /// visit_dirs(&path, cb)?;
1932 #[stable(feature = "rust1", since = "1.0.0")]
1933 pub fn read_dir<P: AsRef<Path>>(path: P) -> io::Result<ReadDir> {
1934 fs_imp::readdir(path.as_ref()).map(ReadDir)
1937 /// Changes the permissions found on a file or a directory.
1939 /// # Platform-specific behavior
1941 /// This function currently corresponds to the `chmod` function on Unix
1942 /// and the `SetFileAttributes` function on Windows.
1943 /// Note that, this [may change in the future][changes].
1945 /// [changes]: ../io/index.html#platform-specific-behavior
1949 /// This function will return an error in the following situations, but is not
1950 /// limited to just these cases:
1952 /// * `path` does not exist.
1953 /// * The user lacks the permission to change attributes of the file.
1960 /// fn main() -> std::io::Result<()> {
1961 /// let mut perms = fs::metadata("foo.txt")?.permissions();
1962 /// perms.set_readonly(true);
1963 /// fs::set_permissions("foo.txt", perms)?;
1967 #[stable(feature = "set_permissions", since = "1.1.0")]
1968 pub fn set_permissions<P: AsRef<Path>>(path: P, perm: Permissions)
1970 fs_imp::set_perm(path.as_ref(), perm.0)
1974 /// Creates a new set of options with default mode/security settings for all
1975 /// platforms and also non-recursive.
1980 /// use std::fs::DirBuilder;
1982 /// let builder = DirBuilder::new();
1984 #[stable(feature = "dir_builder", since = "1.6.0")]
1985 pub fn new() -> DirBuilder {
1987 inner: fs_imp::DirBuilder::new(),
1992 /// Indicates that directories should be created recursively, creating all
1993 /// parent directories. Parents that do not exist are created with the same
1994 /// security and permissions settings.
1996 /// This option defaults to `false`.
2001 /// use std::fs::DirBuilder;
2003 /// let mut builder = DirBuilder::new();
2004 /// builder.recursive(true);
2006 #[stable(feature = "dir_builder", since = "1.6.0")]
2007 pub fn recursive(&mut self, recursive: bool) -> &mut Self {
2008 self.recursive = recursive;
2012 /// Create the specified directory with the options configured in this
2015 /// It is considered an error if the directory already exists unless
2016 /// recursive mode is enabled.
2021 /// use std::fs::{self, DirBuilder};
2023 /// let path = "/tmp/foo/bar/baz";
2024 /// DirBuilder::new()
2025 /// .recursive(true)
2026 /// .create(path).unwrap();
2028 /// assert!(fs::metadata(path).unwrap().is_dir());
2030 #[stable(feature = "dir_builder", since = "1.6.0")]
2031 pub fn create<P: AsRef<Path>>(&self, path: P) -> io::Result<()> {
2032 self._create(path.as_ref())
2035 fn _create(&self, path: &Path) -> io::Result<()> {
2037 self.create_dir_all(path)
2039 self.inner.mkdir(path)
2043 fn create_dir_all(&self, path: &Path) -> io::Result<()> {
2044 if path == Path::new("") {
2048 match self.inner.mkdir(path) {
2049 Ok(()) => return Ok(()),
2050 Err(ref e) if e.kind() == io::ErrorKind::NotFound => {}
2051 Err(_) if path.is_dir() => return Ok(()),
2052 Err(e) => return Err(e),
2054 match path.parent() {
2055 Some(p) => try!(self.create_dir_all(p)),
2056 None => return Err(io::Error::new(io::ErrorKind::Other, "failed to create whole tree")),
2058 match self.inner.mkdir(path) {
2060 Err(_) if path.is_dir() => Ok(()),
2066 impl AsInnerMut<fs_imp::DirBuilder> for DirBuilder {
2067 fn as_inner_mut(&mut self) -> &mut fs_imp::DirBuilder {
2072 #[cfg(all(test, not(any(target_os = "cloudabi", target_os = "emscripten"))))]
2076 use fs::{self, File, OpenOptions};
2077 use io::{ErrorKind, SeekFrom};
2079 use rand::{StdRng, Rng};
2081 use sys_common::io::test::{TempDir, tmpdir};
2085 use os::windows::fs::{symlink_dir, symlink_file};
2087 use sys::fs::symlink_junction;
2089 use os::unix::fs::symlink as symlink_dir;
2091 use os::unix::fs::symlink as symlink_file;
2093 use os::unix::fs::symlink as symlink_junction;
2095 macro_rules! check { ($e:expr) => (
2098 Err(e) => panic!("{} failed with: {}", stringify!($e), e),
2103 macro_rules! error { ($e:expr, $s:expr) => (
2105 Ok(_) => panic!("Unexpected success. Should've been: {:?}", $s),
2106 Err(ref err) => assert!(err.raw_os_error() == Some($s),
2107 format!("`{}` did not have a code of `{}`", err, $s))
2112 macro_rules! error { ($e:expr, $s:expr) => ( error_contains!($e, $s) ) }
2114 macro_rules! error_contains { ($e:expr, $s:expr) => (
2116 Ok(_) => panic!("Unexpected success. Should've been: {:?}", $s),
2117 Err(ref err) => assert!(err.to_string().contains($s),
2118 format!("`{}` did not contain `{}`", err, $s))
2122 // Several test fail on windows if the user does not have permission to
2123 // create symlinks (the `SeCreateSymbolicLinkPrivilege`). Instead of
2124 // disabling these test on Windows, use this function to test whether we
2125 // have permission, and return otherwise. This way, we still don't run these
2126 // tests most of the time, but at least we do if the user has the right
2128 pub fn got_symlink_permission(tmpdir: &TempDir) -> bool {
2129 if cfg!(unix) { return true }
2130 let link = tmpdir.join("some_hopefully_unique_link_name");
2132 match symlink_file(r"nonexisting_target", link) {
2134 // ERROR_PRIVILEGE_NOT_HELD = 1314
2135 Err(ref err) if err.raw_os_error() == Some(1314) => false,
2141 fn file_test_io_smoke_test() {
2142 let message = "it's alright. have a good time";
2143 let tmpdir = tmpdir();
2144 let filename = &tmpdir.join("file_rt_io_file_test.txt");
2146 let mut write_stream = check!(File::create(filename));
2147 check!(write_stream.write(message.as_bytes()));
2150 let mut read_stream = check!(File::open(filename));
2151 let mut read_buf = [0; 1028];
2152 let read_str = match check!(read_stream.read(&mut read_buf)) {
2153 0 => panic!("shouldn't happen"),
2154 n => str::from_utf8(&read_buf[..n]).unwrap().to_string()
2156 assert_eq!(read_str, message);
2158 check!(fs::remove_file(filename));
2162 fn invalid_path_raises() {
2163 let tmpdir = tmpdir();
2164 let filename = &tmpdir.join("file_that_does_not_exist.txt");
2165 let result = File::open(filename);
2168 error!(result, "No such file or directory");
2170 error!(result, 2); // ERROR_FILE_NOT_FOUND
2174 fn file_test_iounlinking_invalid_path_should_raise_condition() {
2175 let tmpdir = tmpdir();
2176 let filename = &tmpdir.join("file_another_file_that_does_not_exist.txt");
2178 let result = fs::remove_file(filename);
2181 error!(result, "No such file or directory");
2183 error!(result, 2); // ERROR_FILE_NOT_FOUND
2187 fn file_test_io_non_positional_read() {
2188 let message: &str = "ten-four";
2189 let mut read_mem = [0; 8];
2190 let tmpdir = tmpdir();
2191 let filename = &tmpdir.join("file_rt_io_file_test_positional.txt");
2193 let mut rw_stream = check!(File::create(filename));
2194 check!(rw_stream.write(message.as_bytes()));
2197 let mut read_stream = check!(File::open(filename));
2199 let read_buf = &mut read_mem[0..4];
2200 check!(read_stream.read(read_buf));
2203 let read_buf = &mut read_mem[4..8];
2204 check!(read_stream.read(read_buf));
2207 check!(fs::remove_file(filename));
2208 let read_str = str::from_utf8(&read_mem).unwrap();
2209 assert_eq!(read_str, message);
2213 fn file_test_io_seek_and_tell_smoke_test() {
2214 let message = "ten-four";
2215 let mut read_mem = [0; 4];
2216 let set_cursor = 4 as u64;
2217 let tell_pos_pre_read;
2218 let tell_pos_post_read;
2219 let tmpdir = tmpdir();
2220 let filename = &tmpdir.join("file_rt_io_file_test_seeking.txt");
2222 let mut rw_stream = check!(File::create(filename));
2223 check!(rw_stream.write(message.as_bytes()));
2226 let mut read_stream = check!(File::open(filename));
2227 check!(read_stream.seek(SeekFrom::Start(set_cursor)));
2228 tell_pos_pre_read = check!(read_stream.seek(SeekFrom::Current(0)));
2229 check!(read_stream.read(&mut read_mem));
2230 tell_pos_post_read = check!(read_stream.seek(SeekFrom::Current(0)));
2232 check!(fs::remove_file(filename));
2233 let read_str = str::from_utf8(&read_mem).unwrap();
2234 assert_eq!(read_str, &message[4..8]);
2235 assert_eq!(tell_pos_pre_read, set_cursor);
2236 assert_eq!(tell_pos_post_read, message.len() as u64);
2240 fn file_test_io_seek_and_write() {
2241 let initial_msg = "food-is-yummy";
2242 let overwrite_msg = "-the-bar!!";
2243 let final_msg = "foo-the-bar!!";
2245 let mut read_mem = [0; 13];
2246 let tmpdir = tmpdir();
2247 let filename = &tmpdir.join("file_rt_io_file_test_seek_and_write.txt");
2249 let mut rw_stream = check!(File::create(filename));
2250 check!(rw_stream.write(initial_msg.as_bytes()));
2251 check!(rw_stream.seek(SeekFrom::Start(seek_idx)));
2252 check!(rw_stream.write(overwrite_msg.as_bytes()));
2255 let mut read_stream = check!(File::open(filename));
2256 check!(read_stream.read(&mut read_mem));
2258 check!(fs::remove_file(filename));
2259 let read_str = str::from_utf8(&read_mem).unwrap();
2260 assert!(read_str == final_msg);
2264 fn file_test_io_seek_shakedown() {
2266 let initial_msg = "qwer-asdf-zxcv";
2267 let chunk_one: &str = "qwer";
2268 let chunk_two: &str = "asdf";
2269 let chunk_three: &str = "zxcv";
2270 let mut read_mem = [0; 4];
2271 let tmpdir = tmpdir();
2272 let filename = &tmpdir.join("file_rt_io_file_test_seek_shakedown.txt");
2274 let mut rw_stream = check!(File::create(filename));
2275 check!(rw_stream.write(initial_msg.as_bytes()));
2278 let mut read_stream = check!(File::open(filename));
2280 check!(read_stream.seek(SeekFrom::End(-4)));
2281 check!(read_stream.read(&mut read_mem));
2282 assert_eq!(str::from_utf8(&read_mem).unwrap(), chunk_three);
2284 check!(read_stream.seek(SeekFrom::Current(-9)));
2285 check!(read_stream.read(&mut read_mem));
2286 assert_eq!(str::from_utf8(&read_mem).unwrap(), chunk_two);
2288 check!(read_stream.seek(SeekFrom::Start(0)));
2289 check!(read_stream.read(&mut read_mem));
2290 assert_eq!(str::from_utf8(&read_mem).unwrap(), chunk_one);
2292 check!(fs::remove_file(filename));
2296 fn file_test_io_eof() {
2297 let tmpdir = tmpdir();
2298 let filename = tmpdir.join("file_rt_io_file_test_eof.txt");
2299 let mut buf = [0; 256];
2301 let oo = OpenOptions::new().create_new(true).write(true).read(true).clone();
2302 let mut rw = check!(oo.open(&filename));
2303 assert_eq!(check!(rw.read(&mut buf)), 0);
2304 assert_eq!(check!(rw.read(&mut buf)), 0);
2306 check!(fs::remove_file(&filename));
2311 fn file_test_io_read_write_at() {
2312 use os::unix::fs::FileExt;
2314 let tmpdir = tmpdir();
2315 let filename = tmpdir.join("file_rt_io_file_test_read_write_at.txt");
2316 let mut buf = [0; 256];
2317 let write1 = "asdf";
2318 let write2 = "qwer-";
2319 let write3 = "-zxcv";
2320 let content = "qwer-asdf-zxcv";
2322 let oo = OpenOptions::new().create_new(true).write(true).read(true).clone();
2323 let mut rw = check!(oo.open(&filename));
2324 assert_eq!(check!(rw.write_at(write1.as_bytes(), 5)), write1.len());
2325 assert_eq!(check!(rw.seek(SeekFrom::Current(0))), 0);
2326 assert_eq!(check!(rw.read_at(&mut buf, 5)), write1.len());
2327 assert_eq!(str::from_utf8(&buf[..write1.len()]), Ok(write1));
2328 assert_eq!(check!(rw.seek(SeekFrom::Current(0))), 0);
2329 assert_eq!(check!(rw.read_at(&mut buf[..write2.len()], 0)), write2.len());
2330 assert_eq!(str::from_utf8(&buf[..write2.len()]), Ok("\0\0\0\0\0"));
2331 assert_eq!(check!(rw.seek(SeekFrom::Current(0))), 0);
2332 assert_eq!(check!(rw.write(write2.as_bytes())), write2.len());
2333 assert_eq!(check!(rw.seek(SeekFrom::Current(0))), 5);
2334 assert_eq!(check!(rw.read(&mut buf)), write1.len());
2335 assert_eq!(str::from_utf8(&buf[..write1.len()]), Ok(write1));
2336 assert_eq!(check!(rw.seek(SeekFrom::Current(0))), 9);
2337 assert_eq!(check!(rw.read_at(&mut buf[..write2.len()], 0)), write2.len());
2338 assert_eq!(str::from_utf8(&buf[..write2.len()]), Ok(write2));
2339 assert_eq!(check!(rw.seek(SeekFrom::Current(0))), 9);
2340 assert_eq!(check!(rw.write_at(write3.as_bytes(), 9)), write3.len());
2341 assert_eq!(check!(rw.seek(SeekFrom::Current(0))), 9);
2344 let mut read = check!(File::open(&filename));
2345 assert_eq!(check!(read.read_at(&mut buf, 0)), content.len());
2346 assert_eq!(str::from_utf8(&buf[..content.len()]), Ok(content));
2347 assert_eq!(check!(read.seek(SeekFrom::Current(0))), 0);
2348 assert_eq!(check!(read.seek(SeekFrom::End(-5))), 9);
2349 assert_eq!(check!(read.read_at(&mut buf, 0)), content.len());
2350 assert_eq!(str::from_utf8(&buf[..content.len()]), Ok(content));
2351 assert_eq!(check!(read.seek(SeekFrom::Current(0))), 9);
2352 assert_eq!(check!(read.read(&mut buf)), write3.len());
2353 assert_eq!(str::from_utf8(&buf[..write3.len()]), Ok(write3));
2354 assert_eq!(check!(read.seek(SeekFrom::Current(0))), 14);
2355 assert_eq!(check!(read.read_at(&mut buf, 0)), content.len());
2356 assert_eq!(str::from_utf8(&buf[..content.len()]), Ok(content));
2357 assert_eq!(check!(read.seek(SeekFrom::Current(0))), 14);
2358 assert_eq!(check!(read.read_at(&mut buf, 14)), 0);
2359 assert_eq!(check!(read.read_at(&mut buf, 15)), 0);
2360 assert_eq!(check!(read.seek(SeekFrom::Current(0))), 14);
2362 check!(fs::remove_file(&filename));
2367 fn set_get_unix_permissions() {
2368 use os::unix::fs::PermissionsExt;
2370 let tmpdir = tmpdir();
2371 let filename = &tmpdir.join("set_get_unix_permissions");
2372 check!(fs::create_dir(filename));
2375 check!(fs::set_permissions(filename,
2376 fs::Permissions::from_mode(0)));
2377 let metadata0 = check!(fs::metadata(filename));
2378 assert_eq!(mask & metadata0.permissions().mode(), 0);
2380 check!(fs::set_permissions(filename,
2381 fs::Permissions::from_mode(0o1777)));
2382 let metadata1 = check!(fs::metadata(filename));
2383 assert_eq!(mask & metadata1.permissions().mode(), 0o1777);
2388 fn file_test_io_seek_read_write() {
2389 use os::windows::fs::FileExt;
2391 let tmpdir = tmpdir();
2392 let filename = tmpdir.join("file_rt_io_file_test_seek_read_write.txt");
2393 let mut buf = [0; 256];
2394 let write1 = "asdf";
2395 let write2 = "qwer-";
2396 let write3 = "-zxcv";
2397 let content = "qwer-asdf-zxcv";
2399 let oo = OpenOptions::new().create_new(true).write(true).read(true).clone();
2400 let mut rw = check!(oo.open(&filename));
2401 assert_eq!(check!(rw.seek_write(write1.as_bytes(), 5)), write1.len());
2402 assert_eq!(check!(rw.seek(SeekFrom::Current(0))), 9);
2403 assert_eq!(check!(rw.seek_read(&mut buf, 5)), write1.len());
2404 assert_eq!(str::from_utf8(&buf[..write1.len()]), Ok(write1));
2405 assert_eq!(check!(rw.seek(SeekFrom::Current(0))), 9);
2406 assert_eq!(check!(rw.seek(SeekFrom::Start(0))), 0);
2407 assert_eq!(check!(rw.write(write2.as_bytes())), write2.len());
2408 assert_eq!(check!(rw.seek(SeekFrom::Current(0))), 5);
2409 assert_eq!(check!(rw.read(&mut buf)), write1.len());
2410 assert_eq!(str::from_utf8(&buf[..write1.len()]), Ok(write1));
2411 assert_eq!(check!(rw.seek(SeekFrom::Current(0))), 9);
2412 assert_eq!(check!(rw.seek_read(&mut buf[..write2.len()], 0)), write2.len());
2413 assert_eq!(str::from_utf8(&buf[..write2.len()]), Ok(write2));
2414 assert_eq!(check!(rw.seek(SeekFrom::Current(0))), 5);
2415 assert_eq!(check!(rw.seek_write(write3.as_bytes(), 9)), write3.len());
2416 assert_eq!(check!(rw.seek(SeekFrom::Current(0))), 14);
2419 let mut read = check!(File::open(&filename));
2420 assert_eq!(check!(read.seek_read(&mut buf, 0)), content.len());
2421 assert_eq!(str::from_utf8(&buf[..content.len()]), Ok(content));
2422 assert_eq!(check!(read.seek(SeekFrom::Current(0))), 14);
2423 assert_eq!(check!(read.seek(SeekFrom::End(-5))), 9);
2424 assert_eq!(check!(read.seek_read(&mut buf, 0)), content.len());
2425 assert_eq!(str::from_utf8(&buf[..content.len()]), Ok(content));
2426 assert_eq!(check!(read.seek(SeekFrom::Current(0))), 14);
2427 assert_eq!(check!(read.seek(SeekFrom::End(-5))), 9);
2428 assert_eq!(check!(read.read(&mut buf)), write3.len());
2429 assert_eq!(str::from_utf8(&buf[..write3.len()]), Ok(write3));
2430 assert_eq!(check!(read.seek(SeekFrom::Current(0))), 14);
2431 assert_eq!(check!(read.seek_read(&mut buf, 0)), content.len());
2432 assert_eq!(str::from_utf8(&buf[..content.len()]), Ok(content));
2433 assert_eq!(check!(read.seek(SeekFrom::Current(0))), 14);
2434 assert_eq!(check!(read.seek_read(&mut buf, 14)), 0);
2435 assert_eq!(check!(read.seek_read(&mut buf, 15)), 0);
2437 check!(fs::remove_file(&filename));
2441 fn file_test_stat_is_correct_on_is_file() {
2442 let tmpdir = tmpdir();
2443 let filename = &tmpdir.join("file_stat_correct_on_is_file.txt");
2445 let mut opts = OpenOptions::new();
2446 let mut fs = check!(opts.read(true).write(true)
2447 .create(true).open(filename));
2449 fs.write(msg.as_bytes()).unwrap();
2451 let fstat_res = check!(fs.metadata());
2452 assert!(fstat_res.is_file());
2454 let stat_res_fn = check!(fs::metadata(filename));
2455 assert!(stat_res_fn.is_file());
2456 let stat_res_meth = check!(filename.metadata());
2457 assert!(stat_res_meth.is_file());
2458 check!(fs::remove_file(filename));
2462 fn file_test_stat_is_correct_on_is_dir() {
2463 let tmpdir = tmpdir();
2464 let filename = &tmpdir.join("file_stat_correct_on_is_dir");
2465 check!(fs::create_dir(filename));
2466 let stat_res_fn = check!(fs::metadata(filename));
2467 assert!(stat_res_fn.is_dir());
2468 let stat_res_meth = check!(filename.metadata());
2469 assert!(stat_res_meth.is_dir());
2470 check!(fs::remove_dir(filename));
2474 fn file_test_fileinfo_false_when_checking_is_file_on_a_directory() {
2475 let tmpdir = tmpdir();
2476 let dir = &tmpdir.join("fileinfo_false_on_dir");
2477 check!(fs::create_dir(dir));
2478 assert!(!dir.is_file());
2479 check!(fs::remove_dir(dir));
2483 fn file_test_fileinfo_check_exists_before_and_after_file_creation() {
2484 let tmpdir = tmpdir();
2485 let file = &tmpdir.join("fileinfo_check_exists_b_and_a.txt");
2486 check!(check!(File::create(file)).write(b"foo"));
2487 assert!(file.exists());
2488 check!(fs::remove_file(file));
2489 assert!(!file.exists());
2493 fn file_test_directoryinfo_check_exists_before_and_after_mkdir() {
2494 let tmpdir = tmpdir();
2495 let dir = &tmpdir.join("before_and_after_dir");
2496 assert!(!dir.exists());
2497 check!(fs::create_dir(dir));
2498 assert!(dir.exists());
2499 assert!(dir.is_dir());
2500 check!(fs::remove_dir(dir));
2501 assert!(!dir.exists());
2505 fn file_test_directoryinfo_readdir() {
2506 let tmpdir = tmpdir();
2507 let dir = &tmpdir.join("di_readdir");
2508 check!(fs::create_dir(dir));
2511 let f = dir.join(&format!("{}.txt", n));
2512 let mut w = check!(File::create(&f));
2513 let msg_str = format!("{}{}", prefix, n.to_string());
2514 let msg = msg_str.as_bytes();
2515 check!(w.write(msg));
2517 let files = check!(fs::read_dir(dir));
2518 let mut mem = [0; 4];
2520 let f = f.unwrap().path();
2522 let n = f.file_stem().unwrap();
2523 check!(check!(File::open(&f)).read(&mut mem));
2524 let read_str = str::from_utf8(&mem).unwrap();
2525 let expected = format!("{}{}", prefix, n.to_str().unwrap());
2526 assert_eq!(expected, read_str);
2528 check!(fs::remove_file(&f));
2530 check!(fs::remove_dir(dir));
2534 fn file_create_new_already_exists_error() {
2535 let tmpdir = tmpdir();
2536 let file = &tmpdir.join("file_create_new_error_exists");
2537 check!(fs::File::create(file));
2538 let e = fs::OpenOptions::new().write(true).create_new(true).open(file).unwrap_err();
2539 assert_eq!(e.kind(), ErrorKind::AlreadyExists);
2543 fn mkdir_path_already_exists_error() {
2544 let tmpdir = tmpdir();
2545 let dir = &tmpdir.join("mkdir_error_twice");
2546 check!(fs::create_dir(dir));
2547 let e = fs::create_dir(dir).unwrap_err();
2548 assert_eq!(e.kind(), ErrorKind::AlreadyExists);
2552 fn recursive_mkdir() {
2553 let tmpdir = tmpdir();
2554 let dir = tmpdir.join("d1/d2");
2555 check!(fs::create_dir_all(&dir));
2556 assert!(dir.is_dir())
2560 fn recursive_mkdir_failure() {
2561 let tmpdir = tmpdir();
2562 let dir = tmpdir.join("d1");
2563 let file = dir.join("f1");
2565 check!(fs::create_dir_all(&dir));
2566 check!(File::create(&file));
2568 let result = fs::create_dir_all(&file);
2570 assert!(result.is_err());
2574 fn concurrent_recursive_mkdir() {
2577 let mut dir = dir.join("a");
2579 dir = dir.join("a");
2581 let mut join = vec!();
2583 let dir = dir.clone();
2584 join.push(thread::spawn(move || {
2585 check!(fs::create_dir_all(&dir));
2589 // No `Display` on result of `join()`
2590 join.drain(..).map(|join| join.join().unwrap()).count();
2595 fn recursive_mkdir_slash() {
2596 check!(fs::create_dir_all(Path::new("/")));
2600 fn recursive_mkdir_dot() {
2601 check!(fs::create_dir_all(Path::new(".")));
2605 fn recursive_mkdir_empty() {
2606 check!(fs::create_dir_all(Path::new("")));
2610 fn recursive_rmdir() {
2611 let tmpdir = tmpdir();
2612 let d1 = tmpdir.join("d1");
2613 let dt = d1.join("t");
2614 let dtt = dt.join("t");
2615 let d2 = tmpdir.join("d2");
2616 let canary = d2.join("do_not_delete");
2617 check!(fs::create_dir_all(&dtt));
2618 check!(fs::create_dir_all(&d2));
2619 check!(check!(File::create(&canary)).write(b"foo"));
2620 check!(symlink_junction(&d2, &dt.join("d2")));
2621 let _ = symlink_file(&canary, &d1.join("canary"));
2622 check!(fs::remove_dir_all(&d1));
2624 assert!(!d1.is_dir());
2625 assert!(canary.exists());
2629 fn recursive_rmdir_of_symlink() {
2630 // test we do not recursively delete a symlink but only dirs.
2631 let tmpdir = tmpdir();
2632 let link = tmpdir.join("d1");
2633 let dir = tmpdir.join("d2");
2634 let canary = dir.join("do_not_delete");
2635 check!(fs::create_dir_all(&dir));
2636 check!(check!(File::create(&canary)).write(b"foo"));
2637 check!(symlink_junction(&dir, &link));
2638 check!(fs::remove_dir_all(&link));
2640 assert!(!link.is_dir());
2641 assert!(canary.exists());
2645 // only Windows makes a distinction between file and directory symlinks.
2647 fn recursive_rmdir_of_file_symlink() {
2648 let tmpdir = tmpdir();
2649 if !got_symlink_permission(&tmpdir) { return };
2651 let f1 = tmpdir.join("f1");
2652 let f2 = tmpdir.join("f2");
2653 check!(check!(File::create(&f1)).write(b"foo"));
2654 check!(symlink_file(&f1, &f2));
2655 match fs::remove_dir_all(&f2) {
2656 Ok(..) => panic!("wanted a failure"),
2662 fn unicode_path_is_dir() {
2663 assert!(Path::new(".").is_dir());
2664 assert!(!Path::new("test/stdtest/fs.rs").is_dir());
2666 let tmpdir = tmpdir();
2668 let mut dirpath = tmpdir.path().to_path_buf();
2669 dirpath.push("test-가一ー你好");
2670 check!(fs::create_dir(&dirpath));
2671 assert!(dirpath.is_dir());
2673 let mut filepath = dirpath;
2674 filepath.push("unicode-file-\u{ac00}\u{4e00}\u{30fc}\u{4f60}\u{597d}.rs");
2675 check!(File::create(&filepath)); // ignore return; touch only
2676 assert!(!filepath.is_dir());
2677 assert!(filepath.exists());
2681 fn unicode_path_exists() {
2682 assert!(Path::new(".").exists());
2683 assert!(!Path::new("test/nonexistent-bogus-path").exists());
2685 let tmpdir = tmpdir();
2686 let unicode = tmpdir.path();
2687 let unicode = unicode.join("test-각丁ー再见");
2688 check!(fs::create_dir(&unicode));
2689 assert!(unicode.exists());
2690 assert!(!Path::new("test/unicode-bogus-path-각丁ー再见").exists());
2694 fn copy_file_does_not_exist() {
2695 let from = Path::new("test/nonexistent-bogus-path");
2696 let to = Path::new("test/other-bogus-path");
2698 match fs::copy(&from, &to) {
2701 assert!(!from.exists());
2702 assert!(!to.exists());
2708 fn copy_src_does_not_exist() {
2709 let tmpdir = tmpdir();
2710 let from = Path::new("test/nonexistent-bogus-path");
2711 let to = tmpdir.join("out.txt");
2712 check!(check!(File::create(&to)).write(b"hello"));
2713 assert!(fs::copy(&from, &to).is_err());
2714 assert!(!from.exists());
2715 let mut v = Vec::new();
2716 check!(check!(File::open(&to)).read_to_end(&mut v));
2717 assert_eq!(v, b"hello");
2722 let tmpdir = tmpdir();
2723 let input = tmpdir.join("in.txt");
2724 let out = tmpdir.join("out.txt");
2726 check!(check!(File::create(&input)).write(b"hello"));
2727 check!(fs::copy(&input, &out));
2728 let mut v = Vec::new();
2729 check!(check!(File::open(&out)).read_to_end(&mut v));
2730 assert_eq!(v, b"hello");
2732 assert_eq!(check!(input.metadata()).permissions(),
2733 check!(out.metadata()).permissions());
2737 fn copy_file_dst_dir() {
2738 let tmpdir = tmpdir();
2739 let out = tmpdir.join("out");
2741 check!(File::create(&out));
2742 match fs::copy(&*out, tmpdir.path()) {
2743 Ok(..) => panic!(), Err(..) => {}
2748 fn copy_file_dst_exists() {
2749 let tmpdir = tmpdir();
2750 let input = tmpdir.join("in");
2751 let output = tmpdir.join("out");
2753 check!(check!(File::create(&input)).write("foo".as_bytes()));
2754 check!(check!(File::create(&output)).write("bar".as_bytes()));
2755 check!(fs::copy(&input, &output));
2757 let mut v = Vec::new();
2758 check!(check!(File::open(&output)).read_to_end(&mut v));
2759 assert_eq!(v, b"foo".to_vec());
2763 fn copy_file_src_dir() {
2764 let tmpdir = tmpdir();
2765 let out = tmpdir.join("out");
2767 match fs::copy(tmpdir.path(), &out) {
2768 Ok(..) => panic!(), Err(..) => {}
2770 assert!(!out.exists());
2774 fn copy_file_preserves_perm_bits() {
2775 let tmpdir = tmpdir();
2776 let input = tmpdir.join("in.txt");
2777 let out = tmpdir.join("out.txt");
2779 let attr = check!(check!(File::create(&input)).metadata());
2780 let mut p = attr.permissions();
2781 p.set_readonly(true);
2782 check!(fs::set_permissions(&input, p));
2783 check!(fs::copy(&input, &out));
2784 assert!(check!(out.metadata()).permissions().readonly());
2785 check!(fs::set_permissions(&input, attr.permissions()));
2786 check!(fs::set_permissions(&out, attr.permissions()));
2791 fn copy_file_preserves_streams() {
2793 check!(check!(File::create(tmp.join("in.txt:bunny"))).write("carrot".as_bytes()));
2794 assert_eq!(check!(fs::copy(tmp.join("in.txt"), tmp.join("out.txt"))), 0);
2795 assert_eq!(check!(tmp.join("out.txt").metadata()).len(), 0);
2796 let mut v = Vec::new();
2797 check!(check!(File::open(tmp.join("out.txt:bunny"))).read_to_end(&mut v));
2798 assert_eq!(v, b"carrot".to_vec());
2802 fn copy_file_returns_metadata_len() {
2804 let in_path = tmp.join("in.txt");
2805 let out_path = tmp.join("out.txt");
2806 check!(check!(File::create(&in_path)).write(b"lettuce"));
2808 check!(check!(File::create(tmp.join("in.txt:bunny"))).write(b"carrot"));
2809 let copied_len = check!(fs::copy(&in_path, &out_path));
2810 assert_eq!(check!(out_path.metadata()).len(), copied_len);
2814 fn symlinks_work() {
2815 let tmpdir = tmpdir();
2816 if !got_symlink_permission(&tmpdir) { return };
2818 let input = tmpdir.join("in.txt");
2819 let out = tmpdir.join("out.txt");
2821 check!(check!(File::create(&input)).write("foobar".as_bytes()));
2822 check!(symlink_file(&input, &out));
2823 assert!(check!(out.symlink_metadata()).file_type().is_symlink());
2824 assert_eq!(check!(fs::metadata(&out)).len(),
2825 check!(fs::metadata(&input)).len());
2826 let mut v = Vec::new();
2827 check!(check!(File::open(&out)).read_to_end(&mut v));
2828 assert_eq!(v, b"foobar".to_vec());
2832 fn symlink_noexist() {
2833 // Symlinks can point to things that don't exist
2834 let tmpdir = tmpdir();
2835 if !got_symlink_permission(&tmpdir) { return };
2837 // Use a relative path for testing. Symlinks get normalized by Windows,
2838 // so we may not get the same path back for absolute paths
2839 check!(symlink_file(&"foo", &tmpdir.join("bar")));
2840 assert_eq!(check!(fs::read_link(&tmpdir.join("bar"))).to_str().unwrap(),
2847 // directory symlink
2848 assert_eq!(check!(fs::read_link(r"C:\Users\All Users")).to_str().unwrap(),
2851 assert_eq!(check!(fs::read_link(r"C:\Users\Default User")).to_str().unwrap(),
2852 r"C:\Users\Default");
2853 // junction with special permissions
2854 assert_eq!(check!(fs::read_link(r"C:\Documents and Settings\")).to_str().unwrap(),
2857 let tmpdir = tmpdir();
2858 let link = tmpdir.join("link");
2859 if !got_symlink_permission(&tmpdir) { return };
2860 check!(symlink_file(&"foo", &link));
2861 assert_eq!(check!(fs::read_link(&link)).to_str().unwrap(), "foo");
2865 fn readlink_not_symlink() {
2866 let tmpdir = tmpdir();
2867 match fs::read_link(tmpdir.path()) {
2868 Ok(..) => panic!("wanted a failure"),
2875 let tmpdir = tmpdir();
2876 let input = tmpdir.join("in.txt");
2877 let out = tmpdir.join("out.txt");
2879 check!(check!(File::create(&input)).write("foobar".as_bytes()));
2880 check!(fs::hard_link(&input, &out));
2881 assert_eq!(check!(fs::metadata(&out)).len(),
2882 check!(fs::metadata(&input)).len());
2883 assert_eq!(check!(fs::metadata(&out)).len(),
2884 check!(input.metadata()).len());
2885 let mut v = Vec::new();
2886 check!(check!(File::open(&out)).read_to_end(&mut v));
2887 assert_eq!(v, b"foobar".to_vec());
2889 // can't link to yourself
2890 match fs::hard_link(&input, &input) {
2891 Ok(..) => panic!("wanted a failure"),
2894 // can't link to something that doesn't exist
2895 match fs::hard_link(&tmpdir.join("foo"), &tmpdir.join("bar")) {
2896 Ok(..) => panic!("wanted a failure"),
2903 let tmpdir = tmpdir();
2904 let file = tmpdir.join("in.txt");
2906 check!(File::create(&file));
2907 let attr = check!(fs::metadata(&file));
2908 assert!(!attr.permissions().readonly());
2909 let mut p = attr.permissions();
2910 p.set_readonly(true);
2911 check!(fs::set_permissions(&file, p.clone()));
2912 let attr = check!(fs::metadata(&file));
2913 assert!(attr.permissions().readonly());
2915 match fs::set_permissions(&tmpdir.join("foo"), p.clone()) {
2916 Ok(..) => panic!("wanted an error"),
2920 p.set_readonly(false);
2921 check!(fs::set_permissions(&file, p));
2926 let tmpdir = tmpdir();
2927 let path = tmpdir.join("in.txt");
2929 let file = check!(File::create(&path));
2930 let attr = check!(fs::metadata(&path));
2931 assert!(!attr.permissions().readonly());
2932 let mut p = attr.permissions();
2933 p.set_readonly(true);
2934 check!(file.set_permissions(p.clone()));
2935 let attr = check!(fs::metadata(&path));
2936 assert!(attr.permissions().readonly());
2938 p.set_readonly(false);
2939 check!(file.set_permissions(p));
2943 fn sync_doesnt_kill_anything() {
2944 let tmpdir = tmpdir();
2945 let path = tmpdir.join("in.txt");
2947 let mut file = check!(File::create(&path));
2948 check!(file.sync_all());
2949 check!(file.sync_data());
2950 check!(file.write(b"foo"));
2951 check!(file.sync_all());
2952 check!(file.sync_data());
2956 fn truncate_works() {
2957 let tmpdir = tmpdir();
2958 let path = tmpdir.join("in.txt");
2960 let mut file = check!(File::create(&path));
2961 check!(file.write(b"foo"));
2962 check!(file.sync_all());
2964 // Do some simple things with truncation
2965 assert_eq!(check!(file.metadata()).len(), 3);
2966 check!(file.set_len(10));
2967 assert_eq!(check!(file.metadata()).len(), 10);
2968 check!(file.write(b"bar"));
2969 check!(file.sync_all());
2970 assert_eq!(check!(file.metadata()).len(), 10);
2972 let mut v = Vec::new();
2973 check!(check!(File::open(&path)).read_to_end(&mut v));
2974 assert_eq!(v, b"foobar\0\0\0\0".to_vec());
2976 // Truncate to a smaller length, don't seek, and then write something.
2977 // Ensure that the intermediate zeroes are all filled in (we have `seek`ed
2978 // past the end of the file).
2979 check!(file.set_len(2));
2980 assert_eq!(check!(file.metadata()).len(), 2);
2981 check!(file.write(b"wut"));
2982 check!(file.sync_all());
2983 assert_eq!(check!(file.metadata()).len(), 9);
2984 let mut v = Vec::new();
2985 check!(check!(File::open(&path)).read_to_end(&mut v));
2986 assert_eq!(v, b"fo\0\0\0\0wut".to_vec());
2991 use fs::OpenOptions as OO;
2992 fn c<T: Clone>(t: &T) -> T { t.clone() }
2994 let tmpdir = tmpdir();
2996 let mut r = OO::new(); r.read(true);
2997 let mut w = OO::new(); w.write(true);
2998 let mut rw = OO::new(); rw.read(true).write(true);
2999 let mut a = OO::new(); a.append(true);
3000 let mut ra = OO::new(); ra.read(true).append(true);
3003 let invalid_options = 87; // ERROR_INVALID_PARAMETER
3005 let invalid_options = "Invalid argument";
3007 // Test various combinations of creation modes and access modes.
3010 // creation mode | read | write | read-write | append | read-append |
3011 // :-----------------------|:-----:|:-----:|:----------:|:------:|:-----------:|
3012 // not set (open existing) | X | X | X | X | X |
3013 // create | | X | X | X | X |
3014 // truncate | | X | X | | |
3015 // create and truncate | | X | X | | |
3016 // create_new | | X | X | X | X |
3018 // tested in reverse order, so 'create_new' creates the file, and 'open existing' opens it.
3021 check!(c(&w).create_new(true).open(&tmpdir.join("a")));
3022 check!(c(&w).create(true).truncate(true).open(&tmpdir.join("a")));
3023 check!(c(&w).truncate(true).open(&tmpdir.join("a")));
3024 check!(c(&w).create(true).open(&tmpdir.join("a")));
3025 check!(c(&w).open(&tmpdir.join("a")));
3028 error!(c(&r).create_new(true).open(&tmpdir.join("b")), invalid_options);
3029 error!(c(&r).create(true).truncate(true).open(&tmpdir.join("b")), invalid_options);
3030 error!(c(&r).truncate(true).open(&tmpdir.join("b")), invalid_options);
3031 error!(c(&r).create(true).open(&tmpdir.join("b")), invalid_options);
3032 check!(c(&r).open(&tmpdir.join("a"))); // try opening the file created with write_only
3035 check!(c(&rw).create_new(true).open(&tmpdir.join("c")));
3036 check!(c(&rw).create(true).truncate(true).open(&tmpdir.join("c")));
3037 check!(c(&rw).truncate(true).open(&tmpdir.join("c")));
3038 check!(c(&rw).create(true).open(&tmpdir.join("c")));
3039 check!(c(&rw).open(&tmpdir.join("c")));
3042 check!(c(&a).create_new(true).open(&tmpdir.join("d")));
3043 error!(c(&a).create(true).truncate(true).open(&tmpdir.join("d")), invalid_options);
3044 error!(c(&a).truncate(true).open(&tmpdir.join("d")), invalid_options);
3045 check!(c(&a).create(true).open(&tmpdir.join("d")));
3046 check!(c(&a).open(&tmpdir.join("d")));
3049 check!(c(&ra).create_new(true).open(&tmpdir.join("e")));
3050 error!(c(&ra).create(true).truncate(true).open(&tmpdir.join("e")), invalid_options);
3051 error!(c(&ra).truncate(true).open(&tmpdir.join("e")), invalid_options);
3052 check!(c(&ra).create(true).open(&tmpdir.join("e")));
3053 check!(c(&ra).open(&tmpdir.join("e")));
3055 // Test opening a file without setting an access mode
3056 let mut blank = OO::new();
3057 error!(blank.create(true).open(&tmpdir.join("f")), invalid_options);
3060 check!(check!(File::create(&tmpdir.join("h"))).write("foobar".as_bytes()));
3062 // Test write fails for read-only
3063 check!(r.open(&tmpdir.join("h")));
3065 let mut f = check!(r.open(&tmpdir.join("h")));
3066 assert!(f.write("wut".as_bytes()).is_err());
3069 // Test write overwrites
3071 let mut f = check!(c(&w).open(&tmpdir.join("h")));
3072 check!(f.write("baz".as_bytes()));
3075 let mut f = check!(c(&r).open(&tmpdir.join("h")));
3076 let mut b = vec![0; 6];
3077 check!(f.read(&mut b));
3078 assert_eq!(b, "bazbar".as_bytes());
3081 // Test truncate works
3083 let mut f = check!(c(&w).truncate(true).open(&tmpdir.join("h")));
3084 check!(f.write("foo".as_bytes()));
3086 assert_eq!(check!(fs::metadata(&tmpdir.join("h"))).len(), 3);
3088 // Test append works
3089 assert_eq!(check!(fs::metadata(&tmpdir.join("h"))).len(), 3);
3091 let mut f = check!(c(&a).open(&tmpdir.join("h")));
3092 check!(f.write("bar".as_bytes()));
3094 assert_eq!(check!(fs::metadata(&tmpdir.join("h"))).len(), 6);
3096 // Test .append(true) equals .write(true).append(true)
3098 let mut f = check!(c(&w).append(true).open(&tmpdir.join("h")));
3099 check!(f.write("baz".as_bytes()));
3101 assert_eq!(check!(fs::metadata(&tmpdir.join("h"))).len(), 9);
3105 fn _assert_send_sync() {
3106 fn _assert_send_sync<T: Send + Sync>() {}
3107 _assert_send_sync::<OpenOptions>();
3112 let mut bytes = [0; 1024];
3113 StdRng::new().unwrap().fill_bytes(&mut bytes);
3115 let tmpdir = tmpdir();
3117 check!(check!(File::create(&tmpdir.join("test"))).write(&bytes));
3118 let mut v = Vec::new();
3119 check!(check!(File::open(&tmpdir.join("test"))).read_to_end(&mut v));
3120 assert!(v == &bytes[..]);
3124 fn write_then_read() {
3125 let mut bytes = [0; 1024];
3126 StdRng::new().unwrap().fill_bytes(&mut bytes);
3128 let tmpdir = tmpdir();
3130 check!(fs::write(&tmpdir.join("test"), &bytes[..]));
3131 let v = check!(fs::read(&tmpdir.join("test")));
3132 assert!(v == &bytes[..]);
3134 check!(fs::write(&tmpdir.join("not-utf8"), &[0xFF]));
3135 error_contains!(fs::read_to_string(&tmpdir.join("not-utf8")),
3136 "stream did not contain valid UTF-8");
3139 check!(fs::write(&tmpdir.join("utf8"), s.as_bytes()));
3140 let string = check!(fs::read_to_string(&tmpdir.join("utf8")));
3141 assert_eq!(string, s);
3145 fn file_try_clone() {
3146 let tmpdir = tmpdir();
3148 let mut f1 = check!(OpenOptions::new()
3152 .open(&tmpdir.join("test")));
3153 let mut f2 = check!(f1.try_clone());
3155 check!(f1.write_all(b"hello world"));
3156 check!(f1.seek(SeekFrom::Start(2)));
3158 let mut buf = vec![];
3159 check!(f2.read_to_end(&mut buf));
3160 assert_eq!(buf, b"llo world");
3163 check!(f1.write_all(b"!"));
3167 #[cfg(not(windows))]
3168 fn unlink_readonly() {
3169 let tmpdir = tmpdir();
3170 let path = tmpdir.join("file");
3171 check!(File::create(&path));
3172 let mut perm = check!(fs::metadata(&path)).permissions();
3173 perm.set_readonly(true);
3174 check!(fs::set_permissions(&path, perm));
3175 check!(fs::remove_file(&path));
3179 fn mkdir_trailing_slash() {
3180 let tmpdir = tmpdir();
3181 let path = tmpdir.join("file");
3182 check!(fs::create_dir_all(&path.join("a/")));
3186 fn canonicalize_works_simple() {
3187 let tmpdir = tmpdir();
3188 let tmpdir = fs::canonicalize(tmpdir.path()).unwrap();
3189 let file = tmpdir.join("test");
3190 File::create(&file).unwrap();
3191 assert_eq!(fs::canonicalize(&file).unwrap(), file);
3195 fn realpath_works() {
3196 let tmpdir = tmpdir();
3197 if !got_symlink_permission(&tmpdir) { return };
3199 let tmpdir = fs::canonicalize(tmpdir.path()).unwrap();
3200 let file = tmpdir.join("test");
3201 let dir = tmpdir.join("test2");
3202 let link = dir.join("link");
3203 let linkdir = tmpdir.join("test3");
3205 File::create(&file).unwrap();
3206 fs::create_dir(&dir).unwrap();
3207 symlink_file(&file, &link).unwrap();
3208 symlink_dir(&dir, &linkdir).unwrap();
3210 assert!(link.symlink_metadata().unwrap().file_type().is_symlink());
3212 assert_eq!(fs::canonicalize(&tmpdir).unwrap(), tmpdir);
3213 assert_eq!(fs::canonicalize(&file).unwrap(), file);
3214 assert_eq!(fs::canonicalize(&link).unwrap(), file);
3215 assert_eq!(fs::canonicalize(&linkdir).unwrap(), dir);
3216 assert_eq!(fs::canonicalize(&linkdir.join("link")).unwrap(), file);
3220 fn realpath_works_tricky() {
3221 let tmpdir = tmpdir();
3222 if !got_symlink_permission(&tmpdir) { return };
3224 let tmpdir = fs::canonicalize(tmpdir.path()).unwrap();
3225 let a = tmpdir.join("a");
3226 let b = a.join("b");
3227 let c = b.join("c");
3228 let d = a.join("d");
3229 let e = d.join("e");
3230 let f = a.join("f");
3232 fs::create_dir_all(&b).unwrap();
3233 fs::create_dir_all(&d).unwrap();
3234 File::create(&f).unwrap();
3235 if cfg!(not(windows)) {
3236 symlink_dir("../d/e", &c).unwrap();
3237 symlink_file("../f", &e).unwrap();
3240 symlink_dir(r"..\d\e", &c).unwrap();
3241 symlink_file(r"..\f", &e).unwrap();
3244 assert_eq!(fs::canonicalize(&c).unwrap(), f);
3245 assert_eq!(fs::canonicalize(&e).unwrap(), f);
3249 fn dir_entry_methods() {
3250 let tmpdir = tmpdir();
3252 fs::create_dir_all(&tmpdir.join("a")).unwrap();
3253 File::create(&tmpdir.join("b")).unwrap();
3255 for file in tmpdir.path().read_dir().unwrap().map(|f| f.unwrap()) {
3256 let fname = file.file_name();
3257 match fname.to_str() {
3259 assert!(file.file_type().unwrap().is_dir());
3260 assert!(file.metadata().unwrap().is_dir());
3263 assert!(file.file_type().unwrap().is_file());
3264 assert!(file.metadata().unwrap().is_file());
3266 f => panic!("unknown file name: {:?}", f),
3272 fn dir_entry_debug() {
3273 let tmpdir = tmpdir();
3274 File::create(&tmpdir.join("b")).unwrap();
3275 let mut read_dir = tmpdir.path().read_dir().unwrap();
3276 let dir_entry = read_dir.next().unwrap().unwrap();
3277 let actual = format!("{:?}", dir_entry);
3278 let expected = format!("DirEntry({:?})", dir_entry.0.path());
3279 assert_eq!(actual, expected);
3283 fn read_dir_not_found() {
3284 let res = fs::read_dir("/path/that/does/not/exist");
3285 assert_eq!(res.err().unwrap().kind(), ErrorKind::NotFound);
3289 fn create_dir_all_with_junctions() {
3290 let tmpdir = tmpdir();
3291 let target = tmpdir.join("target");
3293 let junction = tmpdir.join("junction");
3294 let b = junction.join("a/b");
3296 let link = tmpdir.join("link");
3297 let d = link.join("c/d");
3299 fs::create_dir(&target).unwrap();
3301 check!(symlink_junction(&target, &junction));
3302 check!(fs::create_dir_all(&b));
3303 // the junction itself is not a directory, but `is_dir()` on a Path
3305 assert!(junction.is_dir());
3306 assert!(b.exists());
3308 if !got_symlink_permission(&tmpdir) { return };
3309 check!(symlink_dir(&target, &link));
3310 check!(fs::create_dir_all(&d));
3311 assert!(link.is_dir());
3312 assert!(d.exists());
3316 fn metadata_access_times() {
3317 let tmpdir = tmpdir();
3319 let b = tmpdir.join("b");
3320 File::create(&b).unwrap();
3322 let a = check!(fs::metadata(&tmpdir.path()));
3323 let b = check!(fs::metadata(&b));
3325 assert_eq!(check!(a.accessed()), check!(a.accessed()));
3326 assert_eq!(check!(a.modified()), check!(a.modified()));
3327 assert_eq!(check!(b.accessed()), check!(b.modified()));
3329 if cfg!(target_os = "macos") || cfg!(target_os = "windows") {
3330 check!(a.created());
3331 check!(b.created());