src/libstd/sys/unix/ext/fs.rs

   1 // Copyright 2015 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! Unix-specific extensions to primitives in the `std::fs` module.
  12
  13 #![stable(feature = "rust1", since = "1.0.0")]
  14
  15 use fs::{self, Permissions, OpenOptions};
  16 use io;
  17 use libc;
  18 use os::raw::c_long;
  19 use os::unix::raw;
  20 use path::Path;
  21 use sys::fs::MetadataExt as UnixMetadataExt;
  22 use sys;
  23 use sys_common::{FromInner, AsInner, AsInnerMut};
  24
  25 #[unstable(feature = "fs_mode", reason = "recently added API", issue = "27712")]
  26 pub const USER_READ: raw::mode_t = 0o400;
  27 #[unstable(feature = "fs_mode", reason = "recently added API", issue = "27712")]
  28 pub const USER_WRITE: raw::mode_t = 0o200;
  29 #[unstable(feature = "fs_mode", reason = "recently added API", issue = "27712")]
  30 pub const USER_EXECUTE: raw::mode_t = 0o100;
  31 #[unstable(feature = "fs_mode", reason = "recently added API", issue = "27712")]
  32 pub const USER_RWX: raw::mode_t = 0o700;
  33 #[unstable(feature = "fs_mode", reason = "recently added API", issue = "27712")]
  34 pub const GROUP_READ: raw::mode_t = 0o040;
  35 #[unstable(feature = "fs_mode", reason = "recently added API", issue = "27712")]
  36 pub const GROUP_WRITE: raw::mode_t = 0o020;
  37 #[unstable(feature = "fs_mode", reason = "recently added API", issue = "27712")]
  38 pub const GROUP_EXECUTE: raw::mode_t = 0o010;
  39 #[unstable(feature = "fs_mode", reason = "recently added API", issue = "27712")]
  40 pub const GROUP_RWX: raw::mode_t = 0o070;
  41 #[unstable(feature = "fs_mode", reason = "recently added API", issue = "27712")]
  42 pub const OTHER_READ: raw::mode_t = 0o004;
  43 #[unstable(feature = "fs_mode", reason = "recently added API", issue = "27712")]
  44 pub const OTHER_WRITE: raw::mode_t = 0o002;
  45 #[unstable(feature = "fs_mode", reason = "recently added API", issue = "27712")]
  46 pub const OTHER_EXECUTE: raw::mode_t = 0o001;
  47 #[unstable(feature = "fs_mode", reason = "recently added API", issue = "27712")]
  48 pub const OTHER_RWX: raw::mode_t = 0o007;
  49 #[unstable(feature = "fs_mode", reason = "recently added API", issue = "27712")]
  50 pub const ALL_READ: raw::mode_t = 0o444;
  51 #[unstable(feature = "fs_mode", reason = "recently added API", issue = "27712")]
  52 pub const ALL_WRITE: raw::mode_t = 0o222;
  53 #[unstable(feature = "fs_mode", reason = "recently added API", issue = "27712")]
  54 pub const ALL_EXECUTE: raw::mode_t = 0o111;
  55 #[unstable(feature = "fs_mode", reason = "recently added API", issue = "27712")]
  56 pub const ALL_RWX: raw::mode_t = 0o777;
  57 #[unstable(feature = "fs_mode", reason = "recently added API", issue = "27712")]
  58 pub const SETUID: raw::mode_t = 0o4000;
  59 #[unstable(feature = "fs_mode", reason = "recently added API", issue = "27712")]
  60 pub const SETGID: raw::mode_t = 0o2000;
  61 #[unstable(feature = "fs_mode", reason = "recently added API", issue = "27712")]
  62 pub const STICKY_BIT: raw::mode_t = 0o1000;
  63
  64 /// Unix-specific extensions to `Permissions`
  65 #[stable(feature = "fs_ext", since = "1.1.0")]
  66 pub trait PermissionsExt {
  67     /// Returns the underlying raw `mode_t` bits that are the standard Unix
  68     /// permissions for this file.
  69     #[stable(feature = "fs_ext", since = "1.1.0")]
  70     fn mode(&self) -> raw::mode_t;
  71
  72     /// Sets the underlying raw `mode_t` bits for this set of permissions.
  73     #[stable(feature = "fs_ext", since = "1.1.0")]
  74     fn set_mode(&mut self, mode: raw::mode_t);
  75
  76     /// Creates a new instance of `Permissions` from the given set of Unix
  77     /// permission bits.
  78     #[stable(feature = "fs_ext", since = "1.1.0")]
  79     fn from_mode(mode: raw::mode_t) -> Self;
  80 }
  81
  82 #[stable(feature = "fs_ext", since = "1.1.0")]
  83 impl PermissionsExt for Permissions {
  84     fn mode(&self) -> raw::mode_t { self.as_inner().mode() }
  85
  86     fn set_mode(&mut self, mode: raw::mode_t) {
  87         *self = FromInner::from_inner(FromInner::from_inner(mode));
  88     }
  89
  90     fn from_mode(mode: raw::mode_t) -> Permissions {
  91         FromInner::from_inner(FromInner::from_inner(mode))
  92     }
  93 }
  94
  95 /// Unix-specific extensions to `OpenOptions`
  96 #[stable(feature = "fs_ext", since = "1.1.0")]
  97 pub trait OpenOptionsExt {
  98     /// Sets the mode bits that a new file will be created with.
  99     ///
 100     /// If a new file is created as part of a `File::open_opts` call then this
 101     /// specified `mode` will be used as the permission bits for the new file.
 102     /// If no `mode` is set, the default of `0o666` will be used.
 103     /// The operating system masks out bits with the systems `umask`, to produce
 104     /// the final permissions.
 105     #[stable(feature = "fs_ext", since = "1.1.0")]
 106     fn mode(&mut self, mode: raw::mode_t) -> &mut Self;
 107
 108     /// Pass custom flags to the `flags` agument of `open`.
 109     ///
 110     /// The bits that define the access mode are masked out with `O_ACCMODE`, to
 111     /// ensure they do not interfere with the access mode set by Rusts options.
 112     ///
 113     /// Custom flags can only set flags, not remove flags set by Rusts options.
 114     /// This options overwrites any previously set custom flags.
 115     ///
 116     /// # Examples
 117     ///
 118     /// ```rust,ignore
 119     /// extern crate libc;
 120     /// use std::fs::OpenOptions;
 121     /// use std::os::unix::fs::OpenOptionsExt;
 122     ///
 123     /// let mut options = OpenOptions::new();
 124     /// options.write(true);
 125     /// if cfg!(unix) {
 126     ///     options.custom_flags(libc::O_NOFOLLOW);
 127     /// }
 128     /// let file = options.open("foo.txt");
 129     /// ```
 130     #[unstable(feature = "expand_open_options",
 131                reason = "recently added",
 132                issue = "30014")]
 133     fn custom_flags(&mut self, flags: i32) -> &mut Self;
 134 }
 135
 136 #[stable(feature = "fs_ext", since = "1.1.0")]
 137 impl OpenOptionsExt for OpenOptions {
 138     fn mode(&mut self, mode: raw::mode_t) -> &mut OpenOptions {
 139         self.as_inner_mut().mode(mode); self
 140     }
 141
 142     fn custom_flags(&mut self, flags: i32) -> &mut OpenOptions {
 143         self.as_inner_mut().custom_flags(flags); self
 144     }
 145 }
 146
 147 // Hm, why are there casts here to the returned type, shouldn't the types always
 148 // be the same? Right you are! Turns out, however, on android at least the types
 149 // in the raw `stat` structure are not the same as the types being returned. Who
 150 // knew!
 151 //
 152 // As a result to make sure this compiles for all platforms we do the manual
 153 // casts and rely on manual lowering to `stat` if the raw type is desired.
 154 #[stable(feature = "metadata_ext", since = "1.1.0")]
 155 pub trait MetadataExt {
 156     #[stable(feature = "metadata_ext", since = "1.1.0")]
 157     fn dev(&self) -> raw::dev_t;
 158     #[stable(feature = "metadata_ext", since = "1.1.0")]
 159     fn ino(&self) -> raw::ino_t;
 160     #[stable(feature = "metadata_ext", since = "1.1.0")]
 161     fn mode(&self) -> raw::mode_t;
 162     #[stable(feature = "metadata_ext", since = "1.1.0")]
 163     fn nlink(&self) -> raw::nlink_t;
 164     #[stable(feature = "metadata_ext", since = "1.1.0")]
 165     fn uid(&self) -> raw::uid_t;
 166     #[stable(feature = "metadata_ext", since = "1.1.0")]
 167     fn gid(&self) -> raw::gid_t;
 168     #[stable(feature = "metadata_ext", since = "1.1.0")]
 169     fn rdev(&self) -> raw::dev_t;
 170     #[stable(feature = "metadata_ext", since = "1.1.0")]
 171     fn size(&self) -> raw::off_t;
 172     #[stable(feature = "metadata_ext", since = "1.1.0")]
 173     fn atime(&self) -> raw::time_t;
 174     #[stable(feature = "metadata_ext", since = "1.1.0")]
 175     fn atime_nsec(&self) -> c_long;
 176     #[stable(feature = "metadata_ext", since = "1.1.0")]
 177     fn mtime(&self) -> raw::time_t;
 178     #[stable(feature = "metadata_ext", since = "1.1.0")]
 179     fn mtime_nsec(&self) -> c_long;
 180     #[stable(feature = "metadata_ext", since = "1.1.0")]
 181     fn ctime(&self) -> raw::time_t;
 182     #[stable(feature = "metadata_ext", since = "1.1.0")]
 183     fn ctime_nsec(&self) -> c_long;
 184     #[stable(feature = "metadata_ext", since = "1.1.0")]
 185     fn blksize(&self) -> raw::blksize_t;
 186     #[stable(feature = "metadata_ext", since = "1.1.0")]
 187     fn blocks(&self) -> raw::blkcnt_t;
 188 }
 189
 190 #[stable(feature = "metadata_ext", since = "1.1.0")]
 191 impl MetadataExt for fs::Metadata {
 192     fn dev(&self) -> raw::dev_t { self.as_raw_stat().st_dev as raw::dev_t }
 193     fn ino(&self) -> raw::ino_t { self.as_raw_stat().st_ino as raw::ino_t }
 194     fn mode(&self) -> raw::mode_t { self.as_raw_stat().st_mode as raw::mode_t }
 195     fn nlink(&self) -> raw::nlink_t { self.as_raw_stat().st_nlink as raw::nlink_t }
 196     fn uid(&self) -> raw::uid_t { self.as_raw_stat().st_uid as raw::uid_t }
 197     fn gid(&self) -> raw::gid_t { self.as_raw_stat().st_gid as raw::gid_t }
 198     fn rdev(&self) -> raw::dev_t { self.as_raw_stat().st_rdev as raw::dev_t }
 199     fn size(&self) -> raw::off_t { self.as_raw_stat().st_size as raw::off_t }
 200     fn atime(&self) -> raw::time_t { self.as_raw_stat().st_atime }
 201     fn atime_nsec(&self) -> c_long { self.as_raw_stat().st_atime_nsec as c_long }
 202     fn mtime(&self) -> raw::time_t { self.as_raw_stat().st_mtime }
 203     fn mtime_nsec(&self) -> c_long { self.as_raw_stat().st_mtime_nsec as c_long }
 204     fn ctime(&self) -> raw::time_t { self.as_raw_stat().st_ctime }
 205     fn ctime_nsec(&self) -> c_long { self.as_raw_stat().st_ctime_nsec as c_long }
 206
 207     fn blksize(&self) -> raw::blksize_t {
 208         self.as_raw_stat().st_blksize as raw::blksize_t
 209     }
 210     fn blocks(&self) -> raw::blkcnt_t {
 211         self.as_raw_stat().st_blocks as raw::blkcnt_t
 212     }
 213 }
 214
 215 /// Add special unix types (block/char device, fifo and socket)
 216 #[stable(feature = "file_type_ext", since = "1.5.0")]
 217 pub trait FileTypeExt {
 218     /// Returns whether this file type is a block device.
 219     #[stable(feature = "file_type_ext", since = "1.5.0")]
 220     fn is_block_device(&self) -> bool;
 221     /// Returns whether this file type is a char device.
 222     #[stable(feature = "file_type_ext", since = "1.5.0")]
 223     fn is_char_device(&self) -> bool;
 224     /// Returns whether this file type is a fifo.
 225     #[stable(feature = "file_type_ext", since = "1.5.0")]
 226     fn is_fifo(&self) -> bool;
 227     /// Returns whether this file type is a socket.
 228     #[stable(feature = "file_type_ext", since = "1.5.0")]
 229     fn is_socket(&self) -> bool;
 230 }
 231
 232 #[stable(feature = "file_type_ext", since = "1.5.0")]
 233 impl FileTypeExt for fs::FileType {
 234     fn is_block_device(&self) -> bool { self.as_inner().is(libc::S_IFBLK) }
 235     fn is_char_device(&self) -> bool { self.as_inner().is(libc::S_IFCHR) }
 236     fn is_fifo(&self) -> bool { self.as_inner().is(libc::S_IFIFO) }
 237     fn is_socket(&self) -> bool { self.as_inner().is(libc::S_IFSOCK) }
 238 }
 239
 240 /// Unix-specific extension methods for `fs::DirEntry`
 241 #[stable(feature = "dir_entry_ext", since = "1.1.0")]
 242 pub trait DirEntryExt {
 243     /// Returns the underlying `d_ino` field in the contained `dirent`
 244     /// structure.
 245     #[stable(feature = "dir_entry_ext", since = "1.1.0")]
 246     fn ino(&self) -> raw::ino_t;
 247 }
 248
 249 #[stable(feature = "dir_entry_ext", since = "1.1.0")]
 250 impl DirEntryExt for fs::DirEntry {
 251     fn ino(&self) -> raw::ino_t { self.as_inner().ino() }
 252 }
 253
 254 /// Creates a new symbolic link on the filesystem.
 255 ///
 256 /// The `dst` path will be a symbolic link pointing to the `src` path.
 257 ///
 258 /// # Note
 259 ///
 260 /// On Windows, you must specify whether a symbolic link points to a file
 261 /// or directory.  Use `os::windows::fs::symlink_file` to create a
 262 /// symbolic link to a file, or `os::windows::fs::symlink_dir` to create a
 263 /// symbolic link to a directory.  Additionally, the process must have
 264 /// `SeCreateSymbolicLinkPrivilege` in order to be able to create a
 265 /// symbolic link.
 266 ///
 267 /// # Examples
 268 ///
 269 /// ```
 270 /// use std::os::unix::fs;
 271 ///
 272 /// # fn foo() -> std::io::Result<()> {
 273 /// try!(fs::symlink("a.txt", "b.txt"));
 274 /// # Ok(())
 275 /// # }
 276 /// ```
 277 #[stable(feature = "symlink", since = "1.1.0")]
 278 pub fn symlink<P: AsRef<Path>, Q: AsRef<Path>>(src: P, dst: Q) -> io::Result<()>
 279 {
 280     sys::fs::symlink(src.as_ref(), dst.as_ref())
 281 }
 282
 283 #[stable(feature = "dir_builder", since = "1.6.0")]
 284 /// An extension trait for `fs::DirBuilder` for unix-specific options.
 285 pub trait DirBuilderExt {
 286     /// Sets the mode to create new directories with. This option defaults to
 287     /// 0o777.
 288     #[stable(feature = "dir_builder", since = "1.6.0")]
 289     fn mode(&mut self, mode: raw::mode_t) -> &mut Self;
 290 }
 291
 292 #[stable(feature = "dir_builder", since = "1.6.0")]
 293 impl DirBuilderExt for fs::DirBuilder {
 294     fn mode(&mut self, mode: raw::mode_t) -> &mut fs::DirBuilder {
 295         self.as_inner_mut().set_mode(mode);
 296         self
 297     }
 298 }