about summary refs log tree commit diff
path: root/src/libstd/sys/windows/ext
diff options
context:
space:
mode:
authorPaul Dicker <pitdicker@gmail.com>2016-01-15 19:04:53 +0100
committerPaul Dicker <pitdicker@gmail.com>2016-01-15 19:04:53 +0100
commit9c569189c8b8b5d635b6704c489a8410c81570a0 (patch)
tree0865c64a5a53d5001b4080e2d7fd162b6ba701d7 /src/libstd/sys/windows/ext
parent1230a08679e70b8d9a9ce653f8663ff27832db54 (diff)
downloadrust-9c569189c8b8b5d635b6704c489a8410c81570a0.tar.gz
rust-9c569189c8b8b5d635b6704c489a8410c81570a0.zip
Addressed comments
Diffstat (limited to 'src/libstd/sys/windows/ext')
-rw-r--r--src/libstd/sys/windows/ext/fs.rs53
1 files changed, 26 insertions, 27 deletions
diff --git a/src/libstd/sys/windows/ext/fs.rs b/src/libstd/sys/windows/ext/fs.rs
index 4bb67b0fad9..d060c902fba 100644
--- a/src/libstd/sys/windows/ext/fs.rs
+++ b/src/libstd/sys/windows/ext/fs.rs
@@ -27,9 +27,9 @@ pub trait OpenOptionsExt {
     /// with the specified value.
     ///
     /// This will override the `read`, `write`, and `append` flags on the
-    /// `OpenOptions` structure. This method provides fine-grained control
-    /// over the permissions to read, write and append data, attributes
-    /// (like hidden and system) and extended attributes.
+    /// `OpenOptions` structure. This method provides fine-grained control over
+    /// the permissions to read, write and append data, attributes (like hidden
+    /// and system) and extended attributes.
     ///
     /// # Examples
     ///
@@ -38,8 +38,8 @@ pub trait OpenOptionsExt {
     /// use std::fs::OpenOptions;
     /// use std::os::windows::fs::OpenOptionsExt;
     ///
-    /// // Open without read and write permission, for example if you only need to call `stat()`
-    /// // on the file
+    /// // Open without read and write permission, for example if you only need
+    /// // to call `stat()` on the file
     /// let file = OpenOptions::new().access_mode(0).open("foo.txt");
     /// ```
     fn access_mode(&mut self, access: u32) -> &mut Self;
@@ -47,9 +47,10 @@ pub trait OpenOptionsExt {
     /// Overrides the `dwShareMode` argument to the call to `CreateFile` with
     /// the specified value.
     ///
-    /// By default `share_mode` is set to `FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE`.
-    /// Specifying less permissions denies others to read from, write to and/or
-    /// delete the file while it is open.
+    /// By default `share_mode` is set to
+    /// `FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE`. Specifying
+    /// less permissions denies others to read from, write to and/or delete the
+    /// file while it is open.
     ///
     /// # Examples
     ///
@@ -58,17 +59,20 @@ pub trait OpenOptionsExt {
     /// use std::fs::OpenOptions;
     /// use std::os::windows::fs::OpenOptionsExt;
     ///
+    /// // Do not allow others to read or modify this file while we have it open
+    /// // for writing
     /// let file = OpenOptions::new().write(true)
-    ///                              .share_mode(0) // Do not allow others to read or modify
+    ///                              .share_mode(0)
     ///                              .open("foo.txt");
     /// ```
     fn share_mode(&mut self, val: u32) -> &mut Self;
 
-    /// Sets extra flags for the `dwFileFlags` argument to the call to `CreateFile2`
-    /// (or combines it with `attributes` and `security_qos_flags` to set the
-    /// `dwFlagsAndAttributes` for `CreateFile`).
+    /// Sets extra flags for the `dwFileFlags` argument to the call to
+    /// `CreateFile2` (or combines it with `attributes` and `security_qos_flags`
+    /// to set the `dwFlagsAndAttributes` for `CreateFile`).
     ///
     /// Custom flags can only set flags, not remove flags set by Rusts options.
+    /// This options overwrites any previously set custom flags.
     ///
     /// # Examples
     ///
@@ -79,7 +83,9 @@ pub trait OpenOptionsExt {
     ///
     /// let mut options = OpenOptions::new();
     /// options.create(true).write(true);
-    /// if cfg!(windows) { options.custom_flags(winapi::FILE_FLAG_DELETE_ON_CLOSE); }
+    /// if cfg!(windows) {
+    ///     options.custom_flags(winapi::FILE_FLAG_DELETE_ON_CLOSE);
+    /// }
     /// let file = options.open("foo.txt");
     /// ```
     #[unstable(feature = "expand_open_options",
@@ -89,15 +95,16 @@ pub trait OpenOptionsExt {
 
     /// Sets the `dwFileAttributes` argument to the call to `CreateFile2` to
     /// the specified value (or combines it with `custom_flags` and
-    /// `security_qos_flags` to set the `dwFlagsAndAttributes` for `CreateFile`).
+    /// `security_qos_flags` to set the `dwFlagsAndAttributes` for
+    /// `CreateFile`).
     ///
-    /// If a _new_ file is created because it does not yet exist and `.create(true)` or
-    /// `.create_new(true)` are specified, the new file is given the attributes declared
-    /// with `.attributes()`.
+    /// If a _new_ file is created because it does not yet exist and
+    ///`.create(true)` or `.create_new(true)` are specified, the new file is
+    /// given the attributes declared with `.attributes()`.
     ///
     /// If an _existing_ file is opened with `.create(true).truncate(true)`, its
-    /// existing attributes are preserved and combined with the ones declared with
-    /// `.attributes()`.
+    /// existing attributes are preserved and combined with the ones declared
+    /// with `.attributes()`.
     ///
     /// In all other cases the attributes get ignored.
     ///
@@ -119,10 +126,6 @@ pub trait OpenOptionsExt {
     /// the specified value (or combines it with `custom_flags` and `attributes`
     /// to set the `dwFlagsAndAttributes` for `CreateFile`).
     fn security_qos_flags(&mut self, flags: u32) -> &mut OpenOptions;
-
-    /// Sets the `lpSecurityAttributes` argument to the call to `CreateFile` to
-    /// the specified value.
-    fn security_attributes(&mut self, attrs: sys::c::LPSECURITY_ATTRIBUTES) -> &mut OpenOptions;
 }
 
 #[unstable(feature = "open_options_ext",
@@ -148,10 +151,6 @@ impl OpenOptionsExt for OpenOptions {
     fn security_qos_flags(&mut self, flags: u32) -> &mut OpenOptions {
         self.as_inner_mut().security_qos_flags(flags); self
     }
-
-    fn security_attributes(&mut self, attrs: sys::c::LPSECURITY_ATTRIBUTES) -> &mut OpenOptions {
-        self.as_inner_mut().security_attributes(attrs); self
-    }
 }
 
 /// Extension methods for `fs::Metadata` to access the raw fields contained