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     #[stable(feature = "fs_ext", since = "1.1.0")]
 103     fn mode(&mut self, mode: raw::mode_t) -> &mut Self;
 104 }
 105
 106 #[stable(feature = "fs_ext", since = "1.1.0")]
 107 impl OpenOptionsExt for OpenOptions {
 108     fn mode(&mut self, mode: raw::mode_t) -> &mut OpenOptions {
 109         self.as_inner_mut().mode(mode); self
 110     }
 111 }
 112
 113 // Hm, why are there casts here to the returned type, shouldn't the types always
 114 // be the same? Right you are! Turns out, however, on android at least the types
 115 // in the raw `stat` structure are not the same as the types being returned. Who
 116 // knew!
 117 //
 118 // As a result to make sure this compiles for all platforms we do the manual
 119 // casts and rely on manual lowering to `stat` if the raw type is desired.
 120 #[stable(feature = "metadata_ext", since = "1.1.0")]
 121 pub trait MetadataExt {
 122     #[stable(feature = "metadata_ext", since = "1.1.0")]
 123     fn dev(&self) -> raw::dev_t;
 124     #[stable(feature = "metadata_ext", since = "1.1.0")]
 125     fn ino(&self) -> raw::ino_t;
 126     #[stable(feature = "metadata_ext", since = "1.1.0")]
 127     fn mode(&self) -> raw::mode_t;
 128     #[stable(feature = "metadata_ext", since = "1.1.0")]
 129     fn nlink(&self) -> raw::nlink_t;
 130     #[stable(feature = "metadata_ext", since = "1.1.0")]
 131     fn uid(&self) -> raw::uid_t;
 132     #[stable(feature = "metadata_ext", since = "1.1.0")]
 133     fn gid(&self) -> raw::gid_t;
 134     #[stable(feature = "metadata_ext", since = "1.1.0")]
 135     fn rdev(&self) -> raw::dev_t;
 136     #[stable(feature = "metadata_ext", since = "1.1.0")]
 137     fn size(&self) -> raw::off_t;
 138     #[stable(feature = "metadata_ext", since = "1.1.0")]
 139     fn atime(&self) -> raw::time_t;
 140     #[stable(feature = "metadata_ext", since = "1.1.0")]
 141     fn atime_nsec(&self) -> c_long;
 142     #[stable(feature = "metadata_ext", since = "1.1.0")]
 143     fn mtime(&self) -> raw::time_t;
 144     #[stable(feature = "metadata_ext", since = "1.1.0")]
 145     fn mtime_nsec(&self) -> c_long;
 146     #[stable(feature = "metadata_ext", since = "1.1.0")]
 147     fn ctime(&self) -> raw::time_t;
 148     #[stable(feature = "metadata_ext", since = "1.1.0")]
 149     fn ctime_nsec(&self) -> c_long;
 150     #[stable(feature = "metadata_ext", since = "1.1.0")]
 151     fn blksize(&self) -> raw::blksize_t;
 152     #[stable(feature = "metadata_ext", since = "1.1.0")]
 153     fn blocks(&self) -> raw::blkcnt_t;
 154 }
 155
 156 #[stable(feature = "metadata_ext", since = "1.1.0")]
 157 impl MetadataExt for fs::Metadata {
 158     fn dev(&self) -> raw::dev_t { self.as_raw_stat().st_dev as raw::dev_t }
 159     fn ino(&self) -> raw::ino_t { self.as_raw_stat().st_ino as raw::ino_t }
 160     fn mode(&self) -> raw::mode_t { self.as_raw_stat().st_mode as raw::mode_t }
 161     fn nlink(&self) -> raw::nlink_t { self.as_raw_stat().st_nlink as raw::nlink_t }
 162     fn uid(&self) -> raw::uid_t { self.as_raw_stat().st_uid as raw::uid_t }
 163     fn gid(&self) -> raw::gid_t { self.as_raw_stat().st_gid as raw::gid_t }
 164     fn rdev(&self) -> raw::dev_t { self.as_raw_stat().st_rdev as raw::dev_t }
 165     fn size(&self) -> raw::off_t { self.as_raw_stat().st_size as raw::off_t }
 166     fn atime(&self) -> raw::time_t { self.as_raw_stat().st_atime }
 167     fn atime_nsec(&self) -> c_long { self.as_raw_stat().st_atime_nsec as c_long }
 168     fn mtime(&self) -> raw::time_t { self.as_raw_stat().st_mtime }
 169     fn mtime_nsec(&self) -> c_long { self.as_raw_stat().st_mtime_nsec as c_long }
 170     fn ctime(&self) -> raw::time_t { self.as_raw_stat().st_ctime }
 171     fn ctime_nsec(&self) -> c_long { self.as_raw_stat().st_ctime_nsec as c_long }
 172
 173     fn blksize(&self) -> raw::blksize_t {
 174         self.as_raw_stat().st_blksize as raw::blksize_t
 175     }
 176     fn blocks(&self) -> raw::blkcnt_t {
 177         self.as_raw_stat().st_blocks as raw::blkcnt_t
 178     }
 179 }
 180
 181 /// Add special unix types (block/char device, fifo and socket)
 182 #[stable(feature = "file_type_ext", since = "1.5.0")]
 183 pub trait FileTypeExt {
 184     /// Returns whether this file type is a block device.
 185     #[stable(feature = "file_type_ext", since = "1.5.0")]
 186     fn is_block_device(&self) -> bool;
 187     /// Returns whether this file type is a char device.
 188     #[stable(feature = "file_type_ext", since = "1.5.0")]
 189     fn is_char_device(&self) -> bool;
 190     /// Returns whether this file type is a fifo.
 191     #[stable(feature = "file_type_ext", since = "1.5.0")]
 192     fn is_fifo(&self) -> bool;
 193     /// Returns whether this file type is a socket.
 194     #[stable(feature = "file_type_ext", since = "1.5.0")]
 195     fn is_socket(&self) -> bool;
 196 }
 197
 198 #[stable(feature = "file_type_ext", since = "1.5.0")]
 199 impl FileTypeExt for fs::FileType {
 200     fn is_block_device(&self) -> bool { self.as_inner().is(libc::S_IFBLK) }
 201     fn is_char_device(&self) -> bool { self.as_inner().is(libc::S_IFCHR) }
 202     fn is_fifo(&self) -> bool { self.as_inner().is(libc::S_IFIFO) }
 203     fn is_socket(&self) -> bool { self.as_inner().is(libc::S_IFSOCK) }
 204 }
 205
 206 /// Unix-specific extension methods for `fs::DirEntry`
 207 #[stable(feature = "dir_entry_ext", since = "1.1.0")]
 208 pub trait DirEntryExt {
 209     /// Returns the underlying `d_ino` field in the contained `dirent`
 210     /// structure.
 211     #[stable(feature = "dir_entry_ext", since = "1.1.0")]
 212     fn ino(&self) -> raw::ino_t;
 213 }
 214
 215 #[stable(feature = "dir_entry_ext", since = "1.1.0")]
 216 impl DirEntryExt for fs::DirEntry {
 217     fn ino(&self) -> raw::ino_t { self.as_inner().ino() }
 218 }
 219
 220 /// Creates a new symbolic link on the filesystem.
 221 ///
 222 /// The `dst` path will be a symbolic link pointing to the `src` path.
 223 ///
 224 /// # Note
 225 ///
 226 /// On Windows, you must specify whether a symbolic link points to a file
 227 /// or directory.  Use `os::windows::fs::symlink_file` to create a
 228 /// symbolic link to a file, or `os::windows::fs::symlink_dir` to create a
 229 /// symbolic link to a directory.  Additionally, the process must have
 230 /// `SeCreateSymbolicLinkPrivilege` in order to be able to create a
 231 /// symbolic link.
 232 ///
 233 /// # Examples
 234 ///
 235 /// ```
 236 /// use std::os::unix::fs;
 237 ///
 238 /// # fn foo() -> std::io::Result<()> {
 239 /// try!(fs::symlink("a.txt", "b.txt"));
 240 /// # Ok(())
 241 /// # }
 242 /// ```
 243 #[stable(feature = "symlink", since = "1.1.0")]
 244 pub fn symlink<P: AsRef<Path>, Q: AsRef<Path>>(src: P, dst: Q) -> io::Result<()>
 245 {
 246     sys::fs::symlink(src.as_ref(), dst.as_ref())
 247 }
 248
 249 #[stable(feature = "dir_builder", since = "1.6.0")]
 250 /// An extension trait for `fs::DirBuilder` for unix-specific options.
 251 pub trait DirBuilderExt {
 252     /// Sets the mode to create new directories with. This option defaults to
 253     /// 0o777.
 254     #[stable(feature = "dir_builder", since = "1.6.0")]
 255     fn mode(&mut self, mode: raw::mode_t) -> &mut Self;
 256 }
 257
 258 #[stable(feature = "dir_builder", since = "1.6.0")]
 259 impl DirBuilderExt for fs::DirBuilder {
 260     fn mode(&mut self, mode: raw::mode_t) -> &mut fs::DirBuilder {
 261         self.as_inner_mut().set_mode(mode);
 262         self
 263     }
 264 }
 265