Struct OpenOptions

pub struct OpenOptions(/* private fields */);

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

This builder, created from GenFSs new_openopts, exposes the ability to configure how a File is opened and what operations are permitted on the open file. GenFSs open_file and create_file methods are aliases for commonly used options with this builder.

This builder is a single element tuple containing a std::fs::OpenOptions that implements rsfs::OpenOptions and supports unix extensions.

Examples

Opening a file to read:

let f = fs.new_openopts()
          .read(true)
          .open("f")?;

Opening a file for both reading and writing, as well as creating it if it doesn’t exist:

let mut f = fs.new_openopts()
              .read(true)
              .write(true)
              .create(true)
              .open("f")?;

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 OpenOptions for OpenOptions

type File = File

The File type in the module implementing this trait.

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

Sets the option for read access.

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

Sets the option for write access.

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

Sets the option for append mode.

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

Sets the option for truncating an existing file.

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

Sets the option to create the file if it does not exist.

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

Sets the option to always create a new file.

fn open<P: AsRef<Path>>(&self, path: P) -> Result<Self::File>

Opens a file at path with options specified by self.

impl OpenOptionsExt for OpenOptions

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

Sets the mode bits that a new file will be opened with.

fn custom_flags(&mut self, flags: i32) -> &mut Self

Pass custom flags to the flags argument of open.