Struct obnth::OpenOptions

pub struct OpenOptions<'a> { /* fields omitted */ }

A struct that can be used to open files within a directory.

This is directly analogous to std::fs::OpenOptions, except that it only looks up files within a specific Dir.

An OpenOptions struct can be created with Dir::open_file().

Implementations

impl<'a> OpenOptions<'a>

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

Enable the option for read access.

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

Enable the option for write access.

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

Create the a new file if it does not exist.

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

Create a new file, failing if it already exists.

This is atomic. Enabling it causes .create() and .truncate() to be ignored.

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

Enable append mode.

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

If the file already exists, truncate it while opening.

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

Set the mode with which the file will be opened (e.g 0o777).

The OS will mask out the system umask value.

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

Pass custom flags when opening the file.

Like std::fs::OpenOptions, O_ACCMODE is masked out from the given flags.

pub fn lookup_flags(&mut self, lookup_flags: LookupFlags) -> &mut Self

Set the "lookup flags" used when opening the file.

See LookupFlags for more information. (By default, none of the "lookup flags" are enabled.)

pub fn open<P: AsPath>(&self, path: P) -> Result<File>

Open the file at path with the options specified by path.

Trait Implementations

impl<'a> Clone for OpenOptions<'a>

fn clone(&self) -> OpenOptions<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for OpenOptions<'a>

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

Formats the value using the given formatter.