std::os::windows::fs::OpenOptionsExt - Rust
Description: API documentation for the Rust `OpenOptionsExt` trait in crate `std`.
Keywords: rust, rustlang, rust-lang, OpenOptionsExt

# 1.10.0[−][src]Trait std::os::windows::fs::OpenOptionsExt

    pub trait OpenOptionsExt {
        fn access_mode(&mut self, access: u32) -> &mut Self;
        fn share_mode(&mut self, val: u32) -> &mut Self;
        fn custom_flags(&mut self, flags: u32) -> &mut Self;
        fn attributes(&mut self, val: u32) -> &mut Self;
        fn security_qos_flags(&mut self, flags: u32) -> &mut OpenOptions;
    }

This is supported on Windows only.

Windows-specific extensions to `fs::OpenOptions`.

## Required methods

###
ⓘImportant traits for &'_ mut I

### Important traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<'_, R: Read + ?Sized> Read for &'_ mut Rimpl<'_, W: Write + ?Sized> Write for &'_ mut W`
`fn access_mode(&mut self, access: u32) -> &mut Self`

This is supported on Windows only.

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

    use std::fs::OpenOptions;
    use std::os::windows::prelude::*;

    // 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");Run

###
ⓘImportant traits for &'_ mut I

### Important traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<'_, R: Read + ?Sized> Read for &'_ mut Rimpl<'_, W: Write + ?Sized> Write for &'_ mut W`
`fn share_mode(&mut self, val: u32) -> &mut Self`

This is supported on Windows only.

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

    use std::fs::OpenOptions;
    use std::os::windows::prelude::*;

    // 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");Run

###
ⓘImportant traits for &'_ mut I

### Important traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<'_, R: Read + ?Sized> Read for &'_ mut Rimpl<'_, W: Write + ?Sized> Write for &'_ mut W`
`fn custom_flags(&mut self, flags: u32) -> &mut Self`

This is supported on Windows only.

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

    extern crate winapi;

    use std::fs::OpenOptions;
    use std::os::windows::prelude::*;

    let file = OpenOptions::new()
        .create(true)
        .write(true)
        .custom_flags(winapi::FILE_FLAG_DELETE_ON_CLOSE)
        .open("foo.txt");Run

###
ⓘImportant traits for &'_ mut I

### Important traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<'_, R: Read + ?Sized> Read for &'_ mut Rimpl<'_, W: Write + ?Sized> Write for &'_ mut W`
`fn attributes(&mut self, val: u32) -> &mut Self`

This is supported on Windows only.

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

    extern crate winapi;

    use std::fs::OpenOptions;
    use std::os::windows::prelude::*;

    let file = OpenOptions::new()
        .write(true)
        .create(true)
        .attributes(winapi::FILE_ATTRIBUTE_HIDDEN)
        .open("foo.txt");Run

### `fn security_qos_flags(&mut self, flags: u32) -> &mut OpenOptions`

This is supported on Windows only.

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

    extern crate winapi;
    use std::fs::OpenOptions;
    use std::os::windows::prelude::*;

    let file = OpenOptions::new()
        .write(true)
        .create(true)

        // Sets the flag value to `SecurityIdentification`.
        .security_qos_flags(winapi::SECURITY_IDENTIFICATION)

        .open(r"\\.\pipe\MyPipe");Run

Loading content...

## Implementors

### `impl OpenOptionsExt for OpenOptions`[src]

#### `fn access_mode(&mut self, access: u32) -> &mut OpenOptions`[src]

This is supported on Windows only.

#### `fn share_mode(&mut self, share: u32) -> &mut OpenOptions`[src]

This is supported on Windows only.

#### `fn custom_flags(&mut self, flags: u32) -> &mut OpenOptions`[src]

This is supported on Windows only.

#### `fn attributes(&mut self, attributes: u32) -> &mut OpenOptions`[src]

This is supported on Windows only.

#### `fn security_qos_flags(&mut self, flags: u32) -> &mut OpenOptions`[src]

This is supported on Windows only.
Loading content...