Struct cap_primitives::fs::OpenOptions

pub struct OpenOptions { /* fields omitted */ }

Options and flags which can be used to configure how a file is opened.

This corresponds to std::fs::OpenOptions.

Note that this OpenOptions has no open method. To open a file with an OptionOptions, you must first obtain a Dir containing the path, and then call Dir::open_with.

We need to define our own version because the libstd `OpenOptions` doesn't have public accessors that we can use.

Implementations

impl OpenOptions

pub const fn new() -> Self

Creates a blank new set of options ready for configuration.

This corresponds to std::fs::OpenOptions::new.

pub fn read(&mut self, read: bool) -> &mut Self

Sets the option for read access.

This corresponds to std::fs::OpenOptions::read.

pub fn write(&mut self, write: bool) -> &mut Self

Sets the option for write access.

This corresponds to std::fs::OpenOptions::write.

pub fn append(&mut self, append: bool) -> &mut Self

Sets the option for the append mode.

This corresponds to std::fs::OpenOptions::append.

pub fn truncate(&mut self, truncate: bool) -> &mut Self

Sets the option for truncating a previous file.

This corresponds to std::fs::OpenOptions::truncate.

pub fn create(&mut self, create: bool) -> &mut Self

Sets the option to create a new file.

This corresponds to std::fs::OpenOptions::create.

pub fn create_new(&mut self, create_new: bool) -> &mut Self

Sets the option to always create a new file.

This corresponds to std::fs::OpenOptions::create_new.

Trait Implementations

impl Clone for OpenOptions

fn clone(&self) -> OpenOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OpenOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl OpenOptionsExt for OpenOptions

fn share_mode(&mut self, val: u32) -> &mut Self

To prevent race conditions on Windows, handles for directories must be opened without FILE_SHARE_DELETE.

fn access_mode(&mut self, access: u32) -> &mut Self

Overrides the dwDesiredAccess argument to the call to CreateFile with the specified value.

fn custom_flags(&mut self, flags: 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).

fn attributes(&mut self, val: 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).

fn security_qos_flags(&mut self, flags: 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).