1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
use crate::fs::open_options::OpenOptions; use std::os::windows::fs::OpenOptionsExt as _; /// Unix-specific extensions to [`fs::OpenOptions`]. /// /// This mirrors the definition of [`std::os::windows::fs::OpenOptionsExt`]. /// /// [`fs::OpenOptions`]: crate::fs::OpenOptions /// [`std::os::windows::fs::OpenOptionsExt`]: std::os::windows::fs::OpenOptionsExt pub trait OpenOptionsExt: sealed::Sealed { /// Overrides the `dwDesiredAccess` argument to the call to [`CreateFile`] /// 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. /// /// # Examples /// /// ```no_run /// use tokio::fs::OpenOptions; /// use tokio::fs::os::windows::OpenOptionsExt; /// /// # #[tokio::main] /// # async fn main() -> std::io::Result<()> { /// // 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").await?; /// # Ok(()) /// # } /// ``` /// /// [`CreateFile`]: https://docs.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-createfilea fn access_mode(&mut self, access: u32) -> &mut Self; /// 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`. This allows /// other processes to read, write, and delete/rename the same file /// while it is open. Removing any of the flags will prevent other /// processes from performing the corresponding operation until the file /// handle is closed. /// /// # Examples /// /// ```no_run /// use tokio::fs::OpenOptions; /// use tokio::fs::os::windows::OpenOptionsExt; /// /// # #[tokio::main] /// # async fn main() -> std::io::Result<()> { /// // 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) /// .open("foo.txt").await?; /// # Ok(()) /// # } /// ``` /// /// [`CreateFile`]: https://docs.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-createfilea fn share_mode(&mut self, val: u32) -> &mut Self; /// Sets extra flags for the `dwFileFlags` argument to the call to /// [`CreateFile2`] to the specified value (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 Rust's options. /// This option overwrites any previously set custom flags. /// /// # Examples /// /// ```no_run /// use winapi::um::winbase::FILE_FLAG_DELETE_ON_CLOSE; /// use tokio::fs::OpenOptions; /// use tokio::fs::os::windows::OpenOptionsExt; /// /// # #[tokio::main] /// # async fn main() -> std::io::Result<()> { /// let file = OpenOptions::new() /// .create(true) /// .write(true) /// .custom_flags(FILE_FLAG_DELETE_ON_CLOSE) /// .open("foo.txt").await?; /// # Ok(()) /// # } /// ``` /// /// [`CreateFile`]: https://docs.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-createfilea /// [`CreateFile2`]: https://docs.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-createfile2 fn custom_flags(&mut self, flags: u32) -> &mut Self; /// 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`]). /// /// 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()`. /// /// In all other cases the attributes get ignored. /// /// # Examples /// /// ```no_run /// use winapi::um::winnt::FILE_ATTRIBUTE_HIDDEN; /// use tokio::fs::OpenOptions; /// use tokio::fs::os::windows::OpenOptionsExt; /// /// # #[tokio::main] /// # async fn main() -> std::io::Result<()> { /// let file = OpenOptions::new() /// .write(true) /// .create(true) /// .attributes(FILE_ATTRIBUTE_HIDDEN) /// .open("foo.txt").await?; /// # Ok(()) /// # } /// ``` /// /// [`CreateFile`]: https://docs.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-createfilea /// [`CreateFile2`]: https://docs.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-createfile2 fn attributes(&mut self, val: u32) -> &mut Self; /// Sets the `dwSecurityQosFlags` argument to the call to [`CreateFile2`] to /// the specified value (or combines it with `custom_flags` and `attributes` /// to set the `dwFlagsAndAttributes` for [`CreateFile`]). /// /// By default `security_qos_flags` is not set. It should be specified when /// opening a named pipe, to control to which degree a server process can /// act on behalf of a client process (security impersonation level). /// /// When `security_qos_flags` is not set, a malicious program can gain the /// elevated privileges of a privileged Rust process when it allows opening /// user-specified paths, by tricking it into opening a named pipe. So /// arguably `security_qos_flags` should also be set when opening arbitrary /// paths. However the bits can then conflict with other flags, specifically /// `FILE_FLAG_OPEN_NO_RECALL`. /// /// For information about possible values, see [Impersonation Levels] on the /// Windows Dev Center site. The `SECURITY_SQOS_PRESENT` flag is set /// automatically when using this method. /// /// # Examples /// /// ```no_run /// use winapi::um::winbase::SECURITY_IDENTIFICATION; /// use tokio::fs::OpenOptions; /// use tokio::fs::os::windows::OpenOptionsExt; /// /// # #[tokio::main] /// # async fn main() -> std::io::Result<()> { /// let file = OpenOptions::new() /// .write(true) /// .create(true) /// /// // Sets the flag value to `SecurityIdentification`. /// .security_qos_flags(SECURITY_IDENTIFICATION) /// /// .open(r"\\.\pipe\MyPipe").await?; /// # Ok(()) /// # } /// ``` /// /// [`CreateFile`]: https://docs.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-createfilea /// [`CreateFile2`]: https://docs.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-createfile2 /// [Impersonation Levels]: /// https://docs.microsoft.com/en-us/windows/win32/api/winnt/ne-winnt-security_impersonation_level fn security_qos_flags(&mut self, flags: u32) -> &mut Self; } impl OpenOptionsExt for OpenOptions { fn access_mode(&mut self, access: u32) -> &mut OpenOptions { self.as_inner_mut().access_mode(access); self } fn share_mode(&mut self, share: u32) -> &mut OpenOptions { self.as_inner_mut().share_mode(share); self } fn custom_flags(&mut self, flags: u32) -> &mut OpenOptions { self.as_inner_mut().custom_flags(flags); self } fn attributes(&mut self, attributes: u32) -> &mut OpenOptions { self.as_inner_mut().attributes(attributes); self } fn security_qos_flags(&mut self, flags: u32) -> &mut OpenOptions { self.as_inner_mut().security_qos_flags(flags); self } } impl sealed::Sealed for OpenOptions {} pub(crate) mod sealed { #[doc(hidden)] pub trait Sealed {} }